消息平台

Twitch

通过 Twurple 客户端,使用 Twitch 的聊天(IRC)接口支持 Twitch 聊天。OpenClaw 以 Twitch 机器人账户登录,每个已配置的账户加入一个频道,并在该频道中回复。

安装

Twitch 作为官方插件提供;它不属于核心安装的一部分。

npm 注册表

bash
openclaw plugins install @openclaw/twitch

本地检出

bash
openclaw plugins install ./path/to/local/twitch-plugin

plugins install 会注册并启用该插件。在 openclaw onboardopenclaw channels add 中选择 Twitch 时,会按需安装该插件。使用不带版本号的软件包名称可跟随当前版本;仅在需要可重现安装时固定确切版本。需要 OpenClaw 2026.4.10 或更高版本。

详情:插件

快速设置

  • 安装插件

    请参阅上方的安装

  • 创建 Twitch 机器人账户

    为机器人创建一个专用 Twitch 账户(也可以使用现有账户)。

  • 生成凭据

    使用 Twitch Token Generator

    • 选择 Bot Token
    • 确认已选择 chat:readchat:write 权限范围
    • 复制 Client IDAccess Token
  • 查找你的 Twitch 用户 ID

    使用 https://www.streamweasels.com/tools/convert-twitch-username-to-user-id/ 将用户名转换为 Twitch 用户 ID。

  • 配置令牌

    • 环境变量:OPENCLAW_TWITCH_ACCESS_TOKEN=...(仅限默认账户)
    • 或配置:channels.twitch.accessToken

    如果两者都已设置,则配置优先(环境变量仅作为默认账户的回退值)。

  • 启动 Gateway 网关

    bash
    openclaw gateway run
  • 最小配置:

    json5
    {  channels: {    twitch: {      enabled: true,      username: "openclaw", // Bot's Twitch account (authenticates)      accessToken: "oauth:abc123...", // OAuth access token (or use OPENCLAW_TWITCH_ACCESS_TOKEN env var)      clientId: "xyz789...", // Client ID from Token Generator      channel: "yourchannel", // Which Twitch channel's chat to join (required)      allowFrom: ["123456789"], // (recommended) Your Twitch user ID only    },  },}

    功能说明

    • 由 Gateway 网关拥有的 Twitch 频道。
    • 确定性路由:回复始终返回消息来源的 Twitch 频道。
    • 每个已加入的频道都映射到一个隔离的群组会话键 agent:<agentId>:twitch:group:<channel>
    • username 是机器人的账户(用于身份验证),channel 是要加入的聊天室。每个账户条目只加入一个频道。
    • 令牌可以包含或不包含 oauth: 前缀;OpenClaw 会对两种形式进行规范化(设置向导要求使用 oauth: 形式)。

    令牌刷新(可选)

    Twitch Token Generator 生成的令牌无法由 OpenClaw 刷新——过期后需要重新生成(令牌有效期为数小时;无需注册应用)。

    如需自动刷新,请在 Twitch Developer Console 中创建自己的应用,并添加:

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

    两者都设置后,插件会使用可刷新的身份验证提供商,在令牌过期前续期,并记录每次刷新。如果没有 refreshToken,则记录 token refresh disabled (no refresh token);如果没有 clientSecret,则回退到静态(不可刷新)令牌。

    多账户支持

    使用 channels.twitch.accounts 配置各账户的凭据。有关通用模式,请参阅配置

    示例(一个机器人账户加入两个频道):

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

    访问控制

    allowFrom 是由 Twitch 用户 ID 组成的严格允许列表。设置后会忽略 allowedRoles;如需改用基于角色的访问控制,请不要设置 allowFrom

    可用角色:"moderator""owner""vip""subscriber""all"

    用户 ID 允许列表(最安全)

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

    基于角色

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

    禁用 @提及要求

    requireMention 默认为 true。要响应所有获准的消息:

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

    故障排查

    首先运行诊断命令:

    bash
    openclaw doctoropenclaw channels status --probe
    机器人不响应消息
    • **检查访问控制:**确保你的用户 ID 位于 allowFrom 中;或者临时移除 allowFrom 并设置 allowedRoles: ["all"] 进行测试。
    • **检查提及门控:**当 requireMention: true(默认值)时,消息必须使用 @ 提及机器人的用户名。
    • **检查机器人是否在频道中:**机器人只会加入 channel 中指定的频道。
    令牌问题

    出现“连接失败”或身份验证错误时:

    • 确认 accessToken 是 OAuth 访问令牌值(oauth: 前缀可选)
    • 检查令牌是否具有 chat:readchat:write 权限范围
    • 如果使用令牌刷新,请确认已设置 clientSecretrefreshToken
    令牌刷新不起作用

    检查日志中的刷新事件:

    text
    Using env token source for mybotAccess token refreshed for user 123456 (expires in 14400s)

    如果看到 token refresh disabled (no refresh token)

    • 确保已提供 clientSecret
    • 确保已提供 refreshToken

    配置

    账户配置

    usernamestringrequired

    机器人用户名(用于身份验证的账户)。

    accessTokenstringrequired

    具有 chat:readchat:write 权限范围的 OAuth 访问令牌(默认账户可通过配置或环境变量设置)。

    clientIdstringrequired

    Twitch 客户端 ID(来自 Token Generator 或你的应用)。在模式中为可选项,但连接时必需。

    channelstringrequired

    要加入的频道。

    enabledbooleandefault: true

    启用此账户。

    clientSecretstring

    可选:用于自动刷新令牌。

    refreshTokenstring

    可选:用于自动刷新令牌。

    expiresInnumber

    令牌的过期时间,以秒为单位(用于刷新跟踪)。

    obtainmentTimestampnumber

    获取令牌时的时间戳(用于刷新跟踪)。

    allowFromstring[]

    用户 ID 允许列表。设置后会忽略角色。

    allowedRoles'Array<"moderator"
    requireMentionbooleandefault: true

    要求使用 @ 提及才能触发机器人。

    responsePrefixstring

    覆盖此账户的出站回复前缀。

    提供商选项

    • channels.twitch.enabled - 启用或禁用频道启动
    • channels.twitch.username / accessToken / clientId / channel - 简化的单账户配置(隐式使用 default 账户;优先于 accounts.default
    • channels.twitch.accounts.<accountName> - 多账户配置(包含上述所有账户字段)
    • channels.twitch.defaultAccount - 指定哪个账户名称为默认账户
    • channels.twitch.markdown.tables - Markdown 表格渲染模式(off | bullets | code | block

    完整示例:

    json5
    {  channels: {    twitch: {      enabled: true,      username: "openclaw",      accessToken: "oauth:abc123...",      clientId: "xyz789...",      channel: "yourchannel",      clientSecret: "secret123...",      refreshToken: "refresh456...",      allowFrom: ["123456789"],      accounts: {        second: {          username: "mybot",          accessToken: "oauth:def456...",          clientId: "uvw012...",          channel: "your_channel",          enabled: true,          expiresIn: 14400,          obtainmentTimestamp: 1706092800000,          allowedRoles: ["moderator"],        },      },    },  },}

    工具操作

    智能体可以通过消息工具的 send 操作发送 Twitch 消息:

    json5
    {  channel: "twitch",  action: "send",  to: "#mychannel",  message: "Hello Twitch!",}

    to 是可选的,默认为账户中配置的 channel

    安全与运维

    • 像对待密码一样对待令牌——切勿将令牌提交到 git。
    • 使用自动令牌刷新以支持长期运行的机器人。
    • 使用用户 ID 允许列表而非用户名进行访问控制。
    • 监控日志中的令牌刷新事件和连接状态。
    • 尽量缩小令牌的权限范围——仅请求 chat:readchat:write
    • 如果遇到阻碍:确认没有其他进程占用该会话后,重启 Gateway 网关。

    限制

    • 每条消息最多 500 个字符;较长的回复会在单词边界处分块。
    • 发送前会移除 Markdown(Twitch 聊天使用纯文本;换行会转换为空格)。
    • OpenClaw 本身不添加速率限制;Twurple 聊天客户端负责处理 Twitch 速率限制。

    相关内容

    Was this useful?
    On this page

    On this page