mirror of https://github.com/EstrellaXD/Auto_Bangumi.git synced 2026-10-29 11:46:17 +08:00

Files

Estrella Pan 3258fcca4b docs(4.0-P7): 插件开发文档拆分为总览加每个扩展点一页，补齐中英日三语

- docs/dev/plugins.md 改为总览与导航，旧内容拆入 docs/dev/plugins/
- 新增核心概念、配置表单、事件、前端挂载点、命令行、签名与分发、内置插件、示例页
- 每个扩展点一页，侧边栏由页面表生成
- 改正旧文档中下载器配置、hardlink path_map 与补链按钮的过时描述

2026-10-08 14:51:00 +02:00

1.4 KiB

Raw Blame History

示例插件

示例在仓库的 examples/plugins/ 下，不包含在 Docker 镜像里。每个示例都有自己的 README 和测试，CI 逐个运行。

示例	演示的能力
`webhook-on-event`	`@subscribe("*")`、配置表单、`secret_field`；把选中的事件 POST 到一个 URL，可选 HMAC 签名
`custom-rss-site`	`search_site` Provider 加 `http.request` 钩子；为私有站的请求附带 Cookie；`SearchSiteContract`
`template-rename`	`rename_strategy` Provider，自带过滤器的文件名模板；`RenameSkipped`；`RenameStrategyContract`
`nfo-writer`	订阅 `torrent.organized`，在正片旁写 `.nfo`；路径映射；幂等
`ntfy-notifier`	`notifier` Provider；后端拒绝时返回 `False`；`NotifierContract`
`manual-pick`	前端挂载点 `bangumi.detail.tab`、插件路由、插件 KV、事件

安装一个示例

cp -r examples/plugins/ntfy-notifier config/plugins/local/

在设置 → 插件中开启「允许未签名插件」，再启用该插件。

运行示例的测试

cd examples/plugins/ntfy-notifier && uv run pytest
# 或一次跑完全部示例（在仓库根目录）：
scripts/test_example_plugins.sh

刷新 Jellyfin / Emby / Plex 媒体库不需要写插件：内置插件 media-server-refresh 已经支持。

1.4 KiB Raw Blame History Unescape Escape

示例插件

安装一个示例

运行示例的测试

1.4 KiB

Raw Blame History