Zehs.TwitchChatAPI 2.0.0

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.

<ins>Who needs this mod installed for it to work?</ins> Only you!

API Usage

<details><summary>Click to Expand</summary>

<br>

Reference TwitchChatAPI in your project's .csproj file.

Add TwitchChatAPI as a dependency to your plugin class.

[BepInDependency(TwitchChatAPI.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]

[BepInPlugin("You.YourMod", "YourMod", "1.0.0")]
[BepInDependency(TwitchChatAPI.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
public class YourMod : BaseUnityPlugin
{
    // ...
}

API

https://github.com/ZehsTeam/TwitchChatAPI/blob/main/TwitchChatAPI/API.cs

namespace TwitchChatAPI;

public static class API
{
    public static string Channel { get; }

    public static ConnectionState ConnectionState { get; }
    public static event Action<ConnectionState> OnConnectionStateChanged;

    public static event Action OnConnect;
    public static event Action OnDisconnect;
    public static event Action<TwitchMessage> OnMessage;
    public static event Action<TwitchCheerEvent> OnCheer;
    public static event Action<TwitchSubEvent> OnSub;
    public static event Action<TwitchRaidEvent> OnRaid;
    public static event Action<TwitchRoomState> OnRoomStateUpdate;

    public static IReadOnlyCollection<TwitchUser> Users { get; }

    public static void Connect();
    public static void Connect(string channel);

    public static void Disconnect();    

    public static bool TryGetUserByUsername(string username, out TwitchUser twitchUser);
    public static bool TryGetUserByUserId(string userId, out TwitchUser twitchUser);
    public static TwitchUser[] GetUsersSeenWithin(TimeSpan timeSpan);
}

TwitchUser

https://github.com/ZehsTeam/TwitchChatAPI/blob/main/TwitchChatAPI/Objects/TwitchUser.cs

TwitchMessage

https://github.com/ZehsTeam/TwitchChatAPI/blob/main/TwitchChatAPI/Objects/TwitchMessage.cs

TwitchEvents (Cheer, Sub, Raid)

https://github.com/ZehsTeam/TwitchChatAPI/blob/main/TwitchChatAPI/Objects/TwitchEvents.cs

Example

using TwitchChatAPI;
using TwitchChatAPI.Enums;
using TwitchChatAPI.Objects;
using UnityEngine;

public class TwitchChatExample : MonoBehaviour
{
    private void OnEnable()
    {
        // Subscribe to Twitch events
        API.OnMessage += HandleMessage;
        API.OnCheer += HandleCheer;
        API.OnSub += HandleSub;
        API.OnRaid += HandleRaid;
    }

    private void OnDisable()
    {
        // Unsubscribe to avoid memory leaks
        API.OnMessage -= HandleMessage;
        API.OnCheer -= HandleCheer;
        API.OnSub -= HandleSub;
        API.OnRaid -= HandleRaid;
    }

    private void HandleMessage(TwitchMessage message)
    {
        Debug.Log($"[{message.User.DisplayName}]: {message.Message}");
    }

    private void HandleCheer(TwitchCheerEvent cheer)
    {
        Debug.Log($"{cheer.User.DisplayName} cheered {cheer.CheerAmount} bits!");
    }

    private void HandleSub(TwitchSubEvent sub)
    {
        //...
    }

    private void HandleRaid(TwitchRaidEvent raid)
    {
        Debug.Log($"Raid incoming! {raid.User.DisplayName} is raiding with {raid.ViewerCount} viewers!");
    }
}

</details>

Developer Contact

Report bugs, suggest features, or provide feedback:

• GitHub Issues Page: TwitchChatAPI
• My Links: https://solo.to/crithaxxog

<img src="https://i.imgur.com/duJZQTS.png" width="200px">