Vfinity2.0 α
开发者

Streamer.bot

从任意 Vfinity 事件或 Quick Deck 按键板运行你的 Streamer.bot 动作

将 Vfinity 连接到电脑上的 Streamer.bot,任何事件或 Quick Deck 按键板均可运行你的 Streamer.bot 动作,同时附带传递观众名称、礼物或聊天消息。

Vfinity 作为客户端连接到 Streamer.bot 的 WebSocket 服务器。在 Vfinity 尝试连接之前,必须先打开 Streamer.bot 并启动其 WebSocket 服务器。

127.0.0.1
Vfinity 首选的主机地址
8080
Vfinity 首选的端口
本机
密码保存的位置

连接 Streamer.bot

启动 Streamer.bot 的 WebSocket 服务器

在 Streamer.bot 中,启动其 WebSocket 服务器并记下其使用的地址、端口与密码。

打开 Streamer.bot 卡片

在 Vfinity 中,前往 设置连接。在应用下方,打开 Streamer.bot 卡片并开启 Connect to Streamer.bot。

输入所在地址

填写与 Streamer.bot 一致的 IP 地址 与端口。若其服务器需要密码,请在服务器密码中输入。

连接

点击 Connect Streamer.bot。卡片状态将变为已连接,且 Vfinity 会读取你的 Streamer.bot 动作列表。

Streamer.bot 位于“设置 › 连接”的“应用”分组下,与 VTube Studio 和 OBS 并列。

如果 Vfinity 无法连接,卡片会显示问题:以及具体的错误原因。当连接断开时,Vfinity 会自动重试,并在每次重试之间逐步延长等待间隔。开启启动时连接后,它还会在 Vfinity 启动时自动建立连接。

关闭 Connect to Streamer.bot 会断开连接,Vfinity 将不再尝试访问 Streamer.bot,直到你重新开启它。

从事件中运行动作

添加步骤

在事件标签页中打开一个事件,点击添加步骤并选择 Streamer.bot action。

选择动作

点击 URL / action ID 并从列表中选择一个动作,列表会按名称显示你的 Streamer.bot 动作。Vfinity 会保存该动作的 ID。你也可以直接将 ID 粘贴到输入框中。

必要时刷新列表

在 Streamer.bot 保持连接时列表会自动填充。连接后新建了动作?点击 Refresh action list 即可看到。如果无法读取列表,步骤将显示 Integration request failed。

保存并测试

保存事件,然后右键点击该事件并选择立即测试,无需等待观众触发即可直接运行。

Streamer.bot 步骤与其他步骤一样位于动作列表中,可以按顺序、同时或随机运行。

该步骤在 Quick Deck 按键板中的用法完全相同,因此可以通过按键板手动触发 Streamer.bot 动作。在蓝图事件中,由 动作 节点来运行它。

向动作传递参数

JSON body / arguments 接收一个 JSON 对象。Vfinity 会在替换文本值中的占位符后,将其作为动作的参数发送给 Streamer.bot。

{
  "user": "{name}",
  "gift": "{gift}",
  "amount": "{count}",
  "message": "{comment}",
  "loud": true
}

占位符可在文本值中使用,包括 {name}、{gift}、{count}、{diamonds}、{comment} 以及聊天指令的 {arg1} 至 {arg9}。数字和布尔值原样透传。每个填充后的值都会将换行符替换为空格,并在 500 个字符处截断,以防过长的聊天消息灌满你的动作。

保持为 {} 则不发送任何参数。若动作 ID 为空或参数不是合法的 JSON 对象,事件将无法保存。

完整占位符列表请参阅模板变量。

动作未执行时的排查

当 Streamer.bot 未连接时,步骤将失败并显示 Integration is disconnected;当 Streamer.bot 拒绝请求时同样会失败。无论哪种情况,同一事件中的其他步骤仍会继续运行。

请检查 Streamer.bot 是否打开、其 WebSocket 服务器是否正在运行,以及动作是否仍然存在。右键点击事件并选择立即测试以重试。

保护密码安全

服务器密码仅保存在本机,独立于你的普通设置。只有在备份时勾选包含密码和令牌才会包含该密码,且在导出的支持日志中该密码会被隐去。

反向调用

若要让脚本或其他应用运行 Vfinity 的指令和事件,请使用本地 API。

相关内容