Twitch (plugin)

通过 IRC 连接支持 Twitch 聊天。OpenClaw 以 Twitch 用户（机器人账号）身份连接，在频道中接收和发送消息。

需要安装 Plugin

Twitch 作为 Plugin 提供，不包含在核心安装中。

通过 CLI 安装（npm 仓库）：

openclaw plugins install @openclaw/twitch

本地安装（从 git 仓库运行时）：

openclaw plugins install ./extensions/twitch

详情：Plugins

快速设置（新手向）

  1. 为机器人创建一个专用的 Twitch 账号（或使用现有账号）。
  2. 生成凭证：Twitch Token Generator
    • 选择 Bot Token
    • 确认已选中 chat:read 和 chat:write 权限范围
    • 复制 Client ID 和 Access Token
  3. 查找你的 Twitch 用户 ID：https://www.streamweasels.com/tools/convert-twitch-username-to-user-id/
  4. 配置 Token：
    • 环境变量：OPENCLAW_TWITCH_ACCESS_TOKEN=...（仅限默认账号）
    • 或配置文件：channels.twitch.accessToken
    • 如果两者都设置了，配置文件优先（环境变量仅作为默认账号的后备）。
  5. 启动 Gateway。

⚠️ 重要： 添加访问控制（allowFrom 或 allowedRoles）以防止未授权用户触发机器人。requireMention 默认为 true。

最小配置：

{
  channels: {
    twitch: {
      enabled: true,
      username: "openclaw", // 机器人的 Twitch 账号
      accessToken: "oauth:abc123...", // OAuth Access Token（或使用 OPENCLAW_TWITCH_ACCESS_TOKEN 环境变量）
      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 Channel。
  • 确定性路由：回复始终返回到 Twitch。
  • 每个账号映射到一个隔离的 Session 键 agent:<agentId>:twitch:<accountName>。
  • username 是机器人的账号（用于认证），channel 是要加入的聊天室。

详细设置

生成凭证

使用 Twitch Token Generator：

  • 选择 Bot Token
  • 确认已选中 chat:read 和 chat:write 权限范围
  • 复制 Client ID 和 Access Token

无需手动注册应用。Token 会在几小时后过期。

配置机器人

环境变量（仅限默认账号）：

OPENCLAW_TWITCH_ACCESS_TOKEN=oauth:abc123...

或配置文件：

{
  channels: {
    twitch: {
      enabled: true,
      username: "openclaw",
      accessToken: "oauth:abc123...",
      clientId: "xyz789...",
      channel: "vevisk",
    },
  },
}

如果环境变量和配置文件都设置了，配置文件优先。

访问控制（推荐）

{
  channels: {
    twitch: {
      allowFrom: ["123456789"], // （推荐）仅你的 Twitch 用户 ID
    },
  },
}

优先使用 allowFrom 作为硬性白名单。如果你想要基于角色的访问控制，改用 allowedRoles。

可用角色： "moderator"、"owner"、"vip"、"subscriber"、"all"。

为什么用用户 ID？ 用户名可以更改，容易被冒充。用户 ID 是永久的。

查找你的 Twitch 用户 ID：https://www.streamweasels.com/tools/convert-twitch-username-%20to-user-id/（将你的 Twitch 用户名转换为 ID）

Token 刷新（可选）

从 Twitch Token Generator 获取的 Token 无法自动刷新 - 过期后需要重新生成。

要实现自动 Token 刷新，在 Twitch Developer Console 创建你自己的 Twitch 应用，并添加到配置：

{
  channels: {
    twitch: {
      clientSecret: "your_client_secret",
      refreshToken: "your_refresh_token",
    },
  },
}

机器人会在过期前自动刷新 Token 并记录刷新事件。

多账号支持

使用 channels.twitch.accounts 配置每个账号的 Token。参见 gateway/configuration 了解共享模式。

示例（一个机器人账号在两个频道）：

{
  channels: {
    twitch: {
      accounts: {
        channel1: {
          username: "openclaw",
          accessToken: "oauth:abc123...",
          clientId: "xyz789...",
          channel: "vevisk",
        },
        channel2: {
          username: "openclaw",
          accessToken: "oauth:def456...",
          clientId: "uvw012...",
          channel: "secondchannel",
        },
      },
    },
  },
}

注意： 每个账号需要自己的 Token（每个频道一个 Token）。

访问控制

基于角色的限制

{
  channels: {
    twitch: {
      accounts: {
        default: {
          allowedRoles: ["moderator", "vip"],
        },
      },
    },
  },
}

按用户 ID 白名单（最安全）

{
  channels: {
    twitch: {
      accounts: {
        default: {
          allowFrom: ["123456789", "987654321"],
        },
      },
    },
  },
}

基于角色的访问（替代方案）

allowFrom 是硬性白名单。设置后，只有这些用户 ID 被允许。 如果你想要基于角色的访问，不设置 allowFrom，改为配置 allowedRoles：

{
  channels: {
    twitch: {
      accounts: {
        default: {
          allowedRoles: ["moderator"],
        },
      },
    },
  },
}

禁用 @提及 要求

默认情况下，requireMention 为 true。要禁用并响应所有消息：

{
  channels: {
    twitch: {
      accounts: {
        default: {
          requireMention: false,
        },
      },
    },
  },
}

故障排除

首先，运行诊断命令：

openclaw doctor
openclaw channels status --probe

机器人不响应消息

检查访问控制： 确保你的用户 ID 在 allowFrom 中，或临时移除 allowFrom 并设置 allowedRoles: ["all"] 进行测试。

检查机器人是否在频道中： 机器人必须加入 channel 中指定的频道。

Token 问题

“Failed to connect” 或认证错误：

  • 验证 accessToken 是 OAuth access token 值（通常以 oauth: 前缀开头）
  • 检查 Token 是否有 chat:read 和 chat:write 权限范围
  • 如果使用 Token 刷新，验证 clientSecret 和 refreshToken 已设置

Token 刷新不工作

检查日志中的刷新事件：

Using env token source for mybot
Access token refreshed for user 123456 (expires in 14400s)

如果你看到 “token refresh disabled (no refresh token)”：

  • 确保提供了 clientSecret
  • 确保提供了 refreshToken

配置

账号配置：

  • username - 机器人用户名
  • accessToken - 带有 chat:read 和 chat:write 的 OAuth access token
  • clientId - Twitch Client ID（从 Token Generator 或你的应用获取）
  • channel - 要加入的频道（必填）
  • enabled - 启用此账号（默认：true）
  • clientSecret - 可选：用于自动 Token 刷新
  • refreshToken - 可选：用于自动 Token 刷新
  • expiresIn - Token 过期时间（秒）
  • obtainmentTimestamp - Token 获取时间戳
  • allowFrom - 用户 ID 白名单
  • allowedRoles - 基于角色的访问控制（"moderator" | "owner" | "vip" | "subscriber" | "all"）
  • requireMention - 需要 @提及（默认：true）

Provider 选项：

  • channels.twitch.enabled - 启用/禁用 Channel 启动
  • channels.twitch.username - 机器人用户名（简化的单账号配置）
  • channels.twitch.accessToken - OAuth access token（简化的单账号配置）
  • channels.twitch.clientId - Twitch Client ID（简化的单账号配置）
  • channels.twitch.channel - 要加入的频道（简化的单账号配置）
  • channels.twitch.accounts.<accountName> - 多账号配置（上述所有账号字段）

完整示例：

{
  channels: {
    twitch: {
      enabled: true,
      username: "openclaw",
      accessToken: "oauth:abc123...",
      clientId: "xyz789...",
      channel: "vevisk",
      clientSecret: "secret123...",
      refreshToken: "refresh456...",
      allowFrom: ["123456789"],
      allowedRoles: ["moderator", "vip"],
      accounts: {
        default: {
          username: "mybot",
          accessToken: "oauth:abc123...",
          clientId: "xyz789...",
          channel: "your_channel",
          enabled: true,
          clientSecret: "secret123...",
          refreshToken: "refresh456...",
          expiresIn: 14400,
          obtainmentTimestamp: 1706092800000,
          allowFrom: ["123456789", "987654321"],
          allowedRoles: ["moderator"],
        },
      },
    },
  },
}

Tool 操作

Agent 可以调用 twitch 并执行操作：

  • send - 向频道发送消息

示例：

{
  action: "twitch",
  params: {
    message: "Hello Twitch!",
    to: "#mychannel",
  },
}

安全与运维

  • 像对待密码一样对待 Token - 永远不要将 Token 提交到 git
  • 使用自动 Token 刷新 用于长期运行的机器人
  • 使用用户 ID 白名单 而不是用户名进行访问控制
  • 监控日志 查看 Token 刷新事件和连接状态
  • 最小化 Token 权限范围 - 只请求 chat:read 和 chat:write
  • 如果卡住了：在确认没有其他进程占用 Session 后重启 Gateway

限制

  • 每条消息 500 字符（在单词边界自动分块）
  • 分块前会去除 Markdown
  • 无速率限制（使用 Twitch 的内置速率限制）