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.8 KiB

Raw Blame History

サンプルプラグイン

サンプルはリポジトリの examples/plugins/ にあります。Docker イメージには含まれません。各サンプルに README とテストがあり、CI が 1 つずつ実行します。

サンプル	内容
`webhook-on-event`	`@subscribe("*")`、設定フォーム、`secret_field`。選んだイベントを URL に POST します。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.8 KiB Raw Blame History

サンプルプラグイン

サンプルをインストールする

サンプルのテストを実行する

1.8 KiB

Raw Blame History