doc：完善doc
This commit is contained in:
SengokuCola
@@ -2,157 +2,42 @@
|
||||
|
||||
> 欢迎来到MaiBot插件系统开发文档！这里是你开始插件开发旅程的最佳起点。
|
||||
|
||||
## 🎯 快速导航
|
||||
|
||||
### 🌟 新手入门
|
||||
## 新手入门
|
||||
|
||||
- [📖 快速开始指南](quick-start.md) - 5分钟创建你的第一个插件
|
||||
|
||||
## 组件功能详解
|
||||
|
||||
- [🧱 Action组件详解](action-components.md) - 掌握最核心的Action组件
|
||||
- [💻 Command组件详解](command-components.md) - 学习直接响应命令的组件
|
||||
- [⚙️ 配置管理指南](configuration-guide.md) - 学会使用配置驱动开发
|
||||
|
||||
### 📖 API参考
|
||||
- [🔧 工具系统详解](tool-system.md) - 工具系统的使用和开发（非主要功能）
|
||||
|
||||
- [📡 消息API](api/message-api.md) - 消息发送接口
|
||||
## API浏览
|
||||
|
||||
### 🔧 高级主题
|
||||
### 🔗 核心通信API
|
||||
- [📡 消息API](api/message-api.md) - 消息接收和处理接口
|
||||
- [📤 发送API](api/send-api.md) - 各种类型消息发送接口
|
||||
- [💬 聊天API](api/chat-api.md) - 聊天流管理和查询接口
|
||||
|
||||
- [📦 依赖管理系统](dependency-management.md) - Python包依赖管理
|
||||
- [🔧 工具系统详解](tool-system.md) - 工具系统的使用和开发
|
||||
### 🤖 AI与生成API
|
||||
- [🧠 LLM API](api/llm-api.md) - 大语言模型交互接口
|
||||
- [✨ 回复生成器API](api/generator-api.md) - 智能回复生成接口
|
||||
- [😊 表情包API](api/emoji-api.md) - 表情包选择和管理接口
|
||||
|
||||
## 🔥 最新更新 (v2.0 新API格式)
|
||||
### 📊 数据与配置API
|
||||
- [🗄️ 数据库API](api/database-api.md) - 数据库操作接口
|
||||
- [⚙️ 配置API](api/config-api.md) - 配置读取和用户信息接口
|
||||
- [👤 个人信息API](api/person-api.md) - 用户信息查询接口
|
||||
|
||||
### 🎉 重大变更
|
||||
### 🛠️ 工具API
|
||||
- [🔧 工具API](api/utils-api.md) - 文件操作、时间处理等工具函数
|
||||
|
||||
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` 轻松调用
|
||||
- **灵活配置**：支持多种生成风格和参数
|
||||
|
||||
## 📋 开发清单
|
||||
|
||||
在开始开发之前，确保你已经：
|
||||
|
||||
- [ ] 阅读了[快速开始指南](quick-start.md)
|
||||
- [ ] 了解了Action组件或Command组件
|
||||
- [ ] 熟悉了[Action组件](action-components.md)或[Command组件](command-components.md)
|
||||
- [ ] 查看了[配置管理](configuration-guide.md)
|
||||
|
||||
开发完成后，请检查：
|
||||
|
||||
- [ ] 使用了新的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集成示例
|
||||
- **用户管理系统**：配置驱动的复杂功能
|
||||
- **定时提醒插件**：状态管理和持久化
|
||||
|
||||
### 🚀 高级应用
|
||||
|
||||
- **多功能聊天助手**：综合功能展示
|
||||
- **游戏管理插件**：复杂状态管理
|
||||
- **数据分析插件**：外部服务集成
|
||||
|
||||
---
|
||||
|
||||
**🎉 准备好开始了吗？从[快速开始指南](quick-start.md)开始你的插件开发之旅！**
|
||||
|
||||
使用新的API格式，你可以创建更强大、更智能、更易维护的插件。让我们一起构建更好的MaiBot生态系统！
|
||||
4. 提交文档仓库issue
|
||||
|
||||
Reference in New Issue
Block a user