mirror of
https://github.com/farcasclaudiu/openclaw.git
synced 2026-06-29 09:02:02 +03:00
Docs: update zh-CN translations and pipeline
What: - update zh-CN glossary, TM, and translator prompt - regenerate zh-CN docs and apply targeted fixes - add zh-CN AGENTS pipeline guidance Why: - address terminology/spacing feedback from #6995 Tests: - pnpm build && pnpm check && pnpm test
This commit is contained in:
@@ -1,32 +1,32 @@
|
||||
---
|
||||
read_when:
|
||||
- 为 OpenClaw 设置 Twitch 聊天集成
|
||||
summary: Twitch 聊天机器人配置与设置
|
||||
summary: Twitch 聊天机器人配置和设置
|
||||
title: Twitch
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T19:58:38Z"
|
||||
generated_at: "2026-02-03T07:44:41Z"
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: aa7d60444e7f7e5dd7d02ce21527089058e024b8f427aeedf9e200a2818eb007
|
||||
source_hash: 0dd1c05bef570470d8b82c1f6dee5337e8b76b57269c5cad6aee2e711483f8ba
|
||||
source_path: channels/twitch.md
|
||||
workflow: 14
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
# Twitch(插件)
|
||||
|
||||
通过 IRC 连接支持 Twitch 聊天。OpenClaw 以 Twitch 用户(机器人账号)身份连接,在频道中接收和发送消息。
|
||||
通过 IRC 连接支持 Twitch 聊天。OpenClaw 以 Twitch 用户(机器人账户)身份连接,在频道中接收和发送消息。
|
||||
|
||||
## 需要插件
|
||||
|
||||
Twitch 以插件形式提供,未包含在核心安装中。
|
||||
Twitch 作为插件发布,未与核心安装捆绑。
|
||||
|
||||
通过 CLI(npm 注册表)安装:
|
||||
通过 CLI 安装(npm 注册表):
|
||||
|
||||
```bash
|
||||
openclaw plugins install @openclaw/twitch
|
||||
```
|
||||
|
||||
本地签出(从 git 仓库运行时):
|
||||
本地检出(从 git 仓库运行时):
|
||||
|
||||
```bash
|
||||
openclaw plugins install ./extensions/twitch
|
||||
@@ -34,19 +34,19 @@ openclaw plugins install ./extensions/twitch
|
||||
|
||||
详情:[插件](/plugin)
|
||||
|
||||
## 快速设置(入门)
|
||||
## 快速设置(新手)
|
||||
|
||||
1. 为机器人创建一个专用 Twitch 账号(或使用现有账号)。
|
||||
1. 为机器人创建一个专用的 Twitch 账户(或使用现有账户)。
|
||||
2. 生成凭证:[Twitch Token Generator](https://twitchtokengenerator.com/)
|
||||
- 选择 **Bot Token**
|
||||
- 确认已勾选 `chat:read` 和 `chat:write` 权限范围
|
||||
- 确认已选择 `chat:read` 和 `chat:write` 权限范围
|
||||
- 复制 **Client ID** 和 **Access Token**
|
||||
3. 查找你的 Twitch 用户 ID:https://www.streamweasels.com/tools/convert-twitch-username-to-user-id/
|
||||
4. 配置令牌:
|
||||
- 环境变量:`OPENCLAW_TWITCH_ACCESS_TOKEN=...`(仅限默认账号)
|
||||
- 或配置文件:`channels.twitch.accessToken`
|
||||
- 如果两者都设置了,配置文件优先(环境变量回退仅适用于默认账号)。
|
||||
5. 启动 Gateway网关。
|
||||
- 环境变量:`OPENCLAW_TWITCH_ACCESS_TOKEN=...`(仅限默认账户)
|
||||
- 或配置:`channels.twitch.accessToken`
|
||||
- 如果两者都设置,配置优先(环境变量回退仅适用于默认账户)。
|
||||
5. 启动 Gateway 网关。
|
||||
|
||||
**⚠️ 重要:** 添加访问控制(`allowFrom` 或 `allowedRoles`)以防止未授权用户触发机器人。`requireMention` 默认为 `true`。
|
||||
|
||||
@@ -57,22 +57,22 @@ openclaw plugins install ./extensions/twitch
|
||||
channels: {
|
||||
twitch: {
|
||||
enabled: true,
|
||||
username: "openclaw", // 机器人的 Twitch 账号
|
||||
username: "openclaw", // 机器人的 Twitch 账户
|
||||
accessToken: "oauth:abc123...", // OAuth Access Token(或使用 OPENCLAW_TWITCH_ACCESS_TOKEN 环境变量)
|
||||
clientId: "xyz789...", // 从 Token Generator 获取的 Client ID
|
||||
channel: "vevisk", // 要加入的 Twitch 频道聊天室(必填)
|
||||
clientId: "xyz789...", // Token Generator 中的 Client ID
|
||||
channel: "vevisk", // 要加入的 Twitch 频道聊天(必填)
|
||||
allowFrom: ["123456789"], // (推荐)仅限你的 Twitch 用户 ID - 从 https://www.streamweasels.com/tools/convert-twitch-username-to-user-id/ 获取
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
## 工作原理
|
||||
## 它是什么
|
||||
|
||||
- 由 Gateway网关拥有的 Twitch 渠道。
|
||||
- 确定性路由:回复始终返回到 Twitch。
|
||||
- 每个账号映射到一个隔离的会话键 `agent:<agentId>:twitch:<accountName>`。
|
||||
- `username` 是机器人的账号(用于认证),`channel` 是要加入的聊天室。
|
||||
- 由 Gateway 网关拥有的 Twitch 渠道。
|
||||
- 确定性路由:回复总是返回到 Twitch。
|
||||
- 每个账户映射到一个隔离的会话键 `agent:<agentId>:twitch:<accountName>`。
|
||||
- `username` 是机器人账户(进行身份验证的账户),`channel` 是要加入的聊天室。
|
||||
|
||||
## 设置(详细)
|
||||
|
||||
@@ -81,20 +81,20 @@ openclaw plugins install ./extensions/twitch
|
||||
使用 [Twitch Token Generator](https://twitchtokengenerator.com/):
|
||||
|
||||
- 选择 **Bot Token**
|
||||
- 确认已勾选 `chat:read` 和 `chat:write` 权限范围
|
||||
- 确认已选择 `chat:read` 和 `chat:write` 权限范围
|
||||
- 复制 **Client ID** 和 **Access Token**
|
||||
|
||||
无需手动注册应用。令牌在数小时后过期。
|
||||
无需手动注册应用。令牌在几小时后过期。
|
||||
|
||||
### 配置机器人
|
||||
|
||||
**环境变量(仅限默认账号):**
|
||||
**环境变量(仅限默认账户):**
|
||||
|
||||
```bash
|
||||
OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...
|
||||
```
|
||||
|
||||
**或配置文件:**
|
||||
**或配置:**
|
||||
|
||||
```json5
|
||||
{
|
||||
@@ -110,7 +110,7 @@ OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...
|
||||
}
|
||||
```
|
||||
|
||||
如果环境变量和配置文件都设置了,配置文件优先。
|
||||
如果环境变量和配置都设置了,配置优先。
|
||||
|
||||
### 访问控制(推荐)
|
||||
|
||||
@@ -119,23 +119,24 @@ OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...
|
||||
channels: {
|
||||
twitch: {
|
||||
allowFrom: ["123456789"], // (推荐)仅限你的 Twitch 用户 ID
|
||||
allowedRoles: ["moderator"], // 或按角色限制
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
优先使用 `allowFrom` 作为硬性允许列表。如果你想要基于角色的访问控制,请改用 `allowedRoles`。
|
||||
|
||||
**可用角色:** `"moderator"`、`"owner"`、`"vip"`、`"subscriber"`、`"all"`。
|
||||
|
||||
**为什么使用用户 ID?** 用户名可以更改,存在冒充风险。用户 ID 是永久的。
|
||||
**为什么用用户 ID?** 用户名可以更改,允许冒充。用户 ID 是永久的。
|
||||
|
||||
查找你的 Twitch 用户 ID:https://www.streamweasels.com/tools/convert-twitch-username-%20to-user-id/(将 Twitch 用户名转换为 ID)
|
||||
查找你的 Twitch 用户 ID:https://www.streamweasels.com/tools/convert-twitch-username-%20to-user-id/(将你的 Twitch 用户名转换为 ID)
|
||||
|
||||
## 令牌刷新(可选)
|
||||
|
||||
从 [Twitch Token Generator](https://twitchtokengenerator.com/) 获取的令牌无法自动刷新——过期后需重新生成。
|
||||
来自 [Twitch Token Generator](https://twitchtokengenerator.com/) 的令牌无法自动刷新 - 过期时需要重新生成。
|
||||
|
||||
如需自动刷新令牌,请在 [Twitch Developer Console](https://dev.twitch.tv/console) 创建你自己的 Twitch 应用,并添加到配置中:
|
||||
要实现自动令牌刷新,请在 [Twitch Developer Console](https://dev.twitch.tv/console) 创建你自己的 Twitch 应用并添加到配置中:
|
||||
|
||||
```json5
|
||||
{
|
||||
@@ -150,11 +151,11 @@ OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...
|
||||
|
||||
机器人会在令牌过期前自动刷新,并记录刷新事件。
|
||||
|
||||
## 多账号支持
|
||||
## 多账户支持
|
||||
|
||||
使用 `channels.twitch.accounts` 配置每个账号的令牌。参见 [`gateway/configuration`](/gateway/configuration) 了解通用模式。
|
||||
使用 `channels.twitch.accounts` 配置每个账户的令牌。参阅 [`gateway/configuration`](/gateway/configuration) 了解共享模式。
|
||||
|
||||
示例(一个机器人账号加入两个频道):
|
||||
示例(一个机器人账户在两个频道中):
|
||||
|
||||
```json5
|
||||
{
|
||||
@@ -179,7 +180,7 @@ OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...
|
||||
}
|
||||
```
|
||||
|
||||
**注意:** 每个账号需要自己的令牌(每个频道一个令牌)。
|
||||
**注意:** 每个账户需要自己的令牌(每个频道一个令牌)。
|
||||
|
||||
## 访问控制
|
||||
|
||||
@@ -199,7 +200,7 @@ OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...
|
||||
}
|
||||
```
|
||||
|
||||
### 按用户 ID 设置允许列表(最安全)
|
||||
### 按用户 ID 允许列表(最安全)
|
||||
|
||||
```json5
|
||||
{
|
||||
@@ -215,9 +216,10 @@ OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...
|
||||
}
|
||||
```
|
||||
|
||||
### 组合允许列表 + 角色
|
||||
### 基于角色的访问(替代方案)
|
||||
|
||||
`allowFrom` 中的用户可绕过角色检查:
|
||||
`allowFrom` 是硬性允许列表。设置后,只允许这些用户 ID。
|
||||
如果你想要基于角色的访问,请不设置 `allowFrom`,改为配置 `allowedRoles`:
|
||||
|
||||
```json5
|
||||
{
|
||||
@@ -225,7 +227,6 @@ OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...
|
||||
twitch: {
|
||||
accounts: {
|
||||
default: {
|
||||
allowFrom: ["123456789"],
|
||||
allowedRoles: ["moderator"],
|
||||
},
|
||||
},
|
||||
@@ -263,17 +264,17 @@ openclaw channels status --probe
|
||||
|
||||
### 机器人不响应消息
|
||||
|
||||
**检查访问控制:** 临时设置 `allowedRoles: ["all"]` 进行测试。
|
||||
**检查访问控制:** 确保你的用户 ID 在 `allowFrom` 中,或临时移除 `allowFrom` 并设置 `allowedRoles: ["all"]` 来测试。
|
||||
|
||||
**检查机器人是否在频道中:** 机器人必须加入 `channel` 中指定的频道。
|
||||
|
||||
### 令牌问题
|
||||
|
||||
**"Failed to connect" 或认证错误:**
|
||||
**"Failed to connect"或身份验证错误:**
|
||||
|
||||
- 确认 `accessToken` 是 OAuth 访问令牌值(通常以 `oauth:` 前缀开头)
|
||||
- 检查令牌是否具有 `chat:read` 和 `chat:write` 权限范围
|
||||
- 如果使用令牌刷新,确认已设置 `clientSecret` 和 `refreshToken`
|
||||
- 验证 `accessToken` 是 OAuth 访问令牌值(通常以 `oauth:` 前缀开头)
|
||||
- 检查令牌具有 `chat:read` 和 `chat:write` 权限范围
|
||||
- 如果使用令牌刷新,验证 `clientSecret` 和 `refreshToken` 已设置
|
||||
|
||||
### 令牌刷新不工作
|
||||
|
||||
@@ -284,36 +285,36 @@ Using env token source for mybot
|
||||
Access token refreshed for user 123456 (expires in 14400s)
|
||||
```
|
||||
|
||||
如果看到 "token refresh disabled (no refresh token)":
|
||||
如果你看到"token refresh disabled (no refresh token)":
|
||||
|
||||
- 确保已提供 `clientSecret`
|
||||
- 确保已提供 `refreshToken`
|
||||
- 确保提供了 `clientSecret`
|
||||
- 确保提供了 `refreshToken`
|
||||
|
||||
## 配置
|
||||
|
||||
**账号配置:**
|
||||
**账户配置:**
|
||||
|
||||
- `username` - 机器人用户名
|
||||
- `accessToken` - 具有 `chat:read` 和 `chat:write` 权限的 OAuth 访问令牌
|
||||
- `clientId` - Twitch Client ID(来自 Token Generator 或你的应用)
|
||||
- `channel` - 要加入的频道(必填)
|
||||
- `enabled` - 启用此账号(默认:`true`)
|
||||
- `clientSecret` - 可选:用于自动刷新令牌
|
||||
- `refreshToken` - 可选:用于自动刷新令牌
|
||||
- `enabled` - 启用此账户(默认:`true`)
|
||||
- `clientSecret` - 可选:用于自动令牌刷新
|
||||
- `refreshToken` - 可选:用于自动令牌刷新
|
||||
- `expiresIn` - 令牌过期时间(秒)
|
||||
- `obtainmentTimestamp` - 令牌获取时间戳
|
||||
- `allowFrom` - 用户 ID 允许列表
|
||||
- `allowedRoles` - 基于角色的访问控制(`"moderator" | "owner" | "vip" | "subscriber" | "all"`)
|
||||
- `requireMention` - 要求 @提及(默认:`true`)
|
||||
- `requireMention` - 需要 @提及(默认:`true`)
|
||||
|
||||
**提供商选项:**
|
||||
|
||||
- `channels.twitch.enabled` - 启用/禁用渠道启动
|
||||
- `channels.twitch.username` - 机器人用户名(简化单账号配置)
|
||||
- `channels.twitch.accessToken` - OAuth 访问令牌(简化单账号配置)
|
||||
- `channels.twitch.clientId` - Twitch Client ID(简化单账号配置)
|
||||
- `channels.twitch.channel` - 要加入的频道(简化单账号配置)
|
||||
- `channels.twitch.accounts.<accountName>` - 多账号配置(上述所有账号字段)
|
||||
- `channels.twitch.username` - 机器人用户名(简化的单账户配置)
|
||||
- `channels.twitch.accessToken` - OAuth 访问令牌(简化的单账户配置)
|
||||
- `channels.twitch.clientId` - Twitch Client ID(简化的单账户配置)
|
||||
- `channels.twitch.channel` - 要加入的频道(简化的单账户配置)
|
||||
- `channels.twitch.accounts.<accountName>` - 多账户配置(以上所有账户字段)
|
||||
|
||||
完整示例:
|
||||
|
||||
@@ -370,15 +371,15 @@ Access token refreshed for user 123456 (expires in 14400s)
|
||||
|
||||
## 安全与运维
|
||||
|
||||
- **将令牌视为密码** - 切勿将令牌提交到 git
|
||||
- **将令牌视为密码** - 永远不要将令牌提交到 git
|
||||
- **使用自动令牌刷新** 用于长时间运行的机器人
|
||||
- **使用用户 ID 允许列表** 而非用户名进行访问控制
|
||||
- **监控日志** 关注令牌刷新事件和连接状态
|
||||
- **最小化令牌权限范围** - 仅请求 `chat:read` 和 `chat:write`
|
||||
- **如遇问题**:确认没有其他进程占用会话后,重启 Gateway网关
|
||||
- **使用用户 ID 允许列表** 而不是用户名进行访问控制
|
||||
- **监控日志** 查看令牌刷新事件和连接状态
|
||||
- **最小化令牌权限范围** - 只请求 `chat:read` 和 `chat:write`
|
||||
- **如果卡住**:在确认没有其他进程拥有会话后重启 Gateway 网关
|
||||
|
||||
## 限制
|
||||
|
||||
- 每条消息最多 **500 个字符**(按词边界自动分块)
|
||||
- 分块前会移除 Markdown 格式
|
||||
- 每条消息 **500 个字符**(在单词边界自动分块)
|
||||
- 分块前会去除 Markdown
|
||||
- 无速率限制(使用 Twitch 内置的速率限制)
|
||||
|
||||
Reference in New Issue
Block a user