Skip to content

安装和管理插件

插件就像给 MaiBot 安装"App",让它拥有更多功能!

什么是插件?

插件是 MaiBot 的扩展功能,比如:

  • 🎮 游戏插件 - 能陪用户玩游戏
  • 🎨 画图插件 - 能生成图片
  • 🎵 音乐插件 - 能播放音乐
  • 🌤️ 天气插件 - 能查天气预报
  • 📚 学习插件 - 能教知识

安装插件

方法一:在线安装(推荐)

  1. 打开 WebUI,点击"插件管理"
  2. 点击"安装插件"按钮
  3. 输入插件地址(GitHub 链接)
  4. 点击"安装",等待完成

示例地址

https://github.com/作者/插件名

方法二:Git URL 安装

  1. 获取插件的 Git 仓库地址(GitHub 等)
  2. 在插件管理页面点击"安装插件"
  3. 输入 Git 仓库 URL
  4. 点击"安装",等待完成

注:当前仅支持通过 Git 仓库 URL 安装插件,不支持本地文件上传

管理已安装插件

查看插件

插件页面会显示:

  • 📋 插件名称 和简介
  • 🔧 版本号 和作者
  • 启用状态(绿色=启用,灰色=禁用)
  • 📖 使用说明(点击可看)

启用/禁用插件

  • 开关打开 → 运行时加载该插件
  • 开关关闭 → 调用卸载生命周期并停用插件
  • 正常情况下立即生效,不需要重启整个 MaiBot

配置插件

有些插件可以自定义设置:

  1. 点击插件的"设置"按钮
  2. 修改配置选项
  3. 保存后,运行时调用插件的配置更新生命周期

常见配置

  • API 密钥(需要外部服务的插件)
  • 触发关键词
  • 功能开关

更新插件

插件有新版本时会显示更新提示:

  1. 点击"更新"按钮
  2. 等待下载和安装
  3. 源码变化会触发插件 Supervisor 重启并重新加载插件

同一个插件不能同时执行安装、更新或卸载。如果页面提示该插件正在执行其他操作,请等待当前进度结束后重试;不同插件可以同时处理。

卸载插件

不需要的插件可以卸载:

  1. 点击"卸载"按钮
  2. 确认卸载
  3. 插件文件会被删除

⚠️ 注意:卸载后插件的数据可能会丢失

实际生命周期与重启边界

安装 — 文件写入插件目录后,文件监听器会发现新插件。Runner 根据插件 config_model 中的默认值生成 config.tomlenabled 默认为 false 的插件需要在安装后手动打开开关。

启用与禁用 — 运行时分别加载或卸载插件,无需重启 MaiBot。

修改配置 — 已加载插件会收到 on_config_update。如果配置把插件设为禁用,运行时会卸载它;把未加载插件设为启用,则会加载它。

更新源码.pyplugin.py_manifest.json 变化会重启插件 Supervisor。更新期间插件会短暂不可用,但 MaiBot 核心无需重启。

卸载 — WebUI 先禁用并卸载插件,再删除文件。卸载前请确认插件是否把用户数据放在自身目录中。

重启只是故障兜底

如果日志明确显示文件监听、加载、卸载或配置回调失败,再完整重启 MaiBot。正常的插件管理流程不应把重启核心当作必需步骤。

插件推荐

新手必备

  • 欢迎插件 - 新用户入群自动欢迎
  • 帮助插件 - 提供命令帮助
  • 签到插件 - 每日签到功能

娱乐向

  • 抽卡插件 - 模拟各种抽卡
  • 骰子插件 - 掷骰子游戏
  • 猜谜插件 - 猜谜语、脑筋急转弯

实用向

  • 翻译插件 - 多语言翻译
  • 计算插件 - 数学计算
  • 时间插件 - 时间日期查询

使用技巧

插件冲突

如果插件功能重复或冲突:

  • 只启用需要的插件
  • 联系插件作者更新

性能优化

插件太多可能影响性能:

  • 不用的插件及时卸载
  • 定期清理无用插件
  • 关注插件资源占用

安全提醒

  • 只安装可信来源的插件
  • 查看插件权限要求
  • 定期更新插件版本

常见问题

Q: 插件安装失败怎么办? A: 检查网络连接,确认插件地址正确,查看错误提示

Q: 插件不起作用? A: 确认插件已启用,检查配置是否正确,查看 MaiBot 日志

Q: 哪里找插件? A: GitHub 上搜索"MaiBot 插件",或者加入社区获取推荐

Q: 能自己开发插件吗? A: 当然可以!有开发文档和示例代码,零基础也能学

获取帮助

  • 插件页面有使用说明
  • 查看插件的 README 文档
  • 加入 MaiBot 交流群询问
  • 在 GitHub 提交问题