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.
289 Commits 3 Branches 56 Tags 5.9 MiB
Rust 99.4%
Nix 0.4%
Dockerfile 0.2%
b0d860a136
Go to file
Xithrius b0d860a136
Old to new GitHub template feature request
2022-02-22 01:58:59 -08:00
.github Old to new GitHub template feature request 2022-02-22 01:58:59 -08:00
.vscode Preparing for v2.0 (#74) 2022-02-16 16:09:39 -08:00
images Updated keybind documentation, added new preview image 2022-02-22 01:23:57 -08:00
src Made instructions more clear, removed old keybinds 2022-02-22 01:46:11 -08:00
.gitignore Preparing for v2.0 (#74) 2022-02-16 16:09:39 -08:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2021-12-27 18:56:26 +00:00
Cargo.lock Replacing StructOpt with Clap. (#107) 2022-02-22 00:24:28 -08:00
Cargo.toml Replacing StructOpt with Clap. (#107) 2022-02-22 00:24:28 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md. 2021-10-10 14:10:23 -07:00
default-config.toml Merge branch 'main' into configure_title 2022-01-12 17:01:40 -08:00
LICENSE Preparing for v2.0 (#74) 2022-02-16 16:09:39 -08:00
README.md Made instructions more clear, removed old keybinds 2022-02-22 01:46:11 -08: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 message input mode for sending messages. Exit this mode with `Esc`.
? Have the keybinds popup window appear.
q Quit out of the entire application once in the base chat view.
s Open a popup window to switch channels.
Ctrl + f Enter message search mode, which highlights messages in the main window which match the query.
Esc Exits out of layered windows, such as going from the help window to normal view.
Input mode (message sending/searching, channel swapping)
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 character with current character.
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 character to the right.
Enter Confirm the current text to go through (doesn't do anything in message search mode).

Setup

  1. Make sure you have Cargo installed from rust-lang website. Make sure the Cargo binary folder is appended to your $PATH environment variable. Copy default-config.toml to a config.toml file. Based on your OS, place the config file in the directories listed below. Any command line options/arguments taken from twt --help (when the binary is eventually installed) will overwrite the corresponding value in the config file.
    • Windows: %appdata%\twt\config.toml
    • Linux/MacOs: ~/.config/twt/config.toml
  2. Get an OAuth token from Twitch, and have it ready to put into the token variable in the config.toml file that you created.
  3. Run cargo install twitch-tui and follow the instructions that it prints.
  4. You should now be able to run twt. For CLI options/arguments, run twt --help for information. Any arguments/options passed through the command line will overwrite config.toml. 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.