Skip to content

maddymodd/webtorrent-with-speed-limits

 
 

Repository files navigation


WebTorrent
WebTorrent with Speed Limits

WebTorrent is a torrent client that lets you stream video while downloading. The original WebTorrent client doesn't let you turn on speed limits, so I added them.

Works with Linux, Windows, and Mac OS.

Download

  • Download the latest version here.

Screenshots

scr1 speedlimits

How to Contribute

Clone the respository

git clone https://github.com/maddymodd/webtorrent-with-speed-limits

Enter the folder

cd webtorrent-with-speed-limits

Install the dependencies

npm install

or

npm i

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

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:

  • --sign - Sign the application (Mac, Windows)
  • --package=[type] - Package single output type.
    • deb - Debian package
    • rpm - RedHat package
    • zip - Linux zip file
    • dmg - Mac disk image
    • exe - Windows installer
    • portable - Windows portable app
    • all - All platforms (default)

Note: Even with the --package option, the auto-update files (.nupkg for Windows, -Mac.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 mono

and then:

brew install --cask wine-stable

(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:

brew install fakeroot dpkg rpm

Privacy

WebTorrent 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 License: https://github.com/maddymodd/webtorrent-with-speed-limits/blob/master/LICENSE

Packages

No packages published

Languages

  • JavaScript 94.2%
  • CSS 4.7%
  • Other 1.1%