jeppevinkel/streamlogger

Versatile and extendable program made to handle streaming related data.

Usage

The program needs to be run once to generate procedural files, which include the config file.
After the initial boot of the program, it can be closed again to set the config.

The program needs to be restarted for any config changes to take place, and will automatically populate the config with any integrations or implementations added to the folders.

All integrations are disabled by default, and can be enabled as needed in the config file.

Integrations and implementations work functionally the same way, but the intention is to have a separation between data suppliers and data consumers. An implementation, such as the default Twitch implementation, will take data from an outside source, and send it through to the events in the program.
Integrations can then subscribe to the events, and use the supplied data to perform actions. This is intended to accomplish a unified framework that can be used to make tools that work accross multiple streaming platforms.

Events

ChatMessageEvent

public Dictionary<string, int> Badges;     // Badges associated to the user who sent the message.
public string Color;                       // A string representing a color value associated with message.
public string DisplayName;                 // The display name of the user who sent the message.
public List<Emote> Emotes;                 // List of emotes in the message.
public HashSet<string> Flags;              // Set of flags that can be defined by other implementations. An example is the default Twitch implementation sets a flag called `IsMe` when the message is sent with the `/me` command.
public bool Mod;                           // Boolean value indicating if the message was sent by a channel moderator.
public bool Subscriber;                    // Boolean value indicating if the message was sent by a subscriber.
public bool Broadcaster;                   // Boolean value indicating if the message was sent by the broadcaster.
public long Timestamp;                     // Unix timestamp in seconds using UTC.
public string UserType;                    // User type.
public string Username;                    // The username of the user who sent the message.
public string Channel;                     // The channel where the message was sent.
public string MessageContent;              // The actual message.

ChatMessageWithRewardEvent

public Dictionary<string, int> Badges;     // Badges associated to the user who sent the message.
public string Color;                       // A string representing a color value associated with message.
public string DisplayName;                 // The display name of the user who sent the message.
public List<Emote> Emotes;                 // List of emotes in the message.
public HashSet<string> Flags;              // Set of flags that can be defined by other implementations. An example is the default Twitch implementation sets a flag called `IsMe` when the message is sent with the `/me` command.
public bool Mod;                           // Boolean value indicating if the message was sent by a channel moderator.
public bool Subscriber;                    // Boolean value indicating if the message was sent by a subscriber.
public bool Broadcaster;                   // Boolean value indicating if the message was sent by the broadcaster.
public long Timestamp;                     // Unix timestamp in seconds using UTC.
public string UserType;                    // User type.
public string Username;                    // The username of the user who sent the message.
public string Channel;                     // The channel where the message was sent.
public string MessageContent;              // The actual message.
public string RewardId;                    // The ID of the reward associated with the message.

HostingStartedEvent

public string TargetChannel;               // The channel being hosted.
public string HostingChannel;              // The channel that's hosting.
public int Viewers;                        // The amount of viewers from the hosting channel.
public long Timestamp;                     // Unix timestamp in seconds using UTC.

HostingStoppedEvent

public string HostingChannel;              // The channel that was hosting.
public int Viewers;                        // The amount of viewers from the hosting channel.
public long Timestamp;                     // Unix timestamp in seconds using UTC.

HostNotificationEvent

public string TargetChannel;               // The channel being hosted.
public string HostingChannel;              // The channel that's hosting.
public bool IsAutoHost;                    // Boolean value indicating if the host was started automatically.
public int Viewers;                        // The amount of viewers from the hosting channel.
public long Timestamp;                     // Unix timestamp in seconds using UTC.

NewSubscriptionEvent

public Dictionary<string, int> Badges;     // Badges associated to the user.
public string Color;                       // A string representing a color value associated with the message or user.
public string DisplayName;                 // The display name of the user.
public List<Emote> Emotes;                 // List of emotes in the message.
public HashSet<string> Flags;              // Set of flags that can be defined by other implementations.
public bool Mod;                           // Boolean value indicating if the user is a channel moderator.
public bool Subscriber;                    // Boolean value indicating if the user is a subscriber.
public long Timestamp;                     // Unix timestamp in seconds using UTC.
public string UserType;                    // User type.
public string Username;                    // The username of the user who subscribed to the channel.
public string Channel;                     // The channel where the user subscribed.
public string MessageContent;              // The message supplied by the user.
public SubscriptionPlan SubscriptionPlan;  // Enum identifying the subscription plan.
public string SubscriptionPlanName;        // The name of the subscription plan.
public int CumulativeMonths;               // The total amount of months the user has been subscribed.
public bool ShouldShareStreak;             // Boolean value indicating whether the subscription streak should be shared.
public int StreakMonths;                   // The total amount of months in a row the user has been subscribed.
public string SystemMessage;               // A subscription message supplied by the event implementation.

ReSubscriptionEvent

public Dictionary<string, int> Badges;     // Badges associated to the user.
public string Color;                       // A string representing a color value associated with the message or user.
public string DisplayName;                 // The display name of the user.
public List<Emote> Emotes;                 // List of emotes in the message.
public HashSet<string> Flags;              // Set of flags that can be defined by other implementations.
public bool Mod;                           // Boolean value indicating if the user is a channel moderator.
public bool Subscriber;                    // Boolean value indicating if the user is a subscriber.
public long Timestamp;                     // Unix timestamp in seconds using UTC.
public string UserType;                    // User type.
public string Username;                    // The username of the user who subscribed to the channel.
public string Channel;                     // The channel where the user subscribed.
public string MessageContent;              // The message supplied by the user.
public SubscriptionPlan SubscriptionPlan;  // Enum identifying the subscription plan.
public string SubscriptionPlanName;        // The name of the subscription plan.
public int CumulativeMonths;               // The total amount of months the user has been subscribed.
public bool ShouldShareStreak;             // Boolean value indicating whether the subscription streak should be shared.
public int StreakMonths;                   // The total amount of months in a row the user has been subscribed.
public string SystemMessage;               // A subscription message supplied by the event implementation.

streamlogger's Issues

Channel tags in messages

1. Allow for your own channel to not have the tag, but all other tags do, like skip the tag for the first channel in the list.
2. Or only show the channel tag when there are more than one channel in the config.
3. Or just add a config value to turn it on and off manually.
4. OR ALL OF THE ABOVE!