Skip to content

插件开发 ​

读完这一节,你能写一个可加载的插件,并把它接到 QQ 消息和命令上。

BotQraft 独立运行,使用 MCDReforged 提供的插件、命令树和生命周期能力。插件通过 botqraft.api 接入 QQ 消息与事件。

认识插件 ​

读完这一组,你能写出第一个可加载的插件,并知道它由哪些文件组成。

  1. 基本知识:知道插件是什么、框架在什么时机调用它。
  2. 元数据:为插件选定 ID,并声明版本、依赖与资源。
  3. 插件格式:挑出单文件、目录或压缩格式,并把插件打包出来。

接收与回复 ​

读完这一组,你能让插件收到 QQ 消息,并回上一条正确的消息。

  1. 插件事件:接上回调,知道多条回调同时命中时的调用顺序。
  2. 事件与消息格式:从事件里取出正文、用户身份和会话信息。
  3. 响应事件与回复消息:发出被动回复,并拿到操作结果。

编写命令 ​

读完这一组,你能为机器人注册一条命令,并让它出现在帮助里。

  1. 命令系统:弄清命令来源、参数和场景。
  2. SimpleCommandBuilder:用命令路径快速注册功能。
  3. 命令树:用节点搭出更细致的命令结构。
  4. 帮助消息与指令面板:用 register_help_message 展示命令入口。
  5. 第一个插件:把前面的知识串起来,安装并验证 Echo。
  6. 权限系统:为命令与操作设置执行权限。

按需查阅 ​

需要时再翻,每页都能单独读懂。

  1. 交互事件与按钮响应:处理按钮点击并回应用户操作。
  2. Markdown、文本交互与键盘:在消息里使用 Markdown、文本交互与键盘。
  3. 翻译与用户语言:让插件文案跟随用户语言切换。
  4. 插件数据与打包资源:读写插件自己的数据目录,并读取打包资源。
  5. 后台任务与卸载:启动后台任务,并在卸载时干净退出。
  6. 主动发送、引用与撤回:主动发出消息,引用或撤回已有消息。
  7. API 索引:按模块查找公开接口。
  8. 今日人品示例:读一个完整插件的实现,照着自己的需求改。

接下来,按添加插件把插件安装到运行实例,并在 QQ 中检查群聊与私聊的实际结果。