简要总结
Plugin Manifest
这页说明书在讲一个叫“插件清单”的小文件。每个插件都必须有这个小文件,它就像插件的“身份证”和“使用说明书”。OpenClaw 会先看这个文件,检查插件能不能正常工作,而不用真的去运行插件。如果没有它或者它写错了,插件就不能用哦。如果你想知道怎么做一个插件,可以看看这页。
五岁小孩版解释
每个插件都是一个能让 OpenClaw 变得更厉害的小工具。为了让 OpenClaw 认识这个小工具,我们需要给它准备一个“身份证”文件,名字必须是 openclaw.plugin.json,而且要放在插件文件夹的最外面。
这个文件里必须写两样最重要的东西:
id:这是插件的名字,比如可以叫"voice-call"(语音通话)。这个名字是唯一的,不能和其他插件重复。configSchema:你可以把它想成是插件的“设置说明书”。它用一种叫 JSON Schema 的格式,告诉 OpenClaw 这个插件需要哪些设置。即使插件不需要任何设置,这个“说明书”也不能少,可以写一个空的。
除了必须写的东西,你还可以告诉 OpenClaw 更多关于插件的信息,这些都是可选的:
kind:插件是哪种类型的?比如是管记忆的 ("memory"),还是管理解对话的 ("context-engine")。channels:这个插件能在哪些“频道”里工作?比如["matrix"]。providers:这个插件注册了哪些“供应商”。skills:这个插件要加载哪些“技能”文件夹。name:一个更好听、更容易懂的名字。description:用一两句话介绍一下这个插件是干什么的。uiHints:这里可以写一些提示,告诉显示设置的界面该怎么画。version:插件的版本号,比如"1.0.0"。
要小心的事情:
- 这个清单文件所有插件都必须有,一个都不能少。
- 如果你在设置里写了某个“频道”或者“插件名字”,但这个频道或插件根本没被任何清单声明过,那就会出错。
- 如果一个插件被安装了,但它的清单文件坏了、丢了,或者“设置说明书”不对,那么整个检查就会失败,Doctor(系统医生)会报告这个插件有问题。
- 如果一个插件的设置还在,但这个插件被关掉了,设置会被保留,但 Doctor 和日志里会给你一个警告提醒。
其他重要的事:
- 系统运行的时候,还是会去加载插件自己的代码,这个清单文件只是用来“认识”插件和检查设置的。
- 有些特殊类型的插件,需要通过
plugins.slots.*这样的设置来选中。比如,kind: "memory"的插件由plugins.slots.memory来选。 - 如果你的插件需要一些特别的、不是用 JavaScript 写的代码(原生模块),记得在你的插件说明里写下怎么安装它们。