TwitchLib 使用教程

TwitchLib 使用教程

TwitchLib C# Twitch Chat, Whisper, API and PubSub Library. Allows for chatting, whispering, stream event subscription and channel/account modification. Supports everything that supports .NETStandard 2.0 项目地址: https://gitcode.com/gh_mirrors/tw/TwitchLib

1. 项目目录结构及介绍

TwitchLib 是一个用于与 Twitch 平台交互的 .NET 类库。以下是项目的目录结构及其简单介绍：

TwitchLib/
├── TwitchLib.Api           # 包含与 Twitch API 交互的类和方法
├── TwitchLib.Client        # 包含与 Twitch 聊天和 Whisper 服务的交互类和方法
├── TwitchLib.EventSub.Websockets # 包含用于 Twitch EventSub 的 WebSocket 交互类
├── TwitchLib.Extension      # 包含用于 Twitch 扩展的后端服务类和方法
├── TwitchLib.PubSub        # 包含与 Twitch PubSub 服务的交互类和方法
├── TwitchLib.Unity          # Unity 项目中使用的 TwitchLib 封装
├── .gitattributes
├── .gitignore
├── .gitmodules
├── Code_Standards.md        # 代码标准文档
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目自述文件
├── TwitchLib.nuspec        # NuGet 包配置文件
├── TwitchLib.sln           # 解决方案文件
└── unity.md                # Unity 相关文档

2. 项目的启动文件介绍

项目的启动文件主要是 Program.cs，它是 C# 项目的入口点。以下是一个简单的示例，演示如何使用 TwitchLib 创建一个 Twitch 机器人：

using System;
using TwitchLib.Client;
using TwitchLib.Client.Enums;
using TwitchLib.Client.Events;
using TwitchLib.Client.Extensions;
using TwitchLib.Client.Models;

class Program
{
    static void Main(string[] args)
    {
        Bot bot = new Bot();
        Console.ReadLine(); // 保持程序运行
    }
}

class Bot
{
    TwitchClient client;

    public Bot()
    {
        // 初始化连接凭据和客户端选项
        ConnectionCredentials credentials = new ConnectionCredentials("twitch_username", "access_token");
        var clientOptions = new ClientOptions { MessagesAllowedInPeriod = 750, ThrottlingPeriod = TimeSpan.FromSeconds(30) };
        WebSocketClient customClient = new WebSocketClient(clientOptions);
        client = new TwitchClient(customClient);

        // 配置事件处理器
        client.Initialize(credentials, "channel");
        client.OnLog += Client_OnLog;
        client.OnConnected += Client_OnConnected;
        // ... 其他事件处理器

        // 连接到 Twitch
        client.Connect();
    }

    // 事件处理方法
    private void Client_OnLog(object sender, OnLogArgs e)
    {
        Console.WriteLine($"{e.DateTime.ToString()}: {e.BotUsername} - {e.Data}");
    }

    private void Client_OnConnected(object sender, OnConnectedArgs e)
    {
        Console.WriteLine($"Connected to {e.AutoJoinChannel}");
    }

    // ... 其他事件处理方法
}

3. 项目的配置文件介绍

项目的配置文件通常是指 .config 文件，例如 app.config 或 web.config，但在这个项目中，主要的配置是通过代码来完成的。在上述 Bot 类中，我们可以看到 ConnectionCredentials 类的实例化使用了 Twitch 用户名和访问令牌。这些凭据通常应该从配置文件或环境变量中读取，以保持安全性。

如果要使用配置文件，可以在 Program.cs 的 Main 方法中添加如下代码来读取配置：

// 读取配置文件中的凭据
string twitchUsername = ConfigurationManager.AppSettings["TwitchUsername"];
string accessToken = ConfigurationManager.AppSettings["AccessToken"];
string channelName = ConfigurationManager.AppSettings["ChannelName"];

// 使用读取的凭据初始化 Bot
Bot bot = new Bot(twitchUsername, accessToken, channelName);

确保在项目的 app.config 文件中添加以下配置：

<appSettings>
  <add key="TwitchUsername" value="your_twitch_username"/>
  <add key="AccessToken" value="your_access_token"/>
  <add key="ChannelName" value="your_channel_name"/>
</appSettings>

在实际部署时，应使用环境变量或安全的配置管理系统来替代硬编码的凭据。

TwitchLib C# Twitch Chat, Whisper, API and PubSub Library. Allows for chatting, whispering, stream event subscription and channel/account modification. Supports everything that supports .NETStandard 2.0 项目地址: https://gitcode.com/gh_mirrors/tw/TwitchLib