简体中文 English 繁體中文 日本語 Русский
本文为静态镜像，内容以交互版为准 在交互式文档中心打开 →

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 支援兩種開發方式：

其他

獲取幫助

相關連結