插件开发指南

AmritaBot 基于 NoneBot2 的插件系统，支持开发自定义插件来扩展机器人功能。

创建新插件

使用插件模板仓库

使用官方插件模板仓库作为起点：

• 访问 AmritaBot 插件模板仓库
• 克隆仓库到本地
• 根据模板中的说明进行自定义开发

直接创建 NoneBot2 插件

AmritaBot 兼容所有 NoneBot2 插件规范。在项目根目录 plugins/ 下创建 Python 包即可：

plugins/
└── my_plugin/
    ├── __init__.py
    └── handlers.py

然后在 pyproject.toml 中注册：

[tool.amrita]
plugins = [
    "amrita.plugins.chat",
    "amrita.plugins.perm",
    "my_plugin",  # 新增
]

系统要求

在开始插件开发之前，请确保您的开发环境满足以下要求：

• Python 版本: 3.10 或更高版本
• 包管理工具: 安装 uv 或 pip

推荐使用 uv 作为包管理工具，它提供了更快的依赖解析和安装速度。

命名规范

对于 AmritaBot 插件建议遵循统一的命名规范：

• 插件包名必须以 amrita_plugin_ 为前缀
• 例如：amrita_plugin_weather、amrita_plugin_reminder

这种命名约定有助于：

• 避免包名冲突
• 便于用户识别 AmritaBot 官方或社区插件
• 简化插件发现和安装过程

开发流程

1. 创建插件项目（使用上述任一方法）
2. 实现插件功能
3. 编写测试用例
4. 打包并发布（可选）

详细的 API 文档和示例请参考 API 参考。