twitch-tui/README.md

20 lines
838 B
Markdown
Raw Normal View History

2021-08-30 21:28:54 +03:00
# Twitch Chat IRC, in the terminal.
2021-08-24 02:10:53 +03:00
### What it looks like:
2021-09-04 13:06:19 +03:00
2021-09-18 15:40:06 +03:00
![image](https://user-images.githubusercontent.com/15021300/133889088-7ec17848-b6c2-4e80-8dea-47f4b5b9553a.png)
2021-08-24 02:10:53 +03:00
2021-09-18 15:46:38 +03:00
### Keybinds:
- `?` for the keybinds window.
- `i` to insert text. Exit this mode with `Esc`.
- `Esc` exists out of layered windows, such as going from insert mode to normal, to exiting the application.
- `c` to go from whatever window (such as the help window) to chat.
- `q` to quit out of the entire application, given you're not in insert mode.
2021-08-24 02:10:53 +03:00
### Setup:
2021-09-04 13:06:19 +03:00
2021-08-30 21:28:54 +03:00
1. Copy everything from `default-config.toml` to a new file called `config.toml` to set everything you need.
2021-09-04 13:06:19 +03:00
2. Create a `.env` file and set `TOKEN` to your oauth token from [here](https://twitchapps.com/tmi/) (
ex. `TOKEN=oauth:asdfasdfasdf`).
2021-08-24 02:10:53 +03:00
3. run `cargo run --release`, and you're good to go!