twitch-tui/README.md
Xithrius 5404aeaa93
Update keybinds in help window. (#41)
* Insert mode no longer accepts empty messages

* Stored keybinds in static vectors

* vector_column_max can now take any width 2D vector

* Added more keys to the README.md tables.

Also, added insert mode to the key.rs file because I forgot about it.

* Appease Clippy
2021-10-16 20:35:51 -07:00

3.1 KiB

Twitch Chat IRC, 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/ttc/config.toml if you're on Linux or MacOS. If on Windows, place it at %appdata%/ttc/config.toml instead.
  3. Run cargo install twitch-terminal-chat and follow the instructions that it prints.
  4. You should now be able to run ttc from anywhere now. Have fun!