Skip to content

manifest.json 格式说明

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

最小可用示例

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

顶级字段

字段类型是否必填说明
namestring插件唯一名,建议与 BasePlugin.plugin_name 一致
versionstring语义化版本
descriptionstring插件描述
authorstring作者
dependenciesobject插件/组件依赖
entry_pointstring入口文件路径(默认通常为 plugin.py
includearray组件清单;未提供时按空列表处理
min_core_versionstring强烈建议必填最低核心版本;当前实现中请务必显式填写并与当前核心版本兼容(如 1.0.0

当前实现注意(务必阅读)

min_core_version 会参与版本检查。当前加载器在该字段缺失时会回退到 3.0.0,会导致插件被判定为不兼容并拒绝加载。

因此在当前版本中,min_core_version 应视为“必须显式填写”的字段,推荐填写不高于实际核心版本的值。

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
  • collection
  • config

推荐完整示例

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"
}

贡献者

The avatar of contributor named as minecraft1024a minecraft1024a

页面历史

Released under the GPL-3.0 License.

AI 助手

有什么可以帮您的吗?