Files
Mofox-Core/docs/plugins
墨梓柒 1fab6dc710 feat: 添加新的插件和清单管理工具
- 引入了“hello_world_plugin”和“take_picture_plugin”及其各自的清单文件。
- 实现了“manifest_tool.py”,用于创建、验证和管理插件清单。
- 添加了“test_version_compatibility.py”,用于测试版本规范化、比较和兼容性检查。
- 增强了“manifest_utils.py”,增加了版本比较和验证功能。
2025-06-19 23:13:06 +08:00
..
2025-06-15 23:30:53 +08:00

MaiBot插件开发文档

欢迎来到MaiBot插件系统开发文档这里是你开始插件开发旅程的最佳起点。

🎯 快速导航

🌟 新手入门

📖 API参考

🔧 高级主题

🔥 最新更新 (v2.0 新API格式)

🎉 重大变更

  1. 新API格式

    • 不再使用 self.api,改为直接方法调用
    • await self.send_text() 替代旧的发送方式
    • await self.send_emoji() 专门的表情发送方法
    • self.get_config() 简化的配置访问
  2. replyer_1集成

    • 新增专用的 generator_api 模块
    • 在Action中直接使用 replyer_1 生成个性化内容
    • 支持多种生成风格和情感色彩
  3. 更好的类型安全

    • 完整的类型注解支持
    • 更清晰的返回值类型
    • 更好的IDE支持

🚀 最佳学习路径

📚 初学者路径(推荐)

  1. 基础入门

    快速开始指南 → Action组件详解 → Command组件详解
    
  2. API掌握

    消息API指南 → 配置管理指南
    
  3. 高级功能

    依赖管理系统 → 工具系统详解
    

💡 核心概念速览

🧱 Action组件

  • 用途:增强麦麦的主动行为,让对话更自然
  • 激活关键词、LLM判断、随机等多种方式
  • 新特性支持replyer_1智能生成、更简洁的API

💻 Command组件

  • 用途:响应用户的明确指令,提供确定性功能
  • 触发:正则表达式匹配用户输入
  • 特点:即时响应、参数解析、拦截控制

⚙️ 配置系统

  • Schema驱动使用ConfigField定义配置结构
  • 类型安全:强类型配置验证
  • 嵌套访问:支持 section.key 形式访问

🧠 replyer_1集成

  • 智能生成AI驱动的个性化内容生成
  • 简单易用:通过 generator_api 轻松调用
  • 灵活配置:支持多种生成风格和参数

📋 开发清单

在开始开发之前,确保你已经:

开发完成后,请检查:

  • 使用了新的API格式self.send_text()等)
  • 正确配置了Schema和ConfigField
  • 添加了适当的错误处理
  • 测试了所有功能路径

🤝 获取帮助

📖 文档问题

如果你在文档中发现错误或需要补充,请:

  1. 检查最新的文档版本
  2. 查看相关示例代码
  3. 参考其他类似插件

💻 开发问题

遇到开发问题时:

  1. 查看现有插件示例
  2. 检查配置是否正确
  3. 参考API文档

🎯 最佳实践建议

为了创建高质量的插件:

  1. 始终使用新的API格式
  2. 充分利用replyer_1的智能生成能力
  3. 设计配置驱动的功能
  4. 实现完善的错误处理
  5. 编写清晰的文档注释

🌟 推荐插件示例

🎯 新手友好

  • Hello World插件展示基础API使用
  • 简单计算器Command组件入门
  • 智能问候Action组件和replyer_1集成

🔧 实用工具

  • 智能聊天助手完整的replyer_1集成示例
  • 用户管理系统:配置驱动的复杂功能
  • 定时提醒插件:状态管理和持久化

🚀 高级应用

  • 多功能聊天助手:综合功能展示
  • 游戏管理插件:复杂状态管理
  • 数据分析插件:外部服务集成

🎉 准备好开始了吗?从快速开始指南开始你的插件开发之旅!

使用新的API格式你可以创建更强大、更智能、更易维护的插件。让我们一起构建更好的MaiBot生态系统