3 Play videos from YouTube and PeerTube from the
4 command line using your preferred desktop media player.
6 This application is implemented in [Nim language](https://nim-lang.org) using
7 only the standard library.
9 ![nimcoon screenshot with search term 'baby yoda'](screenshot.png)
13 - [x] Search for videos using keywords
14 - [x] Stream videos and music from YouTube
15 - [x] Play direct links from YouTube and PeerTube
16 - [x] Stream video and music from magnet links
19 - [ ] Configuration options
23 Nim Coon depends on the following:
25 - mpv (recommended) or vlc
26 - peerflix (for magnet links)
28 Install VLC or MPV using your distribution's package manager.
32 pip3 install --user youtube-dl
37 npm install --global peerflix
40 ### Installing using Nimble
42 NimCoon can be installed from Nimble repositories:
45 nimble install nimcoon
48 You can also install from source by running the following command:
56 Download the latest build from GitlabCI (amd64 GNU/Linux only).
59 wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
63 Copy the binary to somewhere on your path like /usr/local/bin
70 # If your search query has multiple words, use quotes
73 # Play audio of the first search result
74 nimcoon -m -l "counting stars"
76 # Download audio of the first search result
77 nimcoon -mld "counting stars"
79 # Play direct video link
80 nimcoon https://www.youtube.com/watch?v=QOEMv0S8AcA
82 # Add -d to download or -m to select only audio or both
83 nimcoon -md https://www.youtube.com/watch?v=hT_nvWreIhg
86 After the search results are displayed, you can enter a number to play one
87 result, "all" to play all the results or "q" to quit the program.
89 If a number is entered, after the selected search result is played, the results
90 are redisplayed, so that you can play the other results without having to search
93 ### Command line arguments
95 | **Arguments** | **Explanation** |
96 |-------------------|--------------------------------------------|
97 | -m, --music | Play Music only, no video |
98 | -l, --lucky | Try your luck with the first search result |
99 | -f, --full-screen | Play video in full screen |
100 | -d, --download | Download video or music |
102 Feel free to use these options in any combination. NimCoon will show a helpful
103 error message if you pick incompatible options.
107 One-liner for compiling and running
110 nim c -d:ssl -r src/nimcoon.nim 'nim lang'