https://github.com/manuhabitela/twitchflix

A cli app to look for twitch channels and watch them in your favorite player
https://github.com/manuhabitela/twitchflix

cli livestreamer raspberry raspberry-pi streamlink twitch

Last synced: about 2 months ago
JSON representation

A cli app to look for twitch channels and watch them in your favorite player

• Host: GitHub
• URL: https://github.com/manuhabitela/twitchflix
• Owner: manuhabitela
• Created: 2016-01-17T18:54:45.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-01T13:15:24.000Z (almost 8 years ago)
• Last Synced: 2024-11-10T10:06:46.210Z (2 months ago)
• Topics: cli, livestreamer, raspberry, raspberry-pi, streamlink, twitch
• Language: JavaScript
• Size: 6.84 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `twitchflix`

`twitchflix` is a command-line application to look for popular streams from twitch and watch them instantly thanks to [streamlink](https://streamlink.github.io).

This was made to be able to watch twitch streams from a raspberry pi in tty only via omxplayer. *Didn't test this on the raspberry pi yet*.

## Installation

`twitchflix` is a node cli app. After [installing node and npm](https://nodejs.org/), install twitchflix globally on your system:

```

sudo npm install -g twitchflix

```

## Usage

Start using twitchflix with the `twitchflix` command!

All the help you need is visible with `twitchflix --help`:

```

Search streams from twitch, watch them directly thanks to streamlink.

Usage: twitchflix [OPTIONS] [-- STREAMLINK OPTIONS]

Options:

  -h, --help: show this message

  -v, --version: show twitchflix version

  -g, --game: show streams for given game only

              must be typed as shown on twich if no alias if available

  --aliases: show the list of games with an alias available

             an alias can be passed to the --game option instead of the full game name

  -l, --limit: limit the number of streams to choose from. Defaults to 25.

All params typed after -- are passed to streamlink.

By default, the streamlink `--default-stream best` option is passed.

Check out the streamlink doc for more details on possible options.

Examples:

  `twitchflix --game "Mount Your Friends"` # list only mount your friends streams

  `twitchflix --game hots` # list Heroes of the Storm streams

  `twitchflix -- medium` # override default stream quality

  `twitchflix -- --player vlc` # list most popular streams & play the source stream in vlc

  `twitchflix -- -np 'omxplayer -o hdmi'` # play in omx with custom omx options

```

As twitchflix allows you to pass all the options you want to streamlink without enforcing any defaults, or doesn't have any config file, it can be cumbersome to type the command. [Don't forget about aliases](http://raspberrypi.stackexchange.com/a/4285) :)