zigzter / chatterm

A Twitch.tv chat client in the terminal, supporting moderator actions

Chatterm

Twitch chat in the terminal, with moderator actions.

⚡ Features

• View and send messages.
• Built-in authentication via Twitch.
• Ban & timeout users, clear chat, query user info
• Search received messsages, powered by the FTS5 extension of SQLite
• Username autocomplete on @ mentions and / commands, triggered by pressing tab.

🔧 Tech Used

• Bubble Tea for the terminal UI
• Gorilla WebSocket for the websocket connection
• SQLite for storage
• Viper for configuration

🖥️ Supported Platforms

Currently only tested on Linux. macOS might work if you build it yourself.

📦 Installation

Cloning option (requires Go):

1. git clone https://github.com/zigzter/chatterm.git
2. cd chatterm
3. go build --tags "fts5" .
4. ./chatterm

If you have to re-auth for whatever reason, and the oauth request gets stuck loading, try removing the connection from Twitch Connections, then retry the auth.

Downloading binary option: Simply download the binary and run ./chatterm

🚀 Supported Commands

• Ban a user: /ban username
• Timeout a user: /ban username timeInSeconds
• Search for messages: /search something to search
  • from:username restricts search to messages sent by that user
  • channel:channelName restricts search to messages in that channel
  • Supports wildcards and is case insensitive: kek* will find KEKW
  • Supports AND, NOT, and OR keywords. /search tf2 OR ow2 will find all messages that contain at least one of those
  • This search queries the local DB, so it will only find messages that you've received while in the chat rooms
• Clear chat: /clear (this is the moderator clear, not a local one)
• Get a user's info: /info username
• Send an announcement: /announcement something to announce
• Give a streamer a shoutout: /shoutout username (untested, only works if the channel you're in is live)
• Warn a user, requiring them to acknowledge the warning before they can resume chatting: /warn username reason
• Delete all locally stored chat messages: /clearall
• Enable/disable shield mode: /shield on|off
• Watch a user (highlight their messages): /watch username
  • To remove the user, re-run the command
  • You can also manually edit the $HOME/.config/chatterm.json file to add/remove users under the watched-users key

chatterm's Issues

Allow highlighting specific users

Sometimes a user can seem suspicious without warranting an immediate timeout or ban, and it can be hard to keep track of their messages in a busy chat room.
This feature is for adding a highlight to every chat message by a specified user to easily track them, similar to adding a user to the monitored list on Twitch. Possibly using something like /highlight username or /monitor username.

App creates duplicate chatterm.db and debug.log files.

I created an alias in my .zshrc

alias chatterm='~/chatterm/chatterm'

and it works but it creates a chatterm.db and debug.log file inside the directory that invokes chatterm.

Is there anyway to have it so it points to the same .db and .log file rather than creating new ones in each directory?

Authorizing page gives a 404 not found

so yeah - as the title says, I'm trying to authorize the use of chatterm, and the localhost page is giving me a 404 page not found error every time I try. it was perfectly fine the last time I did this, and everything worked just fine when I briefly gave Chatterino a try, so I don't know what's going on here.

Migrate from IRC to EventSub

Twitch recommends migrating IRC-based projects to their new EventSub-based chat.

See: https://dev.twitch.tv/docs/chat/irc-migration/

When searching for a channel and typing an 'a' -> Redirected to authentication page

Hey there,

just had some small dable with the Project looks cool.

I just found a small bug, that when I'm authenticated etc. and I go to search for a live channel (via 'i') and then when I type the letter 'a' (even after some other letters first) it jumps back to the authentication view.

I had a short look into the source code but could in my brief view not figure out where the bug lies.

I'm guessing it must have to do with that you give the 'authentication' keystroke priority in some of the case statements, but not quite sure.

If you need more information let me know.

Keep up the great work.