WolfwithSword.PicartoEventsLib 0.1.1

PicartoEventsLib

Unofficial library for Picarto Alert Events and Chat Messages

This unofficial library is intended for developing applications, overlays, and more interaction for content creators on Picarto.

As it remains unofficial, using the same websockets and public APIs are Picarto's existing overlays and chat widgets use, it is subject to change at any moment.

To see an example project where it is use, see SubathonManager

Features

• Real Time Chat Messages
• Real Time Alerts for Tips, Subscriptions, and Follows
• No API Keys needed, all you need is a channel name
• Manually instanced or via DependencyInjection for both chat and events clients.

Install

To install the core package, run

dotnet add package WolfwithSword.PicartoEventsLib

Examples

See Program.cs for a DependencyInjection approach, otherwise each object can be manually instantiated.

First, build your options

services.Configure<PicartoClientOptions>(opt =>
{
    opt.Channel = "PICARTO_USER"; 
});

// fetch for manual use later if desired
var optionsWrapper = provider.GetRequiredService<Microsoft.Extensions.Options.IOptions<PicartoClientOptions>>();
var options = optionsWrapper.Value;

////////
// OR //
////////

PicartoClientOptions opts = new PicartoClientOptions();
opts.Channel = "PICARTO_USER";

// Then init the options to fetch your token

await opts.InitAsync();

Then, create your client(s)

services.AddLogging(cfg =>
{
    cfg.AddSimpleConsole(opt =>
    {
        opt.SingleLine = true;
        opt.TimestampFormat = "[HH:mm:ss] ";
    });
    cfg.SetMinimumLevel(LogLevel.Debug);
});

services.AddSingleton<PicartoEventsClient>();
services.AddSingleton<PicartoChatClient>();
...
    
var eventsClient = provider.GetRequiredService<PicartoEventsClient>();
var chatClient = provider.GetRequiredService<PicartoChatClient>();

// init options

await eventsClient.ConnectAsync();
await chatClient.ConnectAsync();

//////////////////////////
// OR Instance manually //
//////////////////////////

PicartoClientOptions opts = new PicartoClientOptions();
opts.Channel = "PICARTO_USER";

await opts.InitAsync();

// loggers instanced elsewhere or partial DI'd
_eventClient = new PicartoEventsClient(opts, _clientLogger);
_chatClient = new PicartoChatClient(opts, _chatLogger);

await _eventClient.ConnectAsync();
await _chatClient.ConnectAsync();

Subscribe to events

eventsClient.Connected += (_, args) => logger.LogInformation("EventsClient connected!");
eventsClient.Disconnected += (_, args) => logger.LogInformation("EventsClient disconnected!");
eventsClient.AlertReceived += (_, alert) =>
{
    logger.LogInformation("Alert received: {Alert}", alert);
};
// Alert is either PicartoFollow, PicartoSubscription, PicartoTip

chatClient.Connected += (_, args) => logger.LogInformation("ChatClient connected!");
chatClient.Disconnected += (_, args) => logger.LogInformation("ChatClient disconnected!");
chatClient.MessageReceived += (_, msg) =>
{
    logger.LogInformation("Chat Msg received: {Msg}: {Message}", msg, msg.Message);
};