Skip to content

MaiBot插件开发文档

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

新手入门

组件功能详解

Command vs Action vs Tool选择指南

  1. 使用Command的场景
  • ✅ 用户需要明确调用特定功能
  • ✅ 需要精确的参数控制
  • ✅ 管理和配置操作
  • ✅ 查询和信息显示
  1. 使用Action的场景
  • ✅ 增强麦麦的智能行为
  • ✅ 根据上下文自动触发
  • ✅ 情绪和表情表达
  • ✅ 随机化的互动
  1. 使用Tool的场景
  • 直接为麦麦提供信息
  • 在回复时提供更多可用信息
  • 简单易用,功能专一

API浏览

消息发送与处理API

AI与生成API

  • LLM API - 大语言模型交互接口,可以使用内置LLM生成内容
  • ✨ 回复生成器API - 智能回复生成接口,可以使用内置风格化生成器

表情包API

关系系统API

  • 人物信息API - 用户信息,处理麦麦认识的人和关系的接口

数据与配置API

插件和组件管理API

日志API

工具API

一个方便的小设计

我们在__init__.py中定义了一个__all__变量,包含了所有需要导出的类和函数。 这样在其他地方导入时,可以直接使用 from src.plugin_system import * 来导入所有插件相关的类和函数。 或者你可以直接使用 from src.plugin_system import BasePlugin, register_plugin, ComponentInfo 之类的方式来导入你需要的部分。