tmi.js

环境要求

• Node.js 环境，npm 可正常执行（Node 端使用）
• Twitch 机器人账号及 OAuth 令牌（格式为 oauth: 开头）
• 需要连接的目标频道名称（如 my_channel）
• 浏览器端使用时需引入 tmi.min.js 脚本文件

安装与启动步骤

1. 1安装 tmi.js

   在项目目录下通过 npm 安装 tmi.js 依赖包，这是 Node 环境使用的第一步。

   npm i tmi.js

   复制

2. 2创建并连接客户端

   引入 tmi.js，用 identity 填机器人账号和令牌，channels 填要加入的频道，再调用 connect 连接。

   const tmi = require('tmi.js');
   const client = new tmi.Client({
       options: { debug: true },
       identity: {
           username: 'bot_name',
           password: 'oauth:my_bot_token'
       },
       channels: [ 'my_channel' ]
   });
   client.connect().catch(console.error);

   复制

3. 3监听并回复消息

   监听 message 事件，示例中收到 !hello 时向该频道回复 @用户名, heya!，self 用于过滤自己发的消息。

   client.on('message', (channel, tags, message, self) => {
       if(self) return;
       if(message.toLowerCase() === '!hello') {
           client.say(channel, `@${tags.username}, heya!`);
       }
   });

   复制

4. 4浏览器中引入

   浏览器环境直接引入 tmi.min.js，库会挂在 window 上的 tmi 上，用法与 Node 端一致。

   复制

5. 5从源码自行构建

   需要自定义构建时，克隆仓库后安装依赖并执行 build，产物可用于浏览器端。

   git clone https://github.com/tmijs/tmi.js.git
   npm install
   npm run build

   复制

6. 6安装类型定义

   TypeScript 项目可额外安装社区类型声明包，获得类型提示（作为开发依赖）。

   npm i -D @types/tmi.js

   复制

关键配置

如何确认成功

运行时若未打印 connect 相关报错即表示连接正常；在频道发送 !hello，机器人会回复 @用户名, heya!。

常见问题

注意事项

• README 示例中的 bot_name、oauth:my_bot_token、my_channel 均为示例值，需替换成自己的真实信息
• Node 端与浏览器端共用同一套 API，区别只在引入方式
• 浏览器脚本路径 /scripts/tmi.min.js 需按实际部署位置调整，或使用 Releases 页面提供的预构建版本