入門指南
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 核心五篇)順序讀即可。也可以按你的目的直接跳: