https://github.com/mrxdst/webtorrent-mpv-hook

Adds a hook that allows mpv to stream torrents
https://github.com/mrxdst/webtorrent-mpv-hook

mpv webtorrent

Last synced: 3 months ago
JSON representation

Adds a hook that allows mpv to stream torrents

• Host: GitHub
• URL: https://github.com/mrxdst/webtorrent-mpv-hook
• Owner: mrxdst
• Created: 2020-07-23T15:38:24.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-18T11:52:11.000Z (over 1 year ago)
• Last Synced: 2024-04-23T11:02:11.952Z (7 months ago)
• Topics: mpv, webtorrent
• Language: TypeScript
• Homepage:
• Size: 2.29 MB
• Stars: 123
• Watchers: 9
• Forks: 7
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-mpv - webtorrent-mpv-hook - Adds a hook that allows mpv to stream torrents using webtorrent. (Other)

README

        
![mpv streaming a torrent](https://github.com/mrxdst/webtorrent-mpv-hook/raw/master/.github/poster.png)

# webtorrent-mpv-hook

[![npm](https://img.shields.io/npm/v/webtorrent-mpv-hook)](https://www.npmjs.com/package/webtorrent-mpv-hook)

[![mpv](https://img.shields.io/badge/mpv-v0.38.0-blue)](https://mpv.io/)

Adds a hook that allows mpv to stream torrents using [webtorrent](https://github.com/webtorrent/webtorrent).  

## Prerequisites

* node.js

## Install

1. `npm install --global webtorrent-mpv-hook`

2. You need to symlink a script file to your mpv scripts folder.  

   Run `webtorrent-mpv-hook` for instructions.  

   You only need to do this once.

## Usage

`mpv `

Where `torrent-id` is one of:

* magnet link

* info-hash

* path or url to `.torrent` file

An overlay will be shown with info/progress. It will be closed automatically when playback starts.  

It can also be toggled manually with `p` (default).

> Multi-file torrents are opened as a playlist.

## Configuration

Default values are shown below.

### `input.conf`

```properties

# Toggles info/progress overlay.

p script-binding webtorrent/toggle-info

```

### `script-opts/webtorrent.conf`

```properties

# Path to save downloaded files in. Can be set to "memory" to store all files in RAM.

path=./

# Maximum number of connections.

maxConns=100

# Port to use for webtorrent web-server.

# If it's already in use a random port will be chosen instead.

port=8888

# Enable μTP support.

utp=yes

# Enable DHT.

dht=yes

# Enable local service discovery.

lsd=yes

# Download speed limit in bytes/sec.

downloadLimit=-1

# Upload speed limit in bytes/sec.

uploadLimit=-1

# Specify the node command to use.

# Usefull if the command is called nodejs on your system.

node_path=node

# The same text style options as in stats.conf is also available.

```