]>
Commit | Line | Data |
---|---|---|
f7735b43 | 1 | # NimCoon |
726cf1a7 | 2 | |
3e3ba843 | 3 | Play videos from YouTube and PeerTube from the |
44978125 JN |
4 | command line using your preferred desktop media player. |
5 | ||
a6c167a7 JN |
6 | This application is implemented in [Nim language](https://nim-lang.org) using |
7 | only the standard library. | |
8 | ||
3c20e75c | 9 | ![nimcoon screenshot with search term 'baby yoda'](screenshot.png) |
44978125 JN |
10 | |
11 | ## Features | |
12 | ||
13 | - [x] Search for videos using keywords | |
3f6de5cb | 14 | - [x] Stream videos |
4827df7a | 15 | - [x] Stream music |
52ecc638 JN |
16 | - [x] Play direct links from YouTube and PeerTube |
17 | - [x] Stream video from magnet links | |
e9f0c7d0 | 18 | - [x] Download music |
d2ebe4d2 | 19 | - [x] Download video |
44978125 JN |
20 | - [ ] Configuration options |
21 | ||
3f6de5cb | 22 | ## Installation |
44978125 | 23 | |
3c20e75c | 24 | Nim Coon depends on the following: |
7d08d1af JN |
25 | - youtube-dl |
26 | - mpv (recommended) or vlc | |
52ecc638 | 27 | - peerflix (for magnet links) |
7d08d1af | 28 | |
3f6de5cb | 29 | Download the latest build from GitlabCI (amd64 GNU/Linux only). |
44978125 | 30 | |
c4aeb618 | 31 | ```sh |
3c20e75c | 32 | wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip |
c4aeb618 JN |
33 | unzip artifacts.zip |
34 | ``` | |
35 | ||
44978125 | 36 | |
3f6de5cb | 37 | For other platforms, create a release artifact using the following command: |
44978125 | 38 | |
3f6de5cb | 39 | ```sh |
3c20e75c | 40 | nim c -d:ssl -d:release nimcoon.nim |
44978125 JN |
41 | ``` |
42 | ||
3f6de5cb | 43 | Copy the binary to a directory on your PATH such as `/usr/local/bin` |
44978125 | 44 | |
3f6de5cb | 45 | ## Usage |
44978125 JN |
46 | |
47 | ```sh | |
3c20e75c | 48 | nimcoon emacs |
44978125 | 49 | |
c4aeb618 | 50 | # If your search query has multiple words, use quotes |
3c20e75c | 51 | nimcoon 'nim lang' |
f135dfc7 JN |
52 | |
53 | # Advanced: Play audio of the first search result | |
3c20e75c | 54 | nimcoon -m -l "counting stars" |
44978125 | 55 | ``` |
c4aeb618 | 56 | |
4827df7a JN |
57 | ### Commandline arguments |
58 | ||
3c20e75c JN |
59 | | **Arguments** | **Explanation** | |
60 | |-------------------|--------------------------------------------| | |
61 | | -m, --music | Play Music only, no video | | |
62 | | -l, --lucky | Try your luck with the first search result | | |
63 | | -f, --full-screen | Play video in full screen | | |
e9f0c7d0 | 64 | | -d, --download | Download video or music | |
4827df7a | 65 | |
3f6de5cb JN |
66 | ## Development |
67 | ||
68 | One-liner for compiling and running | |
c4aeb618 JN |
69 | |
70 | ```sh | |
3c20e75c | 71 | nim c -d:ssl -r nimcoon.nim 'nim lang' |
68fd8100 | 72 | ``` |