概述

HeyBoxBot 是一个使用 TypeScript 编写的黑盒聊天机器人框架，用于在黑盒语音平台上构建聊天机器人。

什么是 HeyBoxBot？

HeyBoxBot 封装了黑盒语音的 WebSocket 通信协议和 HTTP API，提供了一套类型安全、事件驱动的开发接口。你可以通过简单的装饰器来注册指令和定时任务，无需关心底层的消息协议。

核心特性

• 指令系统 — 通过 @bot.command() 装饰器注册指令，支持字符串、数字、布尔、用户、图片、文件等多种参数类型
• 定时任务 — 通过 @bot.cron() 装饰器注册 cron 定时任务
• 事件订阅 — 通过 @bot.subscribe() 装饰器订阅房间事件（用户进出、表情反应、卡片按钮点击等）
• 扩展 Markdown — 支持标题、链接、图片、@用户、有序/无序列表、引用等富文本格式
• 卡片消息 — 支持构建包含头部、段落、图文、按钮、分割线、倒计时的卡片消息
• 完整 API 覆盖 — 房间管理、频道管理、身份组管理、表情管理、直播推流、音频控制等

许可协议

HeyBoxBot 使用 LGPL-3.0 许可证开源。