开发文档

共计 1 篇文章
2024-12-19

安卓版QQ频道机器人APP客户端插件开发指南

知识点

本文档将指导您如何为QQ频道机器人客户端开发插件。

插件结构

每个插件都是一个标准的 JavaScript 文件，需要导出一个包含以下字段的对象:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
// 插件对象
const plugin = {
  // 基本信息(必需)
  id: 'plugin-id',          // 插件ID,只能包含小写字母、数字、下划线和横线
  name: '插件名称',         // 插件显示名称
  description: '插件描述',  // 插件功能描述
  command: '/命令',         // 触发命令,必须以/开头
  
  // 基本信息(可选)
  version: '1.0.0',        // 插件版本号
  author: '作者名称',      // 插件作者
  enabled: true,           // 插件是否启用
  
  // 配置项(可选)
  config: {
    // 插件的配置项
    minPoints: 10,         // 示例:最小积分
    maxPoints: 100,        // 示例:最大积分
  },
  
  // 数据存储(可选)
  storage: {
    // 插件的数据存储
    records: new Map()     // 示例:记录存储
  },
  
  // 消息处理函数(必需)
  handler: async (message, channel, context) => {
    // 返回值:
    // - 字符串: 要发送的回复消息
    // - null/undefined: 不发送回复
    // - Promise<string>: 异步返回回复消息
    return '回复消息'
  }
}

// 导出插件
module.exports = plugin

API 说明

1. 消息对象(message)