sergeant

Sergeant 是一个基于终端的 Twitch 聊天窗口和机器人。它会在终端中显示你的 Twitch 频道的聊天内容，同时允许你添加聊天机器人命令。

安装

$ cargo install sergeant

用法

sergeant chat

在终端显示你的 Twitch 频道聊天。需要认证，最简单的方法是使用 sergeant login。你也可以使用位置参数提供你的 twitch 用户名，一个 oauth 令牌和一个客户端 ID。你也可以提供环境变量。使用 sergeant chat --help 获取更多详细信息。

sergeant login

启动 OAuth 登录流程以获取令牌。导航到它打印到终端的 URL，它会等待你进行认证。完成后，你就可以使用 sergeant。

sergeant 命令

使用此命令添加、删除和列出聊天命令。

# add !today command:
sergeant commands add today "Today I am going to rust all day long!"

# remove command:
sergeant commands remove today

# list commands:
sergeant commands list

# add a recurring announcement every 5 mins:
sergeant commands add spam "Spam your Twitch channel all you want" 5

sergeant 奖励

使用此命令添加、删除和列出奖励。奖励直接链接到 Twitch 奖励兑换。你可以直接将 Twitch 兑换链接到任意 CLI 命令。如果兑换需要用户输入，则输入将传递给 CLI 命令以及兑换奖励的 Twitch 用户的 display_name。

# Link a Twitch redeem named "spotify" to a CLI command named "spt":
sergeant rewards add spotify spt

# remove reward:
sergeant rewards remove spotify

# list rewards:
sergeant rewards list

sergeant irc-actions

使用此命令添加、删除和列出 irc-actions。IRC 动作直接链接到 IRC !命令。你可以直接将任意的 !命令链接到任意的 CLI 命令。发送聊天命令的 Twitch 用户的 display_name 将发送到 CLI 命令。

# Link a irc-action named "boom" to a CLI command named "any-cli-command":
sergeant irc-actions add boom any-cli-command

# remove irc-action:
sergeant irc-actions remove spotify

# list irc-actions:
sergeant irc-actions list

覆盖服务器

sergeant chat 命令还会启动一个 WebSocket 服务器，可以用来构建 OBS 覆盖。所有受支持的 Twitch IRC、PubSub 和 EventSub 消息都会发布到 WebSocket 服务器，以便用于构建基于 Web 的界面。WebSocket 服务器在端口 8765 上运行。