插件结构
插件是一个文件夹,根目录必须包含 index.js 和 plugin.json。
plugin.json
{
"name": "示例插件",
"version": "1.0.0",
"author": "HeartSea",
"description": "这是一个示例插件,演示插件系统的基本用法",
"main": "index.js",
"logo": "",
"install": false
}
| 字段 | 类型 | 说明 |
|---|---|---|
name | string | 插件名称 |
version | string | 版本号 |
author | string | 作者 |
description | string | 插件描述 |
main | string | 入口文件 |
logo | string | 图标(可选) |
install | boolean | 是否默认安装 |
入口文件
module.exports = {
// 初始化,返回 true 允许加载
init() { return true },
// 插件启用时调用,传入 SDK 实例
onEnable(sdk) { },
// 插件停用时调用
onDisable(sdk) { },
}
生命周期
| 方法 | 时机 | 说明 |
|---|---|---|
init() | 加载时 | 返回 false 拒绝加载 |
onEnable(sdk) | 启用时 | 拿到 SDK,注册事件、调用 API |
onDisable(sdk) | 停用时 | 清理资源、输出日志 |
SDK 说明
sdk 对象包含所有 API 方法和事件监听功能,详见 API 文档。