Flutter TMI插件功能的探索与使用

Flutter TMI插件功能的探索与使用

tmi.dart简介

tmi.dart 是一个用于Twitch Messaging Interface (Twitch.tv) 的Dart库。它允许开发者通过Dart语言与Twitch聊天进行交互，监听和处理各种聊天事件。目前该项目仍在开发中，建议不要在生产环境中使用。

项目背景

该项目由Ricardo Markiewicz开发，灵感来源于Node.js中的TMI.js项目，后者是专门为Twitch聊天设计的Node.js包。

快速上手

要开始使用tmi.dart，首先需要安装依赖，创建客户端并开始监听聊天事件。以下是一个简单的示例代码：

import 'package:tmi/tmi.dart' as tmi;

void main() {
  // 创建一个TMI客户端，连接到指定的频道
  var client = tmi.Client(
    channels: "androidedelvalle",  // 指定要连接的Twitch频道
    secure: true,  // 使用安全连接
  );

  // 连接到Twitch服务器
  client.connect();

  // 监听消息事件
  client.on("message", (channel, userstate, message, self) {
    if (self) return;  // 如果是自己发送的消息，忽略

    // 打印接收到的消息
    print("${channel}| ${userstate['display-name']}: ${message}");
  });

  // 监听用户加入事件
  client.on("join", (channel, username, self) {
    if (!self) {
      print("${channel}> ${username} 加入了房间");
    }
  });

  // 监听突袭事件
  client.on("raided", (channel, username, viewers, userstate) {
    print("${channel}> === 突袭 === ${viewers} 来自 ${username}");
  });

  // 监听续订订阅事件
  client.on("resub", (channel, username, streakMonths, msg, userstate, methods) {
    print("${channel}> CAPO $username 续订了 $streakMonths 个月!: $msg");
  });

  // 监听新订阅事件
  client.on("subscription", (channel, username, methods, msg, userstate) {
    print("${channel}>>> 新订阅: $username");
  });

  // 监听房间状态变化事件
  client.on("roomstate", (channel, tags) {
    print("${channel} JOINING $tags");
  });

  // 监听PONG事件（心跳响应）
  client.on("pong", (latency) {
    print("PONG 延迟: $latency");
  });

  // 监听通知事件
  client.on("notice", (channel, msgid, message) {
    print("~~~~ $msgid ----> $message");
  });
}

当前支持的事件

tmi.dart 目前支持以下事件（未来可能会添加更多事件）：

• connecting：正在连接到Twitch服务器
• logon：成功登录
• ping：收到PING请求
• pong：收到PONG响应
• connected：成功连接到指定频道
• resub：用户续订订阅
• subanniversary：订阅周年纪念
• subscription：新用户订阅
• subgift：用户赠送订阅
• anonsubgift：匿名用户赠送订阅
• submysterygift：神秘礼物订阅
• anonsubmysterygift：匿名神秘礼物订阅
• primepaidupgrade：Prime订阅升级
• giftpaidupgrade：赠送订阅升级
• anongiftpaidupgrade：匿名赠送订阅升级
• raided：频道被突袭
• unhost：取消托管
• hosting：正在托管其他频道
• messagedeleted：消息被删除
• roomstate：房间状态变化
• names：获取房间内的用户列表
• join：用户加入房间
• part：用户离开房间
• whisper：私信
• message：普通聊天消息
• hosted：频道被其他频道托管
• cheer：用户发送Bits
• action：用户发送动作消息
• chat：通用聊天事件
• raw_message：原始消息

示例Demo

为了帮助你更好地理解如何使用tmi.dart，以下是一个完整的示例demo，展示了如何连接到Twitch频道并处理多种事件：

import 'package:tmi/tmi.dart' as tmi;

void main() {
  // 创建TMI客户端，连接到指定的Twitch频道
  var client = tmi.Client(
    channels: ["duendepablo"],  // 可以指定多个频道
    secure: true,  // 使用安全连接
  );

  // 连接到Twitch服务器
  client.connect();

  // 监听消息事件
  client.on("message", (channel, userstate, message, self) {
    if (self) return;  // 如果是自己发送的消息，忽略

    // 打印接收到的消息
    print("${channel}| ${userstate['display-name']}: ${message}");
  });

  // 监听用户加入事件
  client.on("join", (channel, username, self) {
    if (!self) {
      print("${channel}> ${username} 加入了房间");
    }
  });

  // 监听突袭事件
  client.on("raided", (channel, username, viewers, userstate) {
    print("${channel}> === 突袭 === ${viewers} 来自 ${username}");
  });

  // 监听续订订阅事件
  client.on("resub", (channel, username, streakMonths, msg, userstate, methods) {
    print("${channel}> CAPO $username 续订了 $streakMonths 个月!: $msg");
  });

  // 监听新订阅事件
  client.on("subscription", (channel, username, methods, msg, userstate) {
    print("${channel}>>> 新订阅: $username");
  });

  // 监听房间状态变化事件
  client.on("roomstate", (channel, tags) {
    print("${channel} JOINING $tags");
  });

  // 监听PONG事件（心跳响应）
  client.on("pong", (latency) {
    print("PONG 延迟: $latency");
  });

  // 监听通知事件
  client.on("notice", (channel, msgid, message) {
    print("~~~~ $msgid ----> $message");
  });

  // 监听用户离开事件
  client.on("part", (channel, username, self) {
    if (!self) {
      print("${channel}> ${username} 离开了房间");
    }
  });

  // 监听私信事件
  client.on("whisper", (from, to, message) {
    print("私信来自 ${from}: ${message}");
  });

  // 监听Cheer事件（用户发送Bits）
  client.on("cheer", (channel, userstate, message) {
    print("${channel}> ${userstate['display-name']} 发送了 ${userstate['bits']} Bits: ${message}");
  });

  // 监听动作消息事件
  client.on("action", (channel, userstate, message) {
    print("${channel}> *${userstate['display-name']}* ${message}");
  });
}