Smartcraft-Media-Tech/chatrd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
fa450b66c701445b7b9274336b03a3ca8c5dba5c
chatrd/README.md
Rodrigo Emanuel fa450b66c7 Update README.md
2025-05-11 00:31:58 -03:00

9.4 KiB
Raw Blame History

💬 ChatRD

ChatRD is a chat overlay widget for OBS that unifies messages and events from Twitch, YouTube, TikTok, Kick (and more to come).

ChatRD Config UI

🚀 Features

  • 💬 Multi-platform chat
  • 💬 Multi-language events
  • 📊 Events and Live stats
  • 🎨 Customizable
  • 💾 Saves your settings using localStorage and Streamer.Bot's Global Varaibles

🛠️ Usage

Make sure your Twitch and YouTube accounts are connected on Streamer.Bot and you have TikFinity Desktop App installed and set up to your account on TikTok. BOTH APPS NEED TO RUN ON THE SAME PC.

Before you Begin: For Kick, you need to install Kick.Bot to your Streamer.Bot first before installing ChatRD. Click here for instructions on how to install Kick.Bot ... or follow the instructions below.

Streamer.Bot & TikFinity

  1. On Streamer.Bot, go to Server/Clients → WebSocket Server and make sure it is running
  2. Import the string inside the file streamerbot-import.vortisrd to your Streamer.Bot using the Import button at the top.
  3. Go to Server/Clients → WebSocket Client and make sure the TikFinity WebSocket is connected. If not, right-click on it and check Auto-Connect and Reconnect before clicking on Connect.
  4. Make sure TikFinity Desktop App is opened and connected to your TikTok Account.
  5. Open the Settings Page in your browser.
  6. Choose your desired options.
  7. Click "Copy URL".
  8. Add the copied URL as a Browser Source in OBS. Or use it in your browser to read chat. 😊

Kick.Bot installation on Streamer.Bot

  1. First, download Kick.Bot from Sehelitar's repo.
  2. Unzip and copy the DLLs from Kick.Bot to the dlls folder inside Streamer.Bot. If it's not there, create one (name it "dlls", lowercase).
  3. Import the action from action.txt file (inside the ZIP folder you just unzipped) to Streamer.Bot.
  4. Close Streamer.Bot and open it again. After a few seconds, a window will appear asking for you to login on Kick.
  5. Done! 😊

⚠️ KICK IS A BETA FEATURE!

Kick doesn't offer an API like Twitch does. It's not feasible for Streamer.Bot do it in an easy manner like Twitch, YouTube, Trovo, etc.

Kick.Bot does an excelent job but there is some information missing on the payload from Kick, like avatars, badges (gift sub, community, etc), viewership, etc. And there will be some errors or some misinformation being shown. I tried my best to emulate these but please, be patient!. 😊

Also, I couldn't test every single outcome because it's not possible to simulate the events besides Chat. I followed Kick.Bot's documentation and hoped for the best. 🙏

🛠️ How to Use it in a Local Network

  1. On Streamer.Bot, go to Server/Clients → WebSocket Server and make sure the Address is set to the Local Network IP from the PC, for example 192.168.0.10 ... or, if you prefer, use 0.0.0.0.
  2. On the Settings Page, make sure you set that IP on Streamer.Bot WebSocket Server.
  3. Turn the "Run Locally" switch on.
  4. Click "Copy URL"
  5. Download ChatRD on the machine you want to see the chat on or want to set up OBS in, unzipping the file.
  6. Open it on your browser or add it in OBS as Browser Source (don't tick Local File)following the file trail, for example: file:///C:/PATH_TO_THE_FILE/chat.html.
  7. After chat.html, paste the URL copied from the configurator. The full link should be like this: file:///C:/PATH_TO_THE_FILE/chat.html?language=ptbr&showPlatform=true&showAvatar=true&showTimestamps=false&showBadges=true&showPlatformStatistics=false&excludeCommands=true&showTwitchMessages=true&showTwitchFollows=true&showTwitchBits=true&showTwitchAnnouncements=true&showTwitchSubs=true&showTwitchGiftedSubs=true&showTwitchMassGiftedSubs=true&showTwitchGiftedSubsUserTrain=true&showTwitchRewardRedemptions=true&showTwitchRaids=true&showTwitchSharedChat=true&showTwitchViewers=true&showYouTubeMessages=true&showYouTubeSuperChats=true&showYouTubeSuperStickers=false&showYouTubeMemberships=true&showYouTubeGiftMemberships=true&showYouTubeMembershipsTrain=true&showYouTubeStatistics=true&showTikTokMessages=true&showTikTokFollows=true&showTikTokGifts=true&showTikTokSubs=true&showTikTokStatistics=true&showStreamlabsDonations=true&showStreamElementsTips=true&ignoreChatters=&streamerBotServerAddress=127.0.0.1&streamerBotServerPort=8080&=&hideAfter=0

🔊 How to set TTS with Speaker.Bot

Speaker.Bot Setup

  1. Go to Settings → WebSocket Server, click on Start Server. Make sure to also tick the Auto-Start checkbox.
  2. Go to Settings → Speech Engine and add the TTS Service of your preference. (Sapi5 is the Windows default).
  3. Go to Settings → Voice Aliases, name the voice SpeakerBot and click Add right next to it.
  4. In the Left Column, click on the SpeakerBot you just added and on the Speak! section, select the voice you want to use and click Add. (If you're using Sapi5, I recommend using Microsoft Zira Desktop as a voice).

Streamer.Bot Setup

  1. Import the streamerbot-import.vortisrd file to your Streamer.Bot. There's a new action that will handle the Speaker.Bot integration.
  2. Go to Integrations → Speaker.Bot, click on Connect. Make sure to also tick the Auto-Start and Auto-Connect checkboxes.

🧩 Integrations

  • 🟣 Twitch (via Streamer.Bot)
  • 🔴 YouTube (via Streamer.Bot)
  • ⚫ TikTok (via TikFinity Desktop App)
  • 💸 Streamlabs / StreamElements

📦 Dependencies

📝 To-Do List

  • Trovo
  • Kick
  • Patreon
  • Ko-Fi
  • TipeeeStream
  • Fourthwall
  • LivePix
  • Tipa.Ai

⚠️ DISCLAIMERS ⚠️

About YouTube Membership Emojis

I tried to add member emotes but that is currently impossible due to YouTube's API not exposing Members Emotes and with that, Streamer.Bot won't be able to show them.. So I've added a way for the users to add them manually at the overlay, with the data saved as a Streamer.Bot Global Variable.

What Casterlabs Caffeinated, Social Stream Ninja and Onecomme do to scrape the emotes won't work with the current way Streamer.Bot and my code works, so I had to choose between making the user add them manually or build a server-sided executable (using NodeJS, Python or whatever) to read the chat as it's going or scrape the HTML code. I don't want to add another executable on top of the user's flow, so it would be easier to use what it's currently available. And no, I won't do any research based on what other tools do. Tried to do that and wasted 1 week of my life doing it.

When YouTube decide to expose their Partner Emotes on their API, I'll come back to this.

About Speaker.Bot TTS Customization

If you want to customize what events the TTS reads, like "I want it to read sub notifications but I don't want it to read bits", it's possible. But doing that means adding an extra TTS switch for every single event for all platforms, making the setup page almost triplicate in size and bloat the code. I won't do that. I want to keep it simple and contained.

If you want to have TTS for events separately, I suggest you Disable TTS Events on ChatRD and setup Speaker.Bot with the things you want. 😊

About Custom Styling

The safest way to customize ChatRD is open either the Chat or the Config in your browser and use it's Dev Tools to look for the tags, their classes, identifiers and then style in the way you want. You need basic CSS knowledge for that.

After you finish it, paste the CSS inside the Custom CSS field within Browser Source Property Window.

About Support on Changing the Javascript or other Core Files

If you break it, you fix it. 😊

✨ Credits

Made with ❤️ by VortisRD

🔗 GitHub • Twitch • YouTube • TikTok • Twitter / X

Heavily inspired by Nutty

🔗 GitHub • Twitch • YouTube • TikTok • Twitter / X