Skip to content

核心概念

HeyBoxBot 围绕以下几个核心概念构建:

Bot 实例

HeyBoxBot 是整个框架的入口。每个 bot 实例维护一个 WebSocket 连接到黑盒语音服务器,并管理所有的指令、定时任务和事件订阅。

typescript
import { HeyBoxBot } from 'heybox-bot'

const bot = new HeyBoxBot({ token: '...' })
bot.start()

生命周期

Bot 有完整的生命周期事件:启动前、启动后、停止前、停止后。你可以在这些阶段执行初始化或清理工作。

参考 生命周期 了解更多。

指令系统

通过 @bot.command() 装饰器注册指令。当用户在房间内发送 /指令名 格式的消息时,bot 会自动解析参数并执行对应的处理函数。

参考 指令系统 了解更多。

定时任务

通过 @bot.cron() 装饰器注册基于 cron 表达式的定时任务,例如每天定时发送统计报告。

参考 定时任务 了解更多。

事件订阅

通过 @bot.subscribe() 装饰器订阅房间内的各种事件,例如用户加入/离开房间、表情反应、卡片按钮点击等。

参考 事件订阅 了解更多。

消息发送

HeyBoxBot 支持多种消息类型:

  • 扩展 Markdown 消息 — 支持富文本格式的频道消息
  • 卡片消息 — 结构化的卡片消息,支持头部、段落、按钮等
  • 用户消息(私信) — 发送给指定用户的私信

参考 消息系统 了解更多。

Released under the LGPL-3.0 License.