Skip to content

插件开发指南

Amrita 提供了完整的插件开发支持,让开发者能够轻松扩展机器人的功能。

创建新插件

使用命令行工具

在已有项目中,可以使用以下命令创建一个新的 demo 插件:

bash
amrita plugin new

该命令会引导您完成插件的基本配置,并生成一个可运行的插件模板。

使用插件模板仓库

您也可以直接使用我们的官方插件模板仓库作为起点:

系统要求

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

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

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

命名规范

对于错Amrita 插件建议遵循统一的命名规范:

  • 插件包名必须以 amrita_plugin_ 为前缀
  • 例如:amrita_plugin_weatheramrita_plugin_reminder

这种命名约定有助于:

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

开发流程

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

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

MIT License 发布