Update README before release
[nimcoon.git] / README.md
1 # NimCoon
2
3 Play videos from YouTube and PeerTube from the
4 command line using your preferred desktop media player.
5
6 This application is implemented in [Nim language](https://nim-lang.org) using
7 only the standard library.
8
9 ![nimcoon screenshot with search term 'baby yoda'](screenshot.png)
10
11 ## Features
12
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
17 - [x] Download music
18 - [x] Download video
19 - [ ] Configuration options
20
21 ## Installation
22
23 Nim Coon depends on the following:
24 - youtube-dl
25 - mpv (recommended) or vlc
26 - peerflix (for magnet links)
27
28 Download the latest build from GitlabCI (amd64 GNU/Linux only).
29
30 ```sh
31 wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
32 unzip artifacts.zip
33 ```
34
35
36 For other platforms, you can install from source by running the following command:
37
38 ```sh
39 nimble install
40 ```
41
42 ## Usage
43
44 ```sh
45 nimcoon "emacs"
46
47 # If your search query has multiple words, use quotes
48 nimcoon "nim lang"
49
50 # Play audio of the first search result
51 nimcoon -m -l "counting stars"
52
53 # Download audio of the first search result
54 nimcoon -mld "counting stars"
55
56 # Play direct video link
57 nimcoon https://www.youtube.com/watch?v=QOEMv0S8AcA
58
59 # Add -d to download or -m to select only audio or both
60 nimcoon -md https://www.youtube.com/watch?v=hT_nvWreIhg
61 ```
62
63 After the search results are displayed, you can enter a number to play one
64 result, "all" to play all the results or "q" to quit the program.
65
66 If a number is entered, after the selected search result is played, the results
67 are redisplayed, so that you can play the other results without having to search
68 again.
69
70 ### Command line arguments
71
72 | **Arguments** | **Explanation** |
73 |-------------------|--------------------------------------------|
74 | -m, --music | Play Music only, no video |
75 | -l, --lucky | Try your luck with the first search result |
76 | -f, --full-screen | Play video in full screen |
77 | -d, --download | Download video or music |
78
79 Feel free to use these options in any combination. NimCoon will show a helpful
80 error message if you pick incompatible options.
81
82 ## Development
83
84 One-liner for compiling and running
85
86 ```sh
87 nim c -d:ssl -r src/nimcoon.nim 'nim lang'
88 ```