Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mafintosh/peerflix
Streaming torrent client for node.js
https://github.com/mafintosh/peerflix
Last synced: 4 days ago
JSON representation
Streaming torrent client for node.js
- Host: GitHub
- URL: https://github.com/mafintosh/peerflix
- Owner: mafintosh
- License: mit
- Created: 2013-03-14T17:15:43.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2022-06-19T23:29:59.000Z (over 2 years ago)
- Last Synced: 2024-10-29T14:56:26.710Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 310 KB
- Stars: 6,186
- Watchers: 157
- Forks: 672
- Open Issues: 138
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs-precise - peerflix - square)]() | Streaming torrent client. | (Packages / Mad science)
- awesome-peer-to-peer - peerflix
- awesome-nodejs-cn - peerflix - 洪流客户端 (包 / 黑科技)
- awesome-command-line-apps - peerflix - Streaming torrent client for node.js. (\*nix/\*nux / Download Utilities)
- awesome-github-repos - mafintosh/peerflix - Streaming torrent client for node.js (JavaScript)
- awesome-nodejs - peerflix - Streaming torrent client. (Packages / Mad science)
- awesome-nodejs - peerflix - Streaming torrent client. (Packages / Mad science)
- awesome-peer-to-peer - peerflix
- awesome-network-js - peerflix
- awesome-nodejs - peerflix - Streaming torrent client for node.js - ★ 4955 (Mad science)
- awesome-nodejs-cn - peerflix - 流客户端. (包 / 神奇的科学)
- awesome-nodejs-cn - peerflix - 磁力种子客户端. (目录 / 逼格项目)
- awesome-nodejs-new - peerflix - Streaming torrent client. (Packages / Mad science)
- awesome-nodejs-cn - peerflix - **star:6200** 流式 Torrent 客户端 ![star > 2000][Awesome] (包 / 黑科技)
README
# peerflix
Streaming torrent client for Node.js
```
npm install -g peerflix
```
[](http://travis-ci.org/mafintosh/peerflix)
## Usage
Peerflix can be used with a magnet link or a torrent file.
To stream a video with its magnet link use the following command.
```
peerflix "magnet:?xt=urn:btih:ef330b39f4801d25b4245212e75a38634bfc856e" --vlc
```
Remember to put `"` around your magnet link since they usually contain `&`.
`peerflix` will print a terminal interface. The first line contains an address to a http server. The `--vlc` flag ensures vlc is opened when the torrent is ready to stream.
To stream music with a torrent file use the following command.
```
peerflix "http://some-torrent/music.torrent" -a --vlc
```
The `-a` flag ensures that all files in the music repository are played with vlc.
Otherwise if the torrent contains multiple files, `peerflix` will choose the biggest one.
To get a full list of available options run peerflix with the help flag.
```
peerflix --help
```
Examples of usage of could be
```
peerflix magnet-link --list # Select from a list of files to download
peerflix magnet-link --vlc -- --fullscreen # will pass --fullscreen to vlc
peerflix magnet-link --mplayer --subtitles subtitle-file.srt # play in mplayer with subtitles
peerflix magnet-link --connection 200 # set max connection to 200
```
## Programmatic usage
If you want to build your own app using streaming bittorrent in Node you should checkout [torrent-stream](https://github.com/mafintosh/torrent-stream)
## Chromebook users
Chromebooks are set to refuse all incoming connections by default - to change this:
```
sudo iptables -P INPUT ACCEPT
```
## Chromecast
If you wanna use peerflix on your chromecast checkout [peercast](https://github.com/mafintosh/peercast)
or [castnow](https://github.com/xat/castnow)
## License
MIT