Xithrius/twitch-tui
1
1
Fork 0
mirror of https://github.com/Xithrius/twitch-tui.git synced 2024-09-11 13:45:30 +03:00
Code Issues Packages Projects Releases Wiki Activity
Twitch chat in the terminal.
167 Commits 3 Branches 56 Tags 5.9 MiB
Rust 99.4%
Nix 0.4%
Dockerfile 0.2%
de02a8035c
Go to file
Xithrius de02a8035c
Added greetings workflow
2021-10-30 19:28:22 -07:00
.github Added greetings workflow 2021-10-30 19:28:22 -07:00
src Renamed State::KeybindHelp to State::Help 2021-10-30 15:51:45 -07:00
.gitignore unignored config.toml since it's not placed within the project 2021-09-26 16:36:50 -07:00
.pre-commit-config.yaml Fixed and added pre-commit hooks 2021-09-20 20:01:23 -07:00
Cargo.lock Bumped version 2021-10-27 02:42:32 -07:00
Cargo.toml Bumped version 2021-10-27 02:42:32 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md. 2021-10-10 14:10:23 -07:00
default-config.toml Removed .env file 2021-09-19 00:13:33 -07:00
LICENSE Initial commit 2021-08-23 15:27:12 -07:00
README.md Command suggestions window. (#45) 2021-10-27 02:40:50 -07:00

README.md

Twitch chat in the terminal.

What it looks like:

image

Keybinds:

Normal mode
Key Description
c Go to the chat window chat.
i Enter insert mode for sending messages. Exit this mode with Esc.
? Have the keybinds window appear.
q Quit out of the entire application.
Esc Exits out of layered windows, such as going from insert mode, to normal, to exiting the application.
Insert mode
Key Description
Ctrl + w Cuts a single word (from the cursor to the next whitespace)
Ctrl + u Cuts the entire line
Ctrl + f Move cursor to the right
Ctrl + b Move cursor to the left
Ctrl + a Move cursor to the start
Ctrl + e Move cursor to the end
Alt + f Move to the end of the next word
Alt + b Move to the start of the previous word
Ctrl + t Swap previous item with current item
Alt + t Swap previous word with current word
Ctrl + u Remove everything before the cursor
Ctrl + k Remove everything after the cursor
Ctrl + w Remove the previous word
Ctrl + d Remove item to the right
Esc Drop back to previous window layer

Setup:

  1. Make sure you have both Cargo and installed from the rust-lang website. Make sure the Cargo binary folder is appended to your $PATH environment variable.
  2. Get an OAuth token from Twitch, and have it ready to put into the token variable in the config.toml file that you create. This config.toml file should be created in ~/.config/twt/config.toml if you're on Linux or MacOS. If on Windows, place it in %appdata%\twt\config.toml instead.
  3. Run cargo install twitch-tui and follow the instructions that it prints.
  4. You should now be able to run twt from anywhere now. To update in the future, run cargo install twitch-tui. Have fun!

More information:

  • This project used to be named terminal-twitch-chat, but was renamed to twitch-tui in version 1.2.2.