diff --git a/README.md b/README.md index 14b94d2..e2caac9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -Project icon - -# Multiplex - -Watch torrents with your friends. - -
+
+ Project icon +
+

Multiplex

+

Watch torrents with your friends.

+
+

Screenshot of two peers synchronizing playback @@ -19,7 +19,7 @@ Watch torrents with your friends. Multiplex is an app to watch torrents together, providing an experience similar to Apple's [SharePlay](https://support.apple.com/en-us/HT212823) and Amazon's [Prime Video Watch Party](https://www.amazon.com/adlp/watchparty). -It enables you to: +### Key Features - **Stream any file directly** using a wide range of video and audio formats with the mpv video player - **Host online watch parties while preserving your privacy** by synchronizing video playback with friends without a central server using [weron](https://github.com/pojntfx/weron) @@ -45,9 +45,11 @@ To get started, first find a [magnet link](https://en.wikipedia.org/wiki/Magnet_ Starting the app

-![Initial start screen with link entered](./docs/screenshot-link-entered.png) +

+ Initial start screen with link entered +

-Note that Multiplex will prompt you to install the [mpv media player](https://mpv.io/) if you don't already have it installed; to continue, please do so: +> **Note:** Multiplex will prompt you to install the [mpv media player](https://mpv.io/) if you don't already have it installed; to continue, please do so:

Prompt to install mpv @@ -55,13 +57,17 @@ Note that Multiplex will prompt you to install the [mpv media player](https://mp Next, select the file you want to stream; note that only media files are supported: -![Media selection](./docs/screenshot-media-selection.png) +

+ Media selection +

Finally, confirm that you have the right to stream the media you've selected. Note that many countries have copyright restrictions - in that case, please [take appropriate measures to protect yourself](https://sec.eff.org/topics/VPN): -![Confirmation screen](./docs/screenshot-confirmation.png) +

+ Confirmation screen +

-Note that you can also choose to stream without downloading! Provided that the underlying media file supports streaming playback (such as `.mkv` files), this allows you to start playing the media immediately, without having to wait for it to download completely: +> **Tip:** You can also choose to stream without downloading! Provided that the underlying media file supports streaming playback (such as `.mkv` files), this allows you to start playing the media immediately, without having to wait for it to download completely:

Option to stream without downloading @@ -69,35 +75,54 @@ Note that you can also choose to stream without downloading! Provided that the u After you've given your consent, playback will start, and you can enjoy the media you've selected: -![Playback screen](./docs/screenshot-playback.png) +

+ Playback screen +

-## 2. Ask Friends to Join +### 2. Ask Friends to Join While consuming media on your own can be fun, doing so with friends or your SO is always better. I built Multiplex to enjoy media together with my partner, but due to COVID and the Atlantic ocean we're unable to do so in person all the time - this app intents to bridge that gap. To ask someone to join, click on the people button in the top right, and copy the [stream code](https://github.com/pojntfx/multiplex/wiki/Stream-Codes): -![Join screen](./docs/screenshot-join.png) +

+ Join screen +

This stream code can now be entered by the person that wants to watch the media with you. There is no technical limit on how many people can join the session, so feel free to invite as many as you want! -![Entering stream codes](./docs/screenshot-enter-stream-code.png) +

+ Entering stream codes +

After the person that wants to join has entered the stream code, they need to confirm that they too have the right to stream the media; depending on your country, please ask them to [take appropriate measures to protect themselves](https://sec.eff.org/topics/VPN): -![Confirmation screen](./docs/screenshot-confirmation.png) +

+ Confirmation screen +

-Note that is recommended not to choose the option to stream without downloading when streaming with multiple people; while it is supported and buffering is synchronized across peers, it requires a very good internet connection for all peers in order for it to work smoothly. Once all peers have joined, you can start playback and enjoy the media together: +> **Important:** It is recommended not to choose the option to stream without downloading when streaming with multiple people; while it is supported and buffering is synchronized across peers, it requires a very good internet connection for all peers in order for it to work smoothly. -![Two peers synchronizing playback](./docs/screenshot-sync-playback.png) +Once all peers have joined, you can start playback and enjoy the media together: + +

+ Two peers synchronizing playback +

All play/pause events, seeking position etc. will be synchronized between all peers using [weron](https://github.com/pojntfx/weron), a peer-to-peer networking library. -## 3. Increase Privacy and Security +### 3. Increase Privacy and Security As noted above, the legality of consuming media from torrents depends on the country you're in. In most countries, following [these guidelines on VPNs from the Electronic Frontier Foundation](https://sec.eff.org/topics/VPN) will suffice, but Multiplex provides an additional option: **Remoting**. -Multiplex is built on [hTorrent](https://github.com/pojntfx/htorrent), an HTTP to BitTorrent gateway. Using remoting, it is possible to use a trusted server as a proxy to stream torrents from. This makes it possible to not only increase security for all peers without them having to take the appropriate measures themselves, but it can also increase the performance by caching the media on a single server with a good internet connection. To enable remoting, first [host a hTorrent gateway with basic authentication enabled](https://github.com/pojntfx/htorrent#1-start-a-gateway-with-htorrent-gateway) - be sure to set up TLS certificates to enable encryption, for example by using [Caddy](https://caddyserver.com/). Once you have a gateway set up, you can configure Multiplex to use in its preferences: +Multiplex is built on [hTorrent](https://github.com/pojntfx/htorrent), an HTTP to BitTorrent gateway. Using remoting, it is possible to use a trusted server as a proxy to stream torrents from. This makes it possible to not only increase security for all peers without them having to take the appropriate measures themselves, but it can also increase the performance by caching the media on a single server with a good internet connection. + +To enable remoting: +1. First [host a hTorrent gateway with basic authentication enabled](https://github.com/pojntfx/htorrent#1-start-a-gateway-with-htorrent-gateway) +2. Be sure to set up TLS certificates to enable encryption, for example by using [Caddy](https://caddyserver.com/) +3. Once you have a gateway set up, you can configure Multiplex to use in its preferences: -![Remoting preferences](./docs/screenshot-prefs-remoting.png) +

+ Remoting preferences +

Be sure to ask the people who want to stream the media with you to also use the gateway. @@ -107,51 +132,56 @@ For more preferences, see the [screenshots](#screenshots). ## Screenshots -Click on an image to see a larger version. - - -Entering a magnet link or stream code - - - -Media selection - - - -Confirming playback - - - -Playing media - - - -Selecting audio tracks - - - -Selecting subtitles - - - -Getting a stream code to join playback - - - -Two peers synchronizing media playback - - - -Playback preferences - - - -Remoting preferences - - - -Synchronization preferences - +
+ + Entering a magnet link or stream code + + + Media selection + +
+ +
+ + Confirming playback + + + Playing media + +
+ +
+ + Selecting audio tracks + + + Selecting subtitles + +
+ +
+ + Getting a stream code to join playback + + + Two peers synchronizing media playback + +
+ +
+ + Playback preferences + + + Remoting preferences + +
+ +
+ + Synchronization preferences + +
## Acknowledgements