VodOnDemand.TwitchEverywhere.Irc 0.8.0

TwitchEverywhere.Irc

TwitchEverywhere.Irc is a .NET library that allows connecting to a Twitch chat using IRC and subscribing to messages in that chat.

The goal of this library is to provide a lightweight, strongly typed API for clients so they can avoid parsing raw strings as much as possible. TwitchEverywhere.Irc uses Rx.NET to provide a reactive API for handling messages from Twitch.

The library will support the latest LTS version of .NET and non LTS versions IF it is newer than the LTS version. So for example before .NET 8, the library supported .NET 6 (LTS) and 7 but once .NET 8 was released support for 6 and 7 was dropped.

• How To Use It
• Sample CLI App
• Performance
• Supported Functionality
  • IRC Commands
    • CLEARCHAT
    • CLEARMSG
    • GLOBALUSERSTATE
    • HOSTTARGET
    • NOTICE
    • RECONNECT
    • ROOMSTATE
    • USERNOTICE
    • USERSTATE
    • WHISPER
  • IRC Membership
    • JOIN
    • PART
  • IRC Tags
    • PRIVMSG Tags
    • CLEARCHAT Tags
    • CLEARMSG Tags
    • GLOBALUSERSTATE Tags
    • NOTICE Tags
    • ROOMSTATE Tags
    • USERNOTICE Tags
    • USERSTATE Tags
    • WHISPER Tags

How To Use It

You will need to provide the following values as parameters to the TwitchEverywhere.Core.TwitchConnectionOptions record:

TwitchConnectionOptions options = new(
    Channel: channel,
    AccessToken: accessToken,
    RefreshToken: refreshToken,
    ClientId: clientId,
    ClientSecret: clientSecret,
    ClientName: clientName
);

Next create an instance of the IrcClient and pass in the options to the constructor.

internal class TwitchConnection(
    TwitchConnectionOptions options
) {
    private readonly IrcClient m_ircClient = new( options );
    
    // implementation
}

Then define a method that will consume the observables returned from TwitchEverywhere. Each message type has its own observable that you can subscribe to and it will return a strong type.

// This example only handles MessageType.PrivMsg but you can handle other types here too
public async Task ConnectToIrcClientRx() {
    
    // TaskCompletionSource is only needed for the CLI app to prevent it from exiting early
    TaskCompletionSource<bool> tcs = new();

    IrcClientObservable observable = m_ircClient.ConnectToChannelRx();

    IDisposable privObservable = observable.PrivMsgObservable.Subscribe( 
        msg => PrivMessageCallback(msg)
    );

    try {
        await tcs.Task;
    } finally{
        joinObservable.Dispose();
        privObservable.Dispose();
    }
}

Now whenever TwitchEverywhere receives a message it will pass it to the appropriate observable 🎉

Sample CLI App

There is a sample CLI application here that is included as an example in this repo and you can use it to connect with Twitch – give it a try!

In order to connect you need to create an appsettings.json file in the root of the TwitchEverywhereCLI project with the following parameters:

{
  "AccessToken": "your_twitch_access_token",
  "RefreshToken": "your_twitch_refresh_token",
  "ClientId": "your_client_id",
  "ClientSecret": "your_client_secret",
  "ClientName": "your_client_name_all_lowercase",
  "Channel": "channel_you_want_to_connect_to"
}

Performance

See the README in the TwitchEverywhere.Benchmark project here

Supported Functionality

IRC Commands

See the related Twitch documentation here

CLEARCHAT

See CLEARCHAT tags

CLEARMSG

See CLEARMSG tags

GLOBALUSERSTATE

See GLOBALUSERSTATE tags

HOSTTARGET

NOTICE

See NOTICE tags

RECONNECT

No fields for RECONNECT, use the presence of this message as a signal to reconnect to Twitch. See the Twitch API docs for more infomation.

ROOMSTATE

See ROOMSTATE tags

USERNOTICE

See USERNOTICE tags

USERSTATE

See USERSTATE tags

WHISPER

See WHISPER tags

IRC Membership

See the related Twitch documentation here.

JOIN

PART

IRC Tags

See the related Twitch documentation here.

PRIVMSG Tags

CLEARCHAT Tags

CLEARMSG Tags

GLOBALUSERSTATE Tags

NOTICE Tags

ROOMSTATE Tags

USERNOTICE Tags

USERSTATE Tags

WHISPER Tags