開發者指南
本指南協助您開發自訂模組和適配器,以擴充 ErisPulse 的功能。
內容列表
模組開發
- 模組開發入門 - 創建第一個模組
- 模組核心概念 - 模組的核心概念和架構
- Event 包裝類詳解 - Event 物件的完整說明
- 模組最佳實踐 - 開發高品質模組的建議
資料模型
- 資料模型層(ORM) - 聲明式模型、自動建表與增刪改查
適配器開發
- 適配器開發入門 - 創建第一個適配器
- 適配器核心概念 - 適配器的核心概念
- SendDSL 詳解 - Send 消息發送 DSL 的完整說明
- 事件轉換器 - 實現事件轉換器
- 適配器最佳實踐 - 開發高品質適配器的建議
測試與排查
- 模組測試(ErisPulse-Testing) - TestBot、事件工廠與斷言面
- 模組排查指南 - 模組未加載 / 事件未響應 / 命令未觸發的定位方法
發布指南
- 發布與模組商店指南 - 將你的作品發布到 PyPI 和 ErisPulse 模組商店
開發準備
在開始開發之前,請確保你:
開發類型選擇
根據你的需求選擇合適的開發類型:
如果你想擴展機器人的功能(如新增命令、處理訊息),選擇模組開發。如果你需要讓機器人連接到一個新的平台,選擇適配器開發。
開發工具
項目模板
ErisPulse 提供了示例項目作為參考:
開發模式
使用熱重載模式進行開發,程式碼修改後自動重新載入:
epsdk run main.py --reload
調試技巧
在 config/config.toml 中啟用 DEBUG 或 TRACE 級別日誌:
[ErisPulse.logger]
# DEBUG: 輸出模組載入、路由註冊等開發調試資訊
# TRACE: 最低級別,輸出事件分發、儲存寫入、懶加載等框架內部詳細流程
level = "DEBUG"
發布你的模組
完整的發布流程請參考 發布與模組商店指南,包括 PyPI 發布步驟、ErisPulse 模組商店提交流程等。