Skip to content

manifest.json 格式说明

manifest.json 是插件元数据入口,用于插件发现、依赖校验和加载顺序计算。

最小可用示例

json
{
  "name": "my_plugin",
  "version": "1.0.0",
  "description": "插件说明",
  "author": "作者",
  "dependencies": {
    "plugins": [],
    "components": []
  },
  "entry_point": "plugin.py",
  "min_core_version": "1.0.0"
}

顶级字段

字段类型是否必填说明
namestring插件唯一名,建议与 BasePlugin.plugin_name 一致
versionstring语义化版本(如 1.0.0
descriptionstring插件描述
authorstring作者
dependenciesobject插件/组件依赖
entry_pointstring入口文件路径(通常为 plugin.py
min_core_versionstring推荐最低核心版本(如 1.0.0),低于此版本拒绝加载
includearray推荐组件清单;未提供时按空列表处理
categoriesarray推荐分类标签(如 ["chat", "tools"]
tagsarray推荐标签(如 ["qq", "ai"]
python_dependenciesarrayPython 包依赖列表(pip requirement 格式)
dependencies_requiredboolPython 依赖是否必需(默认 true

dependencies

json
"dependencies": {
  "plugins": ["other_plugin"],
  "components": ["other_plugin:service:memory"]
}
  • plugins:依赖的插件名列表
  • components:依赖的组件签名列表(格式 plugin:type:name

include(推荐)

声明插件包含的组件及组件级依赖。

json
"include": [
  {
    "component_type": "action",
    "component_name": "send_emoji",
    "dependencies": ["other_plugin:service:emoji"],
    "enabled": true
  }
]
字段类型默认值说明
component_typestring组件类型
component_namestring组件名称
dependenciesstring[][]组件级依赖
enabledbooltrue是否启用

component_type 可用值

  • action
  • tool
  • adapter
  • chatter
  • command
  • event_handler
  • service
  • router
  • config
  • agent

python_dependencies(可选)

json
"python_dependencies": [
  "requests>=2.28.0",
  "pandas>=1.5.0"
]
  • dependencies_required: true(默认):依赖安装失败时插件跳过
  • dependencies_required: false:安装失败仅警告,仍尝试加载

完整示例

json
{
  "name": "default_chatter",
  "version": "1.0.0",
  "description": "默认对话插件",
  "author": "MoFox Team",
  "dependencies": {
    "plugins": [],
    "components": []
  },
  "include": [
    {
      "component_type": "chatter",
      "component_name": "default_chatter",
      "dependencies": [],
      "enabled": true
    }
  ],
  "entry_point": "plugin.py",
  "min_core_version": "1.0.0",
  "categories": ["chat"],
  "tags": ["built-in"]
}

贡献者

The avatar of contributor named as minecraft1024a minecraft1024a
The avatar of contributor named as Windpicker-owo Windpicker-owo

页面历史

Released under the GPL-3.0 License.