Giter VIP home page Giter VIP logo

twitch-tui's Introduction

Twitch chat in the terminal

CI pre-commit.ci status Lines of code Crate Status

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.
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).

Setup

  1. Install Rustup from the rust-lang website.
  2. 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").
  3. 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
  4. Get an OAuth token from Twitch, and place the value in the token variable in the config.toml that was previously generated.
  5. 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.

twitch-tui's People

Contributors

balroggg avatar dependabot[bot] avatar kosayoda avatar kshpin avatar modprog avatar pre-commit-ci[bot] avatar xithrius avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.