Xithrius/twitch-tui
1
1
Fork 0
mirror of https://github.com/Xithrius/twitch-tui.git synced 2024-09-11 05:35:26 +03:00
Code Issues Packages Projects Releases Wiki Activity
Twitch chat in the terminal.
233 Commits 3 Branches 56 Tags 5.9 MiB
Rust 99.4%
Nix 0.4%
Dockerfile 0.2%
59299bf490
Go to file
pre-commit-ci[bot] 59299bf490
[pre-commit.ci] pre-commit autoupdate 
updates:
- [github.com/pre-commit/pre-commit-hooks: v4.0.1 → v4.1.0](https://github.com/pre-commit/pre-commit-hooks/compare/v4.0.1...v4.1.0)
2021-12-27 18:56:26 +00:00
.github Publish to crates.io on release creation 2021-11-16 15:40:16 -08:00
src Pressing the up key escapes input mode 2021-12-12 15:52:00 -08:00
.gitignore Ignoring vim's temporary files 2021-12-11 22:24:59 -08:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2021-12-27 18:56:26 +00:00
Cargo.lock Bump anyhow from 1.0.51 to 1.0.52 2021-12-24 07:16:16 +00:00
Cargo.toml Bump anyhow from 1.0.51 to 1.0.52 2021-12-24 07:16:16 +00:00
cli.yml Preparing for release 2021-12-12 16:59:23 -08: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 Updated keybinds to reflect popup windows 2021-12-12 17:05:28 -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 input mode for sending messages. Exit this mode with Esc.
? Have the keybinds popup window appear.
q Quit out of the entire application.
C Open popup window to switch channels.
Esc Exits out of layered windows, such as going from input mode, to normal, to exiting the application.
Input 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
Enter Confirm the input text to go through
Esc Drop back to previous window layer

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.
  2. Copy default-config.toml to a config.toml file. Based on your OS, place the config file in the following directories:
    • Windows: %appdata%\twt\config.toml
    • Linux/MacOs: ~/.config/twt/config.toml
  3. Get an OAuth token from Twitch, and have it ready to put into the token variable in the config.toml file that you created.
  4. Run cargo install twitch-tui and follow the instructions that it prints.
  5. You should now be able to run twt from anywhere now. 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.