kimimaru/TRBotChatDisplay
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases 4 Packages Wiki Activity
Custom chat display for TRBot written in Qt/C++.
93 commits 5 branches 4 tags 1.3 MiB
  • C++ 97.5%
  • QMake 1.4%
  • C 1.1%
Find a file
Kimimaru 2cc773951d Merge branch 'AutoReconnectWebSocket'
2025-06-12 23:29:48 +03:00
ExampleImages Updated README and image, and removed .NET project 2023-03-27 22:54:55 +03:00
Logo Added a logo for the application 2022-10-27 20:24:36 +03:00
TRBotChatDisplay Added an autoreconnect to WebSocket setting 2025-06-12 23:29:26 +03:00
.gitignore Ignore and removed more development files from git 2023-03-26 19:41:38 +03:00
LICENSE Initial commit 2022-08-14 17:21:25 +02:00
README.md Updated version and build instructions 2023-06-25 15:28:03 +03:00

README.md

TRBot Chat Display Logo TRBotChatDisplay

Custom chat display for TRBot.

Image of a chat example

TRBotChatDisplay reads incoming chat and input messages from TRBot and displays them on a separate window. This window can be added as a source for streaming software, such as OBS, to show the chat on a stream.

Features

  • Displays chat messages from TRBot, showing which services the messages were sent from (Ex. Terminal, Twitch, IRC)
  • Highlights messages that are valid inputs in a different text color
  • Highly configurable - change font, colors, spacing, and much more
  • Selectively show/hide messages from specific services
  • Send mock messages to the chat
  • Simple configuration file that can be saved and loaded

Setup

  1. TRBot needs to be running with the event dispatcher's WebSocket features enabled. Follow the steps at the top of this guide for how to do this: https://codeberg.org/kimimaru/TRBot/src/branch/master/Wiki/Event-Dispatcher.md
  2. In TRBotChatDisplay, enter the WebSocket URI that TRBot's event dispatcher is running under and click "Connect".
  3. If the button says "Disconnect", then it's connected to the WebSocket. If not, make sure the WebSocket URI is correct.
  4. While connected, you should see chat messages read from TRBot be displayed in the chat window.

Building

Prerequisites

  • Qt v5.15.8+ for Qt5 or 6.5 for Qt6 - both are supported
  • Qt WebSockets
  • qmake
  • gcc, clang, or another C++ compiler supporting C++11

Arch Linux

Qt5

sudo pacman -Sy gcc qt5-base qt5-websockets

Qt6

sudo pacman -Sy gcc qt6-base qt6-websockets

Other Platforms

Look for Qt5 and Qt6 libraries in your distribution's repositories. Alternatively, install the Qt version you wish to install through either the online installer or the offline installer.

Instructions

  1. Clone the repo with git clone https://codeberg.org/kimimaru/TRBotChatDisplay.git.
  2. cd TRBotChatDisplay/TRBotChatDisplay
  3. qmake TRBotChatDisplay.pro or for Qt6, qmake6 TRBotChatDisplay.pro
  4. make

The executable will be output in the same folder.

Contributing

The main repository is on Codeberg: https://codeberg.org/kimimaru/TRBotChatDisplay.git

Issues and pull requests are encouraged! Please file an issue if you encounter bugs or have a feature request.

License

Copyright © 2023 Thomas "Kimimaru" Deeb

AGPL

TRBotChatDisplay is free software; you are free to run, study, modify, and redistribute it. Specifically, you can modify and/or redistribute TRBotChatDisplay under the terms of the GNU Affero General Public License v3.0 or, at your option, a later version.

See the logo license file for the license of TRBotChatDisplay's logo.