https://github.com/WANDEX/twitchez
TUI client for Amazon's twitch.tv with thumbnails
https://github.com/WANDEX/twitchez
console curses dmenu fzf gplv3 mpv python streamlink terminal thumbnails tui twitch twitchez twitchtv ueberzug ueberzugpp
Last synced: 5 months ago
JSON representation
TUI client for Amazon's twitch.tv with thumbnails
- Host: GitHub
- URL: https://github.com/WANDEX/twitchez
- Owner: WANDEX
- License: gpl-3.0
- Created: 2022-01-11T13:50:36.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-05T20:35:06.000Z (about 1 year ago)
- Last Synced: 2025-05-12T17:12:34.378Z (6 months ago)
- Topics: console, curses, dmenu, fzf, gplv3, mpv, python, streamlink, terminal, thumbnails, tui, twitch, twitchez, twitchtv, ueberzug, ueberzugpp
- Language: Python
- Homepage:
- Size: 389 KB
- Stars: 19
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# twitchez
twitchez - TUI client for twitch.tv with thumbnails support that works right in your terminal.
Support of rendering images by the terminal is not required, ueberzugpp will handle that.\
You may ask -- **"Is this magic?"** -- Well **YES**, the black magic! Welcome to the club!
Since **v0.0.7** twitchez supports **ueberzugpp** -- this expands list of supported platforms:\
**linux / macOS / windows / freeBSD / X11 / Wayland /** any terminal with **SIXEL** support e.g.
[WezTerm](https://github.com/wez/wezterm)
### Leave a star to show interest in further development of the project ⭐️
https://user-images.githubusercontent.com/15724752/152787467-dc2a8871-43e5-4530-94b1-e14383c8b18e.mp4
## Features
* Explore twitch without leaving your terminal
* Flexible configuration via user config (including custom cmd)
* Completely keyboard driven workflow
* Zero mouse interaction. `F1 / ?` for help about key mappings
* Redefine keys and hint chars for your keyboard layout
* Link hints similar as in (Vimium, Surfingkeys, etc.)
* Interactive select of one entry from all
([fzf](https://github.com/junegunn/fzf),
[dmenu](https://tools.suckless.org/dmenu/),
or any other program via custom cmd)
* Bookmarks & 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](https://github.com/streamlink/streamlink),
[mpv](https://github.com/mpv-player/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 the [ueberzugpp](https://github.com/jstkdng/ueberzugpp) (optional dependency)
## 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](https://pypi.org/project/twitchez/) via [pip](https://pip.pypa.io/en/stable/)
into user-wide environment:
```
$ pip3 install --user twitchez
```
or system-wide environment:
```
# pip3 install twitchez
```
To update, add the `--upgrade` or `-U` option.
#### Install ueberzugpp to display thumbnails (Optional)
If [ueberzugpp](https://github.com/jstkdng/ueberzugpp?tab=readme-ov-file#install)
is not installed **text mode without thumbnails** will be used.
You also can [build from source](https://github.com/jstkdng/ueberzugpp?tab=readme-ov-file#build-from-source)
and install **build dir** e.g. `# sudo cmake --install build`
## Troubleshooting
##### If you installed ueberzugpp but still not see thumbnails:
* override default ueberzugpp output **via twitchez user config** *(check **default.conf** it has example)*
* check available **output** options in **ueberzugpp** via `$ ueberzugpp layer --help`
* x11 and/or wayland (may not be available if disabled in compilation) -- build ueberzugpp from source
* if you want to draw via e.g. sixel, make sure that your terminal have such capability
* [WezTerm](https://github.com/wez/wezterm) has sixel support, try to launch twitchez in it
##### If thumbnails partially overlap underlying text (it is very font dependent):
* set width/height modifier in user config
* adjust your terminal font size by +1 etc
* try different terminal font
## License
[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)