Skip to content

Latest commit

 

History

History
93 lines (78 loc) · 4.32 KB

README.md

File metadata and controls

93 lines (78 loc) · 4.32 KB
Raw

twitchez

The famous HACKERMANS twitch.tv emote

PyPI - Status PyPI PyPI - License PyPI - Downloads

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

Leave a star to show interest in further development of the project ⭐️

twitchez-v.0.0.4.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, 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, 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 (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 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 ueberzugpp to display thumbnails (Optional)

If ueberzugpp is not installed text mode without thumbnails will be used.

You also can 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 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