Skip to content

Latest commit

 

History

History
132 lines (90 loc) · 8.68 KB

README.md

File metadata and controls

132 lines (90 loc) · 8.68 KB
Raw

Streamlink Twitch GUI

Supported platforms Latest release Open issues Gitter IRC Build status Code coverage

A multi platform Twitch.tv browser for Streamlink

Streamlink Twitch GUI

Livestreamer Twitch GUI has been renamed

Streamlink Twitch GUI, previously known as Livestreamer Twitch GUI, has been renamed in early december 2016. A comment regarding this change can be found in the thread "The future of Livestreamer Twitch GUI".

Description

A graphical user interface on top of the Streamlink command line interface.

Streamlink Twitch GUI is a NW.js application, which means that it is a web application written in JavaScript (EmberJS), HTML (Handlebars) and CSS (LessCSS) and is being run by a Node.js powered version of Chromium.

Recent releases / Changelog / Wiki / Chat

Features

  • Available on Windows, macOS and Linux
  • Watch streams in the video player of your choice via Streamlink
  • Watch multiple streams at once
  • Browse streams by popularity, game, channel or team
  • Access your followed streams and channels
  • Filter streams by channel- or broadcasting language
  • Receive desktop notifications when new streams start
  • Join the Twitch chat by using customizable chat applications
  • Rich settings menu with lots of customizations and presets
  • Individual channel settings
  • Available in multiple languages
  • Automatic or custom selection of light and dark themes
  • Customizable hotkeys
  • Command line parameters for automation purposes

Why

One of the reasons for having bad viewing experiences on Twitch.tv is the implementation of their resource-heavy website and HTML5 video player. Especially on mobile desktop devices, high CPU and memory usage and lack of GPU acceleration of the web browser can cause major issues like buffering, stuttering or low video playback frame rates, all while draining the device's battery and spinning up its fans. Even on desktop computers, watching streams on Twitch.tv while multi-tasking can be an issue.

With Streamlink Twitch GUI, you're not dependent on your web browser and streams can be watched in the video player of your choice, enabling a smooth video playback. Depending on your choice of player, additional features become available, like for example timeshift support or resolution/framerate upscaling. In addition to that, Streamlink's variable stream buffers will help you countering bad network conditions or reducing the stream's latency even further.

Please bear in mind that you're bypassing any ads run by Twitch by using this software. If you want to support Twitch or a single broadcaster, please consider buying Twitch Prime or subscribing to the broadcaster's channel. Thank you!

Download

Stable release

Visit the project's wiki for detailed installation and configuration guides, or just see the GitHub releases page if you don't need help. The wiki also includes a list of supported packages for your platform.

Please remember that Streamlink Twitch GUI, as the name already suggests, is only a graphical user interface (GUI) built on top of the Streamlink command line interface (CLI). This means that Streamlink has to be installed on your system in order to be able to launch streams. Once again, see the wiki if you need help, as it also covers installing Streamlink.

Development version

Pre-built debug builds for all supported operating systems are available to download from the nightly Github actions runs. Downloading build artifacts requires a Github account.

If you want to test the latest version on your own, you can do this by cloning the repository and building the application off the master branch. Further instructions can be found down below or in CONTRIBUTING.md.

Please don't forget to report any bugs you may encounter. Thank you very much for helping!

Build

Building the application on your own is simple. Just make sure that the latest stable versions of Git, Node.js and Yarn are installed on your system.
Then run the following lines to clone the repository, to install all dependencies and to start the build process. You will then find the built application inside the build/releases folder. See CONTRIBUTING.md for more detailed instructions.

git clone https://github.com/streamlink/streamlink-twitch-gui.git
cd streamlink-twitch-gui
yarn install
yarn run grunt release

Contribute

Every contribution is welcome! Please read CONTRIBUTING.md first.

Do you speak another language? Translating or improving translations is a good and simple way of helping and contributing to the project.
Please see the Translating section on the wiki for all the necessary informations and the beginner's translating guide.

Support

If you think that this application is helpful, please consider supporting its creator by sending a small, optionally recurring, tip.

Thank you very much for your support!