项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 1589
技术标签
使用教程
环境要求
- Node.js 环境,npm 可正常执行(Node 端使用)
- Twitch 机器人账号及 OAuth 令牌(格式为 oauth: 开头)
- 需要连接的目标频道名称(如 my_channel)
- 浏览器端使用时需引入 tmi.min.js 脚本文件
安装与启动步骤
-
1安装 tmi.js
在项目目录下通过 npm 安装 tmi.js 依赖包,这是 Node 环境使用的第一步。
npm i tmi.js -
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监听并回复消息
监听 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浏览器中引入
浏览器环境直接引入 tmi.min.js,库会挂在 window 上的 tmi 上,用法与 Node 端一致。
<script src="/scripts/tmi.min.js"></script> -
5从源码自行构建
需要自定义构建时,克隆仓库后安装依赖并执行 build,产物可用于浏览器端。
git clone https://github.com/tmijs/tmi.js.git npm install npm run build -
6安装类型定义
TypeScript 项目可额外安装社区类型声明包,获得类型提示(作为开发依赖)。
npm i -D @types/tmi.js
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
identity.username | 是 | 机器人账号的 Twitch 用户名 | bot_name |
identity.password | 是 | 机器人账号的 OAuth 令牌,需带 oauth: 前缀 | oauth:my_bot_token |
channels | 是 | 要加入的频道数组,可填多个频道名 | [ 'my_channel' ] |
options.debug | 否 | 开启调试输出,便于排查连接问题 | { debug: true } |
如何确认成功
运行时若未打印 connect 相关报错即表示连接正常;在频道发送 !hello,机器人会回复 @用户名, heya!。
常见问题
Q:identity.password 应该填什么格式?
A:按 README 示例,需填入机器人账号的令牌并以 oauth: 开头,例如 oauth:my_bot_token,而不是账号密码。
Q:浏览器里怎么使用 tmi.js?
A:页面引入 tmi.min.js 后,库以 tmi 暴露在 window 上,直接使用 new tmi.Client({...}) 并调用 client.connect()。
Q:想自己构建浏览器版本怎么办?
A:先 git clone 仓库,再执行 npm install 和 npm run build,构建产物即可用于浏览器端引入。
Q:TypeScript 项目如何获得类型提示?
A:额外安装类型声明包 npm i -D @types/tmi.js,即可在 TypeScript 中获得类型定义。
注意事项
- README 示例中的 bot_name、oauth:my_bot_token、my_channel 均为示例值,需替换成自己的真实信息
- Node 端与浏览器端共用同一套 API,区别只在引入方式
- 浏览器脚本路径 /scripts/tmi.min.js 需按实际部署位置调整,或使用 Releases 页面提供的预构建版本
核心亮点
- API 简洁,事件驱动,上手快,文档清晰
- 自动处理连接和重连,稳定性好
- 支持浏览器和 Node.js,跨平台使用
不足之处
- 仅支持 Twitch 平台,不适用于其他聊天服务
- 文档/社区待观察
适用场景
- 构建 Twitch 聊天机器人(如自动回复、点歌)
- 开发直播互动游戏(如观众投票、抽奖)
- 分析聊天数据,进行舆情或热度统计
替代项目
irc-framework、node-irc、TwitchIO
上一篇:alan-sdk-ionic
下一篇:Risuai
同类项目推荐
semana-javascript-expert09
开源
在浏览器里离线跑智能聊天机器人,无需服务器
Criando um chatbot inteligente 100% offline e no navegador
Oxide-Lab
开源
本地跑大模型,聊天不花钱不泄密
Modern desktop application (Rust + Tauri v2 + Svelte 5 + Candle (HF)) for communicat···
openai-whisper-talk
开源
用 OpenAI 全家桶,快速搭一个能听会说的语音聊天机器人
openai-whisper-talk is a sample voice conversation application powered by OpenAI tec···
KoGPT2-chatbot
开源
用韩语GPT-2快速搭建一个能闲聊的机器人
Simple Chit-Chat based on KoGPT2
kobold_assistant
开源
本地跑通语音AI助手,离线对话不泄露隐私
Like ChatGPT's voice conversations with an AI, but entirely offline/private/trade-se···
On-Device-Speech-to-Speech-Conve···
开源
纯CPU跑通实时语音对话,支持随时打断,流畅聊AI
This is an on-CPU real-time conversational system for two-way speech communication w···
talkio
开源
把 GPT、Claude、Gemini 拉进一个群聊,对比答案超方便
Local-first multi-AI group chat desktop app — pull gpt, Claude, Gemini, DeepSeek in···
simplechat
开源
让团队安全地与文档、音视频对话,提升协作效率
Secure AI conversations with documents, video, audio, and more. Personal workspaces ···
copilot-unleashed
开源
把 GitHub Copilot 变成你自己的手机聊天站,多模型随时切换
A mobile first, self-hosted multi-model AI chat powered by the GitHub Copilot SDK. A···
