插件开发入门
July 26, 2026 · View on GitHub
本页给出从零到可发布插件的阅读顺序。若你只想尽快跑通一条群命令，直接去 写第一个插件。
推荐顺序
| 步骤 | 文档 |
|---|---|
| 1. 跟做最小插件 | 写第一个插件 |
| 2. 定骨架 | Golden Plugin |
| 3. 公开 API | pallas.api Cookbook |
| 4. 配置 / 权限 / 元数据 | 配置与 WebUI · cmd_perm · 元数据 |
| 5. 测试与发布 | 测试 · 发布 |
热载策略、分片守卫、官方 PyPI 等可在验收通过后再学。
放置位置
| 类型 | 路径 |
|---|---|
| 站点私有 / 试验 | local/plugins/（首插件从这里开始） |
| 内置 core | packages/ |
| 官方 / 社区扩展 | 独立仓库 |
完成定义
| 项 | 要求 |
|---|---|
| API | 社区扩展只 import pallas.api.* |
| 入口 | __init__.py 薄；逻辑在 handlers.py |
| 权限 / 帮助 | command_permissions + menu_data；文案不写死角色 |
| 配置 | 有插件页则 install_hot_reload_config |
| 测试 / README | 最小 metadata 测试 + README |
硬约束
| MUST | MUST NOT |
|---|---|
pallas.api.* | pallas.core.* / 旧 src.*（社区） |
| 命令 ID 全链路一致 | 帮助文案写死「仅群管」等 |
| 配置走统一热载 | 模块级长期缓存 get_config() |