ErisPulse 文档
ErisPulse 是一个可扩展的多平台消息处理框架，支持通过适配器与不同平台交互，提供灵活的模块系统用于功能扩展。
第一次使用? 直接看 5 分钟快速开始 —— 从安装到运行第一个机器人，一条龙走完。
选择你的路径
根据你的目标，选择对应的学习路径。每条路径内部按由浅入深排列。
一、我要使用机器人
让机器人跑起来、装模块、做配置。
| 进度 | 文档 | 说明 |
|---|---|---|
| ① 上手 | 5 分钟快速开始 | 安装、初始化、运行 —— 唯一的起步入口 |
| App 直装 | ErisPulse-App 客户端 | 官方全平台客户端：手机 / 电脑图形界面直接运行与管理，免终端 |
| ② 深入 | 创建第一个机器人 | 编写第一个命令处理器 |
| ③ 概念 | 基础概念 | 理解适配器/模块/事件的设计 |
| ④ 实战 | 常见任务示例 | 存储、定时任务、权限控制 |
| 参考 | 配置文件说明 · CLI 命令 · 部署指南 | 按需查阅 |
| 参考 | 平台特性指南 | 各平台（云湖/QQ/Telegram…）的差异 |
二、我要开发模块 / 适配器
为 ErisPulse 编写可分发的扩展。
| 类型 | 入门 | 进阶 |
|---|---|---|
| 模块开发（推荐） | 模块开发入门 | 核心概念 · Event 包装类 · 最佳实践 |
| 适配器开发 | 适配器开发入门 | 核心概念 · SendDSL 详解 · 事件转换器 · 最佳实践 |
| 技术标准 | 标准规范总览 | 适配器开发必须遵循的 会话类型 · 事件转换 · 发送方法 · API 响应 · 请求操作 规范 |
| 测试与排查 | 模块测试（ErisPulse-Testing） | 分发决策链排查"命令为什么没触发" |
| 发布 | 发布与模块商店 | 将作品发布到 PyPI 和模块商店 |
三、我要深入理解原理
了解框架内部如何运作。
| 文档 | 说明 |
|---|---|
| 架构概览 | 可视化图表：核心架构、初始化流程、事件处理、生命周期、模块加载策略（含 activate_on 事件驱动懒激活）、本地插件文件夹与模块热重载架构（支持全部模块来源） |
| 启动流程与手动控制 | 启动链路拆解、手动驱动各环节、加载失败诊断 |
| 事件系统 | 五大类事件的完整 API |
| 适配器系统 | 适配器注册、启停、API 调用 |
| 核心模块 | Storage / Config / Logger / Router 等基础能力 |
| 生命周期管理 · 懶加载 · 路由系统 | 内部子系统 |
| 作用域（scope） | 三维作用域控制：模块可用性 / 事件准入 / 出站动作限制（含方法级细粒度规则、绑定继承 merge） |
| 归属权（owner）系统 | 资源归属与自动回收：owner 上下文、归属资源全景、卸载清理序列、设计边界与模块作者指南 |
| 影子模块与灰度转正 | 模块新版本以独立 owner 并行试运行：五道隔离闸、行为 diff 对齐、promote 转正与失败回滚 |
| 交互会话系统 | wait_reply 全解、会话定时器（remind/escalate）、多路等待（select）、会话互斥租约、收件箱、消息事务、链路追踪 |
| 模块间通信 | RPC 协议化（module.call）、meta.services 服务契约与目录、定向事件 emit(to=)、冷启动回放、事件幂等去重 |
| Conversation 多轮对话 · MessageBuilder · SQL 构建 · 存储后端 · HTTP 客户端 · 国际化 | 进阶工具 |
四、生态与官方客户端
官方客户端 + 按需安装、即装即用的生态模块（都不是框架内置功能）。
| 文档 | 说明 |
|---|---|
| 生态总览 | 如何安装生态模块、为什么这些不是内置功能 |
| ErisPulse-App | 官方全平台客户端（Android / Windows / Linux / macOS）：原生界面管理多个实例，手机直接运行，桌面托盘常驻 |
| ErisPulse-Dashboard | Web 管理面板 + 视窗注册 API（模块可向侧边栏注册自定义页面） |
| ErisPulse-Cron | 定时任务调度模块：一次性 / 间隔 / Cron 表达式，回调传参，SQLite 持久化，其他模块可托管定时回调 |
| ErisPulse-Takumi | 图片渲染（HTML / 节点树 / SVG / 动画，内置中英文字体） |
五、我要为 ErisPulse 贡献
让框架更好
| 文档 | 说明 |
|---|---|
| 为 ErisPulse 贡献 | 贡献方式总览：文档 / i18n / Bug / 模块 / 适配器 |
| 首次贡献 | 从 fork 到提交 PR |
开发方式
ErisPulse 支持两种开发方式：
- 模块开发（推荐）：创建独立的模块包，通过包管理器安装，便于分发和管理。
- 嵌入式开发：直接在项目中编写处理器，适合快速原型。详见 快速开始。
其他
- 文档风格指南 — 贡献文档时的写作规范
- 为 ErisPulse 贡献 — 参与项目共建的入口
- AI 辅助开发 — 获取供 AI 编程助手使用的项目提示词
获取帮助
- GitHub 仓库：https://github.com/ErisPulse/ErisPulse
- 问题反馈：提交 Issue
- 技术讨论：查看 Discussions