-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
disabled discord rich presence for now, wrote new readme
- Loading branch information
1 parent
2da6b11
commit cacc2a0
Showing
2 changed files
with
81 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,33 @@ | ||
# neoplayer | ||
Terminal/MPV based youtube player | ||
# Neoplayer | ||
|
||
TUI Youtube audio player using MPV on the backend | ||
|
||
## Installation | ||
|
||
You need to have [MPV](https://mpv.io/) and [youtube-dl](https://youtube-dl.org/) installed. | ||
|
||
Then install the libraries with: | ||
```bash | ||
npm install | ||
``` | ||
|
||
## Usage | ||
|
||
Run Neoplayer with: | ||
```bash | ||
node neoplayer.js | ||
``` | ||
|
||
Commands currently available are (press 'h' to type commands): | ||
```javascript | ||
search <query> //searches youtube for the query and returns a list of results with indexes | ||
play <index> //plays the index from the search list or adds it to the currently playing queue | ||
pause //pauses the playback | ||
skip //skips to the next track | ||
q //quits Neoplayer | ||
``` | ||
## Contributing | ||
Feel free to open issues and make pull requests, I'll do my best to work on them. | ||
|
||
## License | ||
[GNU General Public License v2.0](LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters