入门指南
Tip
什么时候需要读这篇:机器人已经用 5 分钟快速开始 跑起来了,想系统理解框架的核心概念、把常用能力学全。还没跑起来先去完成快速开始;只想按需查某个问题则直接跳到对应单篇。
机器人跑起来之后,这里带你系统理解框架的核心概念和常用能力。
学习路径
以下即文档首页定义的 L1 核心五篇——按顺序读完(约 1–2 小时)即可独立开发 90% 的功能:
| 步骤 | 主题 | 说明 |
|---|---|---|
| 1 | 模块开发入门 | 创建独立模块包,理解模块结构与注册机制 |
| 2 | 基础概念 | 理解 ErisPulse 的核心架构和模块设计 |
| 3 | Event 包装类 | 掌握事件对象的回复、请求与字段访问 |
| 4 | 配置文件说明 | 会填配置、懂热更新与环境变量覆盖 |
| 5 | 异常捕获 | 认识框架异常层级,写出不崩的处理链 |
本目录内还有几篇按需查阅的配套文档:
| 文档 | 什么时候读 |
|---|---|
| 创建第一个机器人 | 想先动手写一个嵌入式处理器,再学模块化开发 |
| 事件处理入门 | 需要按事件类型(消息 / 命令 / 通知 / 请求)速查处理方式 |
| 常见任务示例 | 要复制存储、定时任务、权限控制的现成完整代码 |
| IDE 补全指南 | 想要平台专有方法的 IDE 自动补全 |
开发方式选择
ErisPulse 支持两种开发方式:
| 方式 | 适用场景 | 说明 |
|---|---|---|
| 嵌入式开发 | 快速原型、项目内部功能 | 直接在 main.py 中编写处理器,无需创建独立模块 |
| 模块开发(推荐) | 生产环境、功能分发 | 创建独立的 Python 包,通过 epsdk install 安装使用 |
架构概览
ErisPulse 采用事件驱动架构,核心由以下系统组成:
- 适配器系统 — 与各平台通信,将平台事件转换为统一的 OneBot12 标准格式
- 事件系统 — 处理消息、命令、通知、请求、元事件五大类事件
- 模块系统 — 通过独立模块扩展功能,支持依赖管理和懒加载
- 核心模块 — 提供 Storage(存储)、Config(配置)、Logger(日志)、Router(路由)等基础能力
详细的架构图和初始化流程请参考 架构概览。
下一步
按上面的学习路径(L1 核心五篇)顺序读即可。也可以按你的目的直接跳: