X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/d36e22010231d8bd139b906fc66e060575decb2d..893b4f6cdfb995fc98d5edda42c847a4832a9ac0:/README.md diff --git a/README.md b/README.md index 7af3591..18453ab 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ Play videos from YouTube and PeerTube from the command line using your preferred desktop media player. +NewPipe app offers similar features for Android. + This application is implemented in [Nim language](https://nim-lang.org) using only the standard library. @@ -13,33 +15,45 @@ only the standard library. - [x] Search for videos using keywords - [x] Stream videos and music from YouTube - [x] Play direct links from YouTube and PeerTube -- [x] Stream video and music from magnet links +- [x] Stream video and music from magnet links and hyperlinks to torrent files - [x] Download music - [x] Download video -- [x] Play playlists (MPV only) -- [ ] Download playlists -- [ ] Autoplay next video/audio +- [x] Play YouTube playlists (MPV only) +- [ ] Download YouTube playlists +- [x] Stream video from torrent file URLs +- [x] BitTorrent is preferred for PeerTube video links +- [ ] Search PeerTube (3.0 or later) +- [ ] YouTube Autoplay - [ ] Configuration options +| | YouTube | PeerTube (HTTP) | PeerTube (BitTorrent) | Direct Magnet Link | +| -------- | -------- | -------- | -------- | -------- | +| Music Streaming | ✅ | ✅ | ✅ | ✅ | +| Video Streaming | ✅ | ✅ | ✅ | ✅ | +| Music Download | ✅ | ✅ | | | +| Video Download | ✅ | ✅ | | | + ## Installation Nim Coon depends on the following: - youtube-dl - mpv (recommended) or vlc -- peerflix (for magnet links) +- peerflix and webtorrent (for magnet links) -Install VLC or MPV using your distribution's package manager. +Install MPV or VLC using your distribution's package manager. Install YouTube-dl ``` sh pip3 install --user youtube-dl ``` -Install PeerFlix +Install PeerFlix and WebTorrent ```sh -npm install --global peerflix +npm install --global peerflix webtorrent-cli ``` +(Optional) If you want your YouTube downloads to be faster, install `aria2` download manager. + ### Installing using Nimble NimCoon can be installed from Nimble repositories: