ZetaArcade-SimpleTwitchChat icon

SimpleTwitchChat

[v73] See your Twitch chat inside the in-game chat!

Last updated 2 hours ago
Total downloads 136
Total rating 0 
Categories Mods Tools Misc BepInEx Client-side Tweaks & Quality Of Life
Dependency string ZetaArcade-SimpleTwitchChat-0.0.4
Dependants 1 other package depends on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2305 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2305
Zehs-TwitchChatAPI-2.0.0 icon
Zehs-TwitchChatAPI

Add Twitch chat integration to your Unity game mods! Subscribe to events like Messages, Cheers, Subs, and Raids. No Twitch authentication or connections required.

Preferred version: 2.0.0
Sigurd-CSync-5.0.1 icon
Sigurd-CSync

Configuration file syncing library for BepInEx.

Preferred version: 5.0.1
xilophor-LethalNetworkAPI-3.3.2 icon
xilophor-LethalNetworkAPI

A library/API to allow developers to easily add networking to their mods.

Preferred version: 3.3.2

README

Simple Twitch Chat

This mod lets you see your Twitch chat inside the in-game text chat! Currently, the mod should work fine clientside. If not, each client may need it to play.
This mod was built for v73 of Lethal, and whilst I haven't tested it in v80, it might work on that version too, though there is a good chance it will be locked to 73+ only until i update everything.

Simple-Twitch-Chat.gif

Current Features!

  • See your Twitch chat in-game!! They showup in your text chat!
  • Option to network your chat to the entire server, so your whole lobby can see the messages too! (Requires all clients to have the mod!)
  • Cooldown/queue system on messages, to improve stability for VERY large streams with lots of messages coming in at once!
  • Customise how chat is displayed, such as the color for the chat/name, whether to prefix it with [TTV] or whatever you want instead etc.
  • Highlighted chat messages will show as a popup instead of a normal chat message, with a customisable duration and an option to turn it off!
  • Options to hide chat messages from Bots, the Broadcaster themselves, Moderators, and restrict it to sub-only mode!
  • Blacklist option to ignore chat messages from Blacklisted users. You can use "StreamWeasels" to get the user-ID from a Twitch Username for this.
  • Whitelist option for the Blacklist, to instead only make specified users able to send their messages through!
  • Debug mode to gather some useful info, such as user-IDs and Redeem IDs!
  • A very basic Redeem system, that other mods can hook into if they want to do stuff in game based on what Redeems people use!
  • Should be fully clientsided, though Redeem-related mods that depend on it are likely not!

Setup

  • Install the mod, boot up, and a config will generate!
  • TwitchChatAPI handles connecting your account to Twitch, so if you have any issues regarding that then check out their mod page, but it should be as simple as clicking the Twitch icon on the main menu (You may also need TwitchChatAPI LethalCompany for it show???)
  • You can test if chat is working without Broadcasting on Twitch, as chat messages will still come through from an offline channel. Simply send messages into your offline channel chat to see them come through!
  • You can enable "Print debug info" and "Print redeem info" in the config to get a bunch of useful data on incoming messages, such as the User-IDs (Which you can then use for the Whitelist/Blacklist). This can be especially useful if you use any chatbots that don't get flagged by the "Hide clankers" option, since all that is doing is looking for the Bot badge on the messages.

Redeem Setup

  • You can get User-ID's using this webtool by StreamWeasels, or from turning on the "print redeem info" debug options and general debug options.
  • For setting up Redeems, make sure your Twitch Redeem messages allow the user to send a message, as Redeems without a message do not get picked up by this mod.
  • To hook the Redeems up, use the debug settings to get the Redeem IDs (By using the Redeems as the Channel owner since you'll have infinite channel points to use them as much as you want), copy the IDs, and then paste them into the mod config for the Redeem-Mod.

Making your own Redeem Mod

  • Using SimpleTwitchChat as a dep, you are listening for the OnRedeem method being called, which incluides all the info you need about the Redeem message in it's params.
  • You can also use the NewRedeemMessage to trigger HUD alerts whenever a Redeem is used.
  • See my mod ZetasTwitchRedeems as an example!

Compat

  • Works fine with NiceChat!! c:

Disclaimers

  • This mod lacks any kind of failsafes for what kind of crap is put in your Twitch chat. If you don't have sufficient moderation/anti-spam related measures on your Twitch chat, whatever messages will get sent through to the in-game chat (Which can be problematic, as you can't just "delete" such chat messages from the in-game chat, they'll be there until you send more to make it scroll up.). However, this mod does come with a Blacklist/Whitelist option, as well as options for making it Sub-only, blacklisting bots etc. which could help prevent issues.

Credits

  • Zehs / For creating TwitchChatAPI
  • alterego / His streams use a private mod with very similar functionality that I based mine off of visually. However, due to that mod being private, I coded this entirely independently, without any copied code (I literally don't have access to the code to copy lol). Check out his streams!!!