About

TwitchLib is a powerful C# library that allows for interaction with various Twitch services like chat, whispers, API, and PubSub event system. Below are the descriptions of the core components that make up TwitchLib.

• TwitchClient: Handles chat and whisper Twitch services. Complete witha suite of events that fire for virtually every piece of data received from Twitch.
• TwitchApi: With complete V3 and increasing coverage of V5 endpoints, TwitchApi is a static class that allows for modifying of virtually all Twitch account properties and fetching of Twitch data.
• TwitchPubSub: Covers the relatively new Twitch PubSub event system. Currently both topics Twitch supports are supported via this static class.

Features

• TwitchClient:
  • Handles chat interactions and functionality.
  • Events for channel being hosted, chat being cleared, moderators/users entering/leaving chat, etc.
  • Reply to/send chat messages and whispers.
  • Native support for commands and customizable command identifiers (default is "!")
  • Ability to timeout/ban/unban users, change username color, clear chat, play commercials (for partnered streams), turn on emote/follower/sub only mode, and retrive list of moderators/followers.
  • Message throttling handling.
• Services:
  • FollowerService: Service for detection of new followers.
  • LiveStreamMonitor: Service for detecting when a channel goes online/offline
• TwitchApi:
  • Retrieve uptime/current status of stream, posts in channel feed, etc.
  • Retrieve followed channels/check is particular user is a follower or not
  • Search games by viewcount, name, etc.
  • Update stream title/current game
  • Reset stream key, set stream delay
  • Follow/unfollow channels
  • (Partnerd streams only) Retrieve subscriber count/list
  • (Partnered streams) Run commercials
  • Create/moderate/update/search for communities
• TwitchPubSub:
  • Chat interactions through Twitch's PubSub system

Implementing

Below are basic examples of how to utilize each of the core components of TwitchLib. These are C# examples, but this library can also be used in Visual Basic.

TwitchClient

using TwitchLib;
using TwitchLib.Models.Client;
using TwitchLib.Events.Client;

TwitchClient client;
ConnectionCredentials credentials = new ConnectionCredentials("twitch_username", "access_token");

client = new TwitchClient(credentials, "channel_to_join");
client.OnJoinedChannel += onJoinedChannel;
client.OnMessageReceived += onMessageReceived;
client.OnWhisperReceived += onWhisperReceived;
client.OnNewSubscriber += onNewSubscriber;

client.Connect();

private void onJoinedChannel(object sender, OnJoinedChannelArgs e) {
	client.SendMessage("Hey guys! I am a bot connected via TwitchLib!");
}
private void onMessageReceived(object sender, OnMessageReceivedArgs e) {
	if(e.ChatMessage.Message.Contains("badword"))
    	client.TimeoutUser(e.ChatMessage.Username, TimeSpan.FromMinutes(30), "Bad word! 30 minute timeout!");
}
private void onCommandReceived(object sender, OnWhisperCommandReceivedArgs e) {
	if(e.Command == "help")
    	client.SendMessage($"Hi there {e.ChatMessage.Username}! You can view all commands using !command");
}
private void onWhisperReceived(object sender, OnWhisperReceivedArgs e) {
	if(e.WhisperMessage.Username == "my_friend")
    	client.SendWhisper(e.WhisperMessage.Username, "Hey! Whispers are so cool!!");
}
private void onNewSubscriber(object sender, OnNewSubscriberArgs e) {
	if(e.Subscriber.IsTwitchPrime)
		client.SendMessage($"Welcome {} to the substers! You just earned 500 points! So kind of you to use your Twitch Prime on this channel!");
    else
    	client.SendMessage($"Welcome {} to the substers! You just earned 500 points!");
}

For a complete list of TwitchClient events and calls, click here

TwitchApi

Note: All calls below are synchronous, but TwitchApi supports both synchronous and asynchronous. To access asynch calls, simply append Async. For example, ChannelHasUserSubscribedAsync.

using TwitchLib;
using TwitchLib.Models.API;

TwitchApi.SetClientId("my_client_id");
TwitchApi.SetAccessToken("channel_access_token");

bool isSubbed = TwitchApi.Subscriptions.ChannelHasUserSubscribed("user", "channel");
List<Subscription> allSubs = TwitchApi.Subscriptions.GetChannelSubscribers("channel");

List<Follow> follows = TwitchApi.Follows.GetFollowedUsers("channel");
Follow resp = TwitchApi.Follows.FollowChannel("user", "channel");

bool isStreaming = TwitchApi.Streams.BroadcasterOnline("channel");
Channel resp = TwitchApi.Streams.UpdateStreamTitleAndGame("new status", "new game", "channel");

List<User> editors = TwitchApi.Channels.GetChannelEditors("channel");
PostToChannelFeedResponse resp  =TwitchApi.Channels.PostToChannelFeed("This is a new feed post.", true, "channel");

Clip clip = TwitchApi.Clips.GetClipInformation("channel", "ChannelSlugHere");
List<Clip> topClips = TwitchApi.Clips.GetTopClips().Clips;

string communityId = TwitchApi.Communities.CreateCommunity("community_name", "community summary", "community description", "community rules");
TwitchApi.Communities.BanCommunityMember("community_id", "user_id");

For a complete list of TwitchApi calls, click here

TwitchPubSub

using TwitchLib;

TwitchPubSub pubsub = new TwitchPubSub();
pubsub.OnPubSubServiceConnected += onPubSubConnected;
pubsub.OnListResponse += onPubSubResponse;
pubsub.OnBitsReceived += onPubSubBitsReceived;

pubsub.Connect();

private void onPubSubConnected(object sender, object e) {
	// MY ACCOUNT ID, MY OAUTH
    pubsub.ListenToWhispers(0, "oauth_token");
}
private void onPubSubResponse(object sender, OnListenResponseArgs e) {
	if (e.Successful)
    	MessageBox.Show($"Successfully verified listening to topic: {e.Topic}");
    else
        MessageBox.Show($"Failed to listen! Error: {e.Response.Error}");	
}
private void onPubSubBitsReceived() {
	MessageBox.Show($"Just received {e.BitsUsed} bits from {e.Username}. That brings their total to {e.TotalBitsUsed} bits!");
}

For a complete list of TwitchPubSub functionality, click here

Examples, Applications, and Community Work

• TwitchLibExample - Included in this repo is an example application that demos almost all of the library's functionality.
• Bacon_Donut VOD on building a Twitch bot using TwitchLib: twitch.tv/videos/115788601
• Prom3theu5's Conan Exiles Dedicated Server Updater / Service - Steam Github
• Von Jan Suchotzki's German Video Tutorial Series - His Website Youtube
• DHSean's TwitchAutomator Reddit Github
• PFCKrutonium's TwitchieBot - This project implements the bot using VisualBasic.
• Moerty's Avia Bot, a fully featured bot that is a good example of a built out bot: https://github.com/Moerty/AivaBot

Installation

NuGet

To install this library via NuGet via NuGet console, use:

Install-Package TwitchLib

and via Package Manager, simply search:

TwitchLib

You are also more than welcome to clone/fork this repo and build the library yourself!

Dependencies

• Newtonsoft.Json 7.0.1+ (nuget link)
• WebSocketSharp-NonPreRelease (nuget link)

Contributors

• Cole (@swiftyspiffy)
• SkyHuk (@SkyHukTV)
• Nadermane (@Nadermane)
• BenWoodford (BenWoodford)
• igor523 (igor523)
• jxlarrea (jxlarrea)
• GlitchHound (GlitchHound)
• PFCKrutonium (PFCKrutonium)
• toffaste1337(toffaste1337)
• Mr_Examed (Mr_Examed)
• XuluniX (XuluniX)
• prom3theu5 (@prom3theu5)
• Ethan Lu (elu00)

License

This project is available under the MIT license. See the LICENSE file for more info.