入门指南
本指南是 5 分钟快速开始 的深入补充。如果你还没跑起第一个机器人,请先完成快速开始。
机器人跑起来之后,这里带你系统理解框架的核心概念和常用能力。
学习路径
建议按以下顺序阅读:
| 步骤 | 主题 | 说明 |
|---|---|---|
| 1 | 创建第一个机器人 | 编写命令处理器,理解运行机制 |
| 2 | 基础概念 | 理解 ErisPulse 的核心架构和模块设计 |
| 3 | 事件处理入门 | 学习如何处理消息、命令、通知等各类事件 |
| 4 | 常见任务示例 | 掌握数据持久化、定时任务、权限控制等常用功能 |
| 5 | IDE 补全指南 | 生成类型存根,启用平台特有方法的 IDE 自动补全 |
开发方式选择
ErisPulse 支持两种开发方式:
| 方式 | 适用场景 | 说明 |
|---|---|---|
| 嵌入式开发 | 快速原型、项目内部功能 | 直接在 main.py 中编写处理器,无需创建独立模块 |
| 模块开发(推荐) | 生产环境、功能分发 | 创建独立的 Python 包,通过 epsdk install 安装使用 |
架构概览
ErisPulse 采用事件驱动架构,核心由以下系统组成:
- 适配器系统 — 与各平台通信,将平台事件转换为统一的 OneBot12 标准格式
- 事件系统 — 处理消息、命令、通知、请求、元事件五大类事件
- 模块系统 — 通过独立模块扩展功能,支持依赖管理和懒加载
- 核心模块 — 提供 Storage(存储)、Config(配置)、Logger(日志)、Router(路由)等基础能力
详细的架构图和初始化流程请参考 架构概览。
开始学习
准备好开始了吗?
- 创建第一个机器人 — 5 分钟上手