webtorrent-desktop README

The project's README from github.com/webtorrent/webtorrent-desktop. As one markdown file: README.md.


WebTorrent
WebTorrent Desktop

The streaming torrent app. For Mac, Windows, and Linux.

discord GitHub CI action github release version github release downloads Standard - JavaScript Style Guide

Install

Download the latest version of WebTorrent Desktop from the official website:

✨ Download WebTorrent Desktop ✨

Advanced Install

Screenshots

screenshot screenshot

How to Contribute

Get the code

$ git clone https://github.com/webtorrent/webtorrent-desktop.git
$ cd webtorrent-desktop
$ npm install

Run the app

$ npm start

Watch the code

Restart the app automatically every time code changes. Useful during development.

$ npm run watch

Run linters

$ npm test

Run integration tests

$ npm run test-integration

The integration tests use Spectron and Tape. They click through the app, taking screenshots and comparing each one to a reference. Why screenshots?

For MacOS, you'll need a Retina screen for the integration tests to pass. Your screen should have the same resolution as a 2018 MacBook Pro 13".

For Windows, you'll need Windows 10 with a 1366x768 screen.

When running integration tests, keep the mouse on the edge of the screen and don't touch the mouse or keyboard while the tests are running.

Package the app

Builds app binaries for Mac, Linux, and Windows.

$ npm run package

To build for one platform:

$ npm run package -- [platform] [options]

Where [platform] is darwin, linux, win32, or all (default).

The following optional arguments are available:

Note: Even with the --package option, the auto-update files (.nupkg for Windows, -darwin.zip for Mac) will always be produced.

Windows build notes

The Windows app can be packaged from any platform.

Note: Windows code signing only works from Windows, for now.

Note: To package the Windows app from non-Windows platforms, Wine and Mono need to be installed. For example on Mac, first install XQuartz, then run:

$ brew install wine mono

(Requires the Homebrew package manager.)

Mac build notes

The Mac app can only be packaged from macOS.

Linux build notes

The Linux app can be packaged from any platform.

If packaging from Mac, install system dependencies with Homebrew by running:

npm run install-system-deps

Electron (Framework to make native apps for Windows, OSX and Linux in Javascript): https://electronjs.org/docs/tutorial/quick-start

React.js (Framework to work with Frontend UI): https://reactjs.org/docs/getting-started.html

Material UI (React components that implement Google's Material Design.): https://material-ui.com/getting-started/installation

Privacy

WebTorrent Desktop collects some basic usage stats to help us make the app better. For example, we track how well the play button works. How often does it succeed? Time out? Show a missing codec error?

The app never sends any personally identifying information, nor does it track which torrents you add.

License

MIT. Copyright (c) WebTorrent, LLC.

webtorrent-desktop (webtorrent/webtorrent-desktop)

Searching Database…

10.1K ·GitHub
Webtorrent-desktop
Что это такое?WebTorrent Desktop — бесплатный торрент-клиент с открытым исходным кодом и поддержкой стриминга для Mac, Windows и Linux: видео начинает проигрываться, ещё пока загрузка идёт.
Это приложение для компьютера или оно работает в браузере?Это обычное приложение для компьютера, а не браузерное — оно построено на Electron с интерфейсом на React и Material UI и распространяется в виде установщиков для каждой платформы.
Нужно ли сначала установить Node.js или что-то ещё?Обычным пользователям достаточно только установщика. Node.js ^16 или ^18 с npm 7-10 нужны лишь тем, кто собирает проект из исходников.
А не будет ли программа следить за тем, что я скачиваю?Она собирает базовую анонимную статистику использования (например, как часто нажатие кнопки воспроизведения срабатывает, а сколько раз завершается тайм-аутом), но не отправляет никаких личных данных и не отслеживает, какие торренты вы добавляете.
Оно бесплатное?Да — приложение полностью бесплатное, распространяется по лицензии MIT, авторские права принадлежат WebTorrent, LLC.
Могу ли я вывести видео на телевизор или другое устройство?Да — в приложении уже есть поддержка стриминга на приёмники Chromecast, DLNA и AirPlay (модули chromecasts, dlnacasts и airplayer входят в его зависимости).
Какие форматы установщиков можно выбрать?Для Mac — файл .dmg, для Windows — установщик .exe или портативная версия, для Linux — пакеты .deb, .rpm или .zip. Скрипт сборки также всегда создаёт файлы автообновления (.nupkg для Windows, -darwin.zip для Mac).
What are similar projects?webtorrent, ivideo, deskreen, qBittorrent, trystero, WebRTC-Experiment, awesome-zhuiju-free, streambert
Which topics is it in?webtorrent, material-ui, bittorrent, media-player, file-sharing, video-player, video-streaming, webrtc, p2p, downloader, electron, streaming
Creator
webtorrent
Size
173.1 MB
Stars
10.1K
Updated
CommitJul 09Releasev0.24.0Aug 29
Age
11y
Commits · 90 Days