Unity Twitch Chat

This is a lightweight and efficient Twitch.tv IRC client for Unity.
The primary goal is to be able to read and send chat messages as efficiently as possible.

In short, this allows you to integrate Twitch Chat to your Unity projects.

Chat message example

Supported features

• Reading and sending chat messages
• Parsing Twitch emotes and badges
• Optional anonymous login
• Automatic ratelimit checks

Unsupported features

• Special messages (whispers, sub/resub, raids, first time viewers, etc)
• Bits cheering, channel points, predictions, etc
• Moderation (ban, timeout, etc)
• Third party extensions (FFZ, BTTV, 7TV, etc)
• and more...

Other limitations

• WebGL builds are not supported

Installation

• Open Unity Package Manager (Window -> Package Manager)
• Click the + button in the top left corner
• Select Add package from git URL...
• Copy and paste the following URL:
  

https://github.com/lexonegit/Unity-Twitch-Chat.git?path=/Unity-Twitch-Chat/Assets/Package

• Install by clicking Add

Quick start

1. Install the Unity package (see above)
2. Create a new empty GameObject and add the TwitchIRC component.
3. In the inspector, set your Twitch authentication details (OAuth, username, channel) You can generate an OAuth token at https://twitchapps.com/tmi/ OAuth and username are not needed if Use Anonymous Login is enabled.
4. Make sure Connect On Start is enabled and press play – You should now see JOIN messages, etc. in the console.
5. To start handling chat messages, add a listener to the IRC.OnMessageReceived event. The listener will receive Chatter objects which contain information about the chat message, such as the chatter name, message, emotes, etc...

Having issues? Check out the included ExampleProject for a better understanding.

Example project

Spawn chatters as jumping boxes. Box color is based on their primary badge.

API documentation

IRC.cs

• IRC.Connect() -> Connects to Twitch IRC
• IRC.Disconnect() - Disconnects from Twitch IRC
• IRC.SendChatMessage(string message) -> Sends a chat message to the channel
• IRC.Ping() -> Sends a PING message to the Twitch IRC server
• IRC.OnMessageReceived -> Event that is invoked when a chat message is received
• IRC.OnConnectionAlert -> Event that is invoked when a connection alert is received
• IRC.ClientUserTags -> The tags (badges, name color, etc) of the client user

Chatter.cs

• Chatter.GetNameColor() -> Returns the color of the chatter's name
• Chatter.IsDisplayNameFontSafe() -> Returns true if displayName is "font-safe" meaning that it only contains characters: a-z, A-Z, 0-9, _
• Chatter.ContainsEmote(string emoteId) -> Returns true if the chatter's message contains the specified emote (by id)
• Chatter.HasBadge(string badgeName) -> Returns true if the chatter has the specified badge

License

MIT License

Projects made with Unity Twitch Chat

Intro Fighters, stream overlay game https://lexone.itch.io/introfighters

Did you make something cool? Contact me (Lexone#3407) to get featured here!