/twitch-chat

A terminal running twitch-chat client

Primary LanguageRust

twitch-chat (WIP)

this is a tiny TUI twitch chat listener that runs in the terminal and prints chat messages to the screen.

How to run

If you want to run this there are some steps that needs to be taken.

  • Clone or fork the repository
  • Checkout the master branch
  • Build the project using cargo build
  • Generate a twitch api token by going to https://twitchapps.com/tmi/ and connect
  • set this token as an environmental variable named TWITCH_API_TOKEN
  • go to the target folder, and either debug or release depending on what type of build you did
  • run:
twitch-chat --nick=<nick> --channel=<channel>

where <nick> is the nickname of your account the token is issued for and <channel> is the name of the streamers chat you want to connect to.

Enable logging

per default the application does not log anything. If you wish to enable logging to maybe debug something add the --log flag and the application will log to a file in the same directory named twitch_chat.log. Default logging level is info but if you wish to change that, add one of the flags --debug, --info, --warn, --error, --trace during startup.

remember to enable logging, as the log level flag only sets the level.

example:

twitch-chat --nick=<nick> --channel=<channel> --log --debug

TODO:

  • make NICK parameter an input argument
  • breakout application from main method
  • add a unicode symbol that represents Kappa
  • add file logger, to be able to tail logs
  • ability to include some context while logging
  • ability to set log levels in logger
  • Overhaul the logging, and add proper logging in the entire application.
  • implement a "padder" struct/function that will fill out with whitespaces.
  • implement Drop for EventHandler
  • add --debug flag so we can read debug messages in chat, including broken chat messages
  • add line wrapping of messages
  • generate colors for users that are missing and store them in a cache
  • identify smileys and replace with unicode
  • add unicode stuff for moderators
  • add subscriber unicode char
  • someday look into using viuer
  • highlight first message in chat
  • highlight reply messages to chat owner
  • remember to never implement log rotation

Parser bugs:

  • backslash should be allowed in the id field
  • comma needs to be allowed in "flags" header