TUI client for twitch with thumbnails
Project description
twitchez
TUI client for twitch with thumbnails.
[pre-alpha] WIP NOTICE: project development stage
This project is still in the early stage of development, you may, and probably will, experience corrupted terminal state, so run this client in a separate terminal window so you don't get frustrated if the client accidentally crashes.
Features
- Explore twitch without leaving your terminal. HACKERMANS B)
- Flexible configuration via user config (including custom cmd)
- Completely keyboard driven workflow
- Tabs (add, delete, next/prev, jump to tab by name)
- Following live channels
- Streams per category
- Videos per channel (archive/past broadcasts, clips, highlights, uploads)
- Open video/stream url in external video player
(streamlink,
mpv,
or any other program via custom cmd)
- Three independent user cmd and keys to open url as (stream, video, extra)
- Copy url to clipboard
- Open chat url in default browser or via custom cmd
- Thumbnails are drawn by ueberzug (X11 only)
(ueberzug is an optional dependency)
- If ueberzug is not installed text mode without thumbnails will be used.
If you do not know what X11 is - for you this means thumbnails will be drawn on Linux only (not exactly).
Configuration
Look inside twitchez/config/
dir to see all available settings, those are defaults.
Do not change default config files, create new in the user config dir: config.conf
, keys.conf
.
The default user config dir is $XDG_CONFIG_HOME/twitchez/
, or $HOME/.config/twitchez/
by default.
Settings from default config files are used as fallback for settings you haven't changed in your user config.
Install
Pip
Install twitchez via pip into user-wide environment:
$ pip3 install --user twitchez
or system-wide environment:
$ pip3 install twitchez
To update, add the --upgrade
or -U
option.
Install ueberzug (Optional)
ueberzug must be additionally installed to display thumbnails!
If ueberzug is not installed or not supported by your platform text mode without thumbnails will be used.
Troubleshooting
If you tried to run client without auth token or if your auth token expired:
- You are required to get new twitch auth token via
python auth.py
- You are required to wait default twitch data update time (5 min)
in order to update data for page requested previously without valid auth token.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.