由於 官方文檔 過於簡陋、部分內容已過時，甚至還有互相衝突的部分，特此撰寫本文以記錄使用方式

# 關於 AutoBangumi

本項目是基於 Mikan Project、qBittorrent 的全自動追番整理下載工具。只需要在 Mikan Project 上訂閱番劇，就可以全自動追番。並且整理完成的名稱和目錄可以直接被 Plex、Jellyfin 等媒體庫軟件識別，無需二次刮削。

這是 AutoBangumi 官方的描述，簡單地說，就是生成相應的 RSS 規則並導入至 qBittorrent，命中規則的將下載到規則中設定的路徑，並在下載完成後自動重命名以符合 Emby、Plex、Jellyfin 的命名規範，以提高自動刮削的成功率。

# 部署 AutoBangumi

這裡使用 Docker 進行部署，以避免出現各種奇怪的問題導致部署失敗

# 使用 Docker 部署 AutoBangumi

docker run -d \

	--name=AutoBangumi \

	-p 7892:7892

	-v /docker/auto-bangumi/config:/config \

	-e AB_WEBUI_PORT=7892 \ 

	-e TZ=Asia/Taipei \ 

	-e AB_INTERVAL_TIME=120 \ 

	-e AB_RENAME_FREQ=4 \ 

	-e AB_DOWNLOADER_HOST=<http://IP:Port> \ 

	-e AB_DOWNLOADER_USERNAME=<username> \ 

	-e AB_DOWNLOADER_PASSWORD=<password> \ 

	-e AB_METHOD=pn \ 

	-e AB_GROUP_TAG=True \ 

	-e AB_DOWNLOAD_PATH=/downloads/auto-bangumi \ 

	-e AB_RSS=<RSS ADDRESS> \ 

	-e AB_NOT_CONTAIN=720 \ 

	-e AB_DEBUG_MODE=True \ 

	-e AB_EP_COMPLETE=False \ 

	--restart unless-stopped \

 	estrellaxd/auto_bangumi

/docker/auto-bangumi/config:/config ： AutoBangumi 資料庫和配置檔案所在路徑。設定後方便修改資料庫，亦可不設定
AB_WEBUI_PORT ： Web API 的通訊埠，目前 Web 頁面功能較少，一般用不到，可不啟用
TZ ： 時區
AB_INTERVAL_TIME ： RSS 解析器執行更新 RSS 間隔時間，默認為 7200S。此處設定為 120 ，即每 120 秒更新一次 RSS 訂閱
AB_RENAME_FREQ ： 在一個 AB_INTERVAL_TIME 週期內執行重命名的頻率，默認為 20。此處設定為 4， AB_INTERVAL_TIME 週期為 120 秒，即每 30 秒執行一次重命名
AB_DOWNLOADER_HOST ： qBittorrent 的 Webui 連接地址與通訊埠。如果啟用了 HTTPS，需要將 http:// 更改為 https://
AB_DOWNLOADER_USERNAME ： qBittorrent Webui 的用戶名
AB_DOWNLOADER_PASSWORD ： qBittorrent Webui 的登入密碼
AB_METHOD ： 重命名方式。 normal 為添加模式，保留檔案原始名稱，並添加 S0XE0X 格式的第幾季第幾集等資訊； pn 為簡潔模式，刪除檔案原始名稱，並命名為 劇集名稱 + S0XE0X 的格式； advance 為資料夾命名模式，刪除檔案原始名稱，並命名為 檔案所在資料夾名稱 + S0XE0X 的格式； none 为禁用模式，不對檔案進行重命名

AB_GROUP_TAG ： 是否在 RSS 規則中添加組名，以方便查看。關閉為： 組名 + 規則名 ，開啟為： 組名
AB_DOWNLOAD_PATH ： qBittorrent 中的下載路徑
AB_RSS ： RSS 訂閱連結
AB_NOT_CONTAIN ： 需要過濾的元素。如填寫 720，則過濾名稱中包含 720 的檔案，不執行下載

AB_DEBUG_MODE ： 調試模式
AB_EP_COMPLETE ： 下載番劇歷史劇集。如檢測到 RSS 中有新增番劇，且不為第 1 集，則自動下載第 1 集到當前集數之間的所有劇集

如果使用的是 Mikan Project 的 RSS 訂閱，執行完上述步驟後就已經可以使用了

# 常見問題

1. AutoBangumi 重命名後並不影響 qBittorrent 上傳做種

2. 在 qBittorrent 中刪除下載任務時如果勾選 也把硬碟裡的檔案刪除 ，經過 AutoBangumi 重命名後的檔案也會被刪除

3. 如果需要對某個規則進行修改，可直接在 qBittorrent 中進行修改，不需要重新部署 AutoBangumi ，也不影響 AutoBangumi 正常運行

4. 如果需要修改檔案路徑，直接在 qBittorrent 中進行修改即可，修改後也不影響 AutoBangumi 正常運行

# 進階使用

# AutoBangumi 資料庫說明

{

    "rss_link": "https://rss.example.com/RSS/",

    "data_version": 4.0,

    "bangumi_info": [

        {

            "official_title": "夏日時光",

            "title_raw": "Summer Time Rendering",

            "season": 1,

            "season_raw": "S01",

            "group": "LoliHouse",

            "dpi": "1080p",

            "source": null,

            "subtitle": "繁體",

            "added": true,

            "eps_collect": false

        },

        {

            "official_title": "來自深淵 烈日的黃金鄉",

            "title_raw": "Made in Abyss - Retsujitsu no Ougonkyou",

            "season": 2,

            "season_raw": "S02",

            "group": "Lilith-Raws",

            "dpi": "1080p",

            "source": "Baha",

            "subtitle": "繁體",

            "added": true,

            "eps_collect": false

        }

    ]

}

rss_link ： RSS 訂閱連結
official_title ： 中文名稱。重命名模式為 pn 時會使用此參數
title_raw ： 番劇的羅馬字或英文譯名。用於與下載檔案的番劇名稱進行匹配
season ： 第幾季
season_raw ： 用於重命名時添加 S0XE0X 中 S0X 所需要的參數
group ： 字幕組名稱。可留空不填寫
dpi ： 影片解析度。可留空不填寫
source ： 影片來源。不確定來源則填寫 null
subtitle ： 字幕語言。可留空不填寫
added ： 是否啟用重命名。 true 為啟用， false 為禁用
eps_collect ： 是否啟用 AB_EP_COMPLETE 番劇歷史劇集下載。 true 為啟用， false 為禁用

# AutoBangumi 的另類使用方式

Au­to­Bangumi 會在 qBit­tor­rent 中創建一個 Bangumi 分類，如果 Bangumi 分類中的任務命中了資料庫中相關番劇資訊，則這個任務中的檔案將會被重命名。但如果資料庫中沒有相關番劇資訊，即使在 Bangumi 分類中的任務的檔案也不會進行重命名。

藉助 Advance 模式的特性，在 qBittorrent 中手動添加下載，下載路徑填寫以該番劇命名的資料夾，並將其分類設定為 Bangumi , 亦可被 Au­to­Bangumi 正確重命名