✨ Ret 2 Shell (回归终端) 比赛事件播报与信息查询 ✨
接入 Ret 2 Shell (回归终端) 事件推送 API,根据比赛发生的事件类型,实时向指定的群组或管理员账号播报,还具有主动查询功能。
在 NoneBot 机器人项目的根目录下执行插件安装命令:
nb plugin install nonebot-plugin-ret2shell
在 dotenv 配置文件中填入配置:
| 配置项 | 必填 | 说明 |
|---|---|---|
| RET2SHELL_WS_LINK | 是 | 平台事件推送 API 链接 |
| TARGET_GROUP_ID | 否 | 比赛群号,留空则不会播报公开事件。 |
| ADMIN_ID | 否 | 管理员号,留空则不会播报管理事件。 |
| CLIENT_LABEL | 否 | 客户端标识,可在 已连接的设备 中查看。默认为 nonebot-plugin-ret2shell |
示例:
DRIVER=~fastapi+~websockets
RET2SHELL_WS_LINK=ws://ret.sh.cn/api/event/connect?game_id=1&token=mn7Me1rkMLUbJj-iyHbu0
TARGET_GROUP_ID=123456789
ADMIN_ID=987654321通过 OneBot 适配器连接机器人后,插件会尝试与平台事件推送 API 建立连接,然后播报事件。当机器人连接断开后,插件也会与平台断开连接,以节省资源。
查询指令表:
| 指令 | 说明 |
|---|---|
| /game | 查询比赛基础信息 |
| /rank | 查询比赛积分板 |