PLUGINS

AWBotNest-Plugins

AWBotNest 官方插件仓库,负责平台插件的组织方式、版本更新、市场清单与开发契约。

PROJECT INTRO

项目介绍

这个仓库不是终端用户直接运行的应用,而是 AWBotNest 平台的官方插件来源。它定义插件元数据、配置 schema、依赖声明和市场清单,是平台生态的重要组成部分。

适合谁看

  • 准备为 AWBotNest 开发插件的人
  • 维护插件市场与 manifest 的人
  • 需要理解平台插件机制的人

插件开发流程

  1. 复制平台模板插件或现有插件。
  2. 把文件命名成唯一插件 ID,例如 my_feature.py
  3. 完善 __plugin__ 元数据,确保 id 与文件名一致。
  4. setup(ctx) 中通过 ctx.on_messagectx.on_callback 注册逻辑。
  5. config_schema 定义配置面板。
  6. requirements 声明第三方依赖。
  7. 把插件放入平台本地目录,或提交仓库并更新 manifest.json
  8. 在 AWBotNest 控制台中安装并启用插件。

规范重点

必须遵守

  • 文件名与插件 ID 一致
  • 只通过 ctx 访问平台能力
  • 业务参数统一走 config_schema

避免做法

  • 直接导入平台内部核心模块
  • 插件里手动执行 pip
  • 绕过平台直接注册底层监听

使用方式

普通平台用户一般不需要单独部署这个仓库。AWBotNest 会把它作为内置插件市场来源自动接入,用户只需要在后台中安装和启用插件。

如果你是插件开发者,则需要维护 manifest.json 和版本号,确保平台能识别更新并完成热重载。