mirror of https://github.com/Xithrius/twitch-tui.git synced 2024-09-11 13:45:30 +03:00

Twitch chat in the terminal.

Go to file

Xithrius c8ad42da0b Dependabot should've always been on weekly		2022-10-03 19:27:14 -07:00
.devcontainer	Addition of development container config and Dockerfile	2022-08-16 18:52:56 -07:00
.github	Dependabot should've always been on weekly	2022-10-03 19:27:14 -07:00
.vscode	Added rust-specific formatter	2022-06-07 21:38:36 -07:00
src	Add result count to fuzzy search box. (#230 )	2022-10-04 02:25:46 +00:00
.editorconfig	More editing/formatting configs	2022-09-02 00:03:30 -07:00
.gitignore	Preparing for v2.0 (#74 )	2022-02-16 16:09:39 -08:00
.pre-commit-config.yaml	`#![warn(clippy::nursery, clippy::pedantic)]` (#212 )	2022-09-07 20:22:22 -07:00
Cargo.lock	Clap 4.0 (#227 )	2022-10-01 17:34:42 -07:00
Cargo.toml	Clap 4.0 (#227 )	2022-10-01 17:34:42 -07:00
CODE_OF_CONDUCT.md	Create `CODE_OF_CONDUCT.md`.	2021-10-10 14:10:23 -07:00
default-config.toml	Highlight user's name in chat. (#206 )	2022-08-29 05:58:41 +00:00
deny.toml	More editing/formatting configs	2022-09-02 00:03:30 -07:00
LICENSE-APACHE	Added Apache 2.0 license, moved MIT license.	2022-07-01 13:51:24 -07:00
LICENSE-MIT	Added Apache 2.0 license, moved MIT license.	2022-07-01 13:51:24 -07:00
README.md	Added pre-commit and LOC badges	2022-09-01 12:09:48 -07:00
rustfmt.toml	More editing/formatting configs	2022-09-02 00:03:30 -07:00

Twitch chat in the terminal

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.
Ctrl + t	Toggle the filter.
Ctrl + r	Reverse the filter.
Ctrl + p	Manually trigger a panic, so the application crashes.
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.
Tab	Fill in suggestion, if available.
Enter	Confirm the current text to go through (doesn't do anything in message search mode).

Install Rustup from the rust-lang website.
Install the program through cargo install twitch-tui. You can use this same command to update the program in the future. To install a specific version, use a version number from the releases page and the --version flag (ex. cargo install twitch-tui --version "2.0.0-alpha.1").
Run the program with twt in the terminal to generate the default configuration at the paths below. If the directories don't exist, they will be created for you.
- Linux/MacOS: ~/.config/twt/config.toml
- Windows: %appdata%\twt\config.toml
Get an OAuth token from Twitch, and place the value in the token variable in the config.toml that was previously generated.
Once you're done modifying the config file, run twt again, and enjoy! Run twt --help if you're looking for more options/arguments.

If you have any problems, do not hesitate to submit an issue.

Along with this application, I recommend using streamlink so there's no more need for a browser.