主项目自带的功能放在 yuiChyan/core/,第三方插件放在 yuiChyan/plugins/,两者分开管理。
本文只介绍主项目提供的安装方式。第三方插件的功能、依赖和配置,请看各插件自己的说明。
可以查看 第三方插件列表。列表不代表兼容性保证,安装前请确认插件支持当前项目版本,并只运行可信来源的代码。
- 按插件说明下载文件,放入
yuiChyan/plugins/。 - 按插件说明安装额外依赖、填写它需要的配置。绿色包只带主项目依赖,不保证能直接运行所有插件。
- 在
yuiChyan/config/extra_plugins.json5中添加插件文件夹名和显示名称。 - 重启机器人,检查日志中有没有加载错误。
例如,假设插件文件夹叫 my_plugin,放好后应是:
yuiChyan/plugins/my_plugin/__init__.py
对应配置写成:
{
"my_plugin": "我的插件",
}这是安装格式示例,不是项目附带的插件。已有其他条目时,在原文件中添加,不要覆盖整份配置,也不要漏掉条目之间的英文逗号。
如果只想在某个群关闭一个功能,由有相应权限的账号在群里发送 @BOT禁用服务 服务名。服务名可以先用 @BOT服务列表 查询,它不一定与插件文件夹名相同。
如果不再加载整个插件,从 extra_plugins.json5 中删除对应条目,然后重启机器人。确认不再需要后,可以删除插件文件夹;插件留下的数据要按它自己的说明处理。
已登记插件的根目录有 HELP.md 时,主项目会把它加入帮助网页。插件还可以设置帮助命令,把帮助内容作为图片发送。
自己编写插件可参考 插件开发,帮助格式见 HELP.md 编写规范。