# 项目说明
本项目是基于 [Mikan Project](https://mikanani.me)、[qBittorrent](https://qbittorrent.org) 的全自动追番整理下载工具。只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番。并且整理完成的名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。
基于 [infuse](https://firecore.com/infuse) 与 [Plex](https://plex.tv) 的效果如下：
## AutoBangumi 好在哪
- 只需单次配置
- 修改文件名但是不破坏作种
- 傻瓜式文件整理
## 相关文档和群组
- [AutoBangumi V2 简易说明](https://www.craft.do/s/4viN6M3tBqigLp)
- [常见 bug 和解决方法](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/Docs/常见错误解决.md)
- 更新推送：[Telegram Channel](https://t.me/autobangumi_update)
- Bug 反馈群：[Telegram](https://t.me/+yNisOnDGaX5jMTM9)
# 部署说明
1. 安装 qBittorrent:
2. 用 Docker 部署 `AutoBangumi` :
最简部署方法
```dash
docker run -d \
--name=AutoBangumi \
-e AB_DOWNLOAD_PATH=/path/downloads \
-e AB_RSS= \
--network=host \
--dns=8.8.8.8 \
--restart unless-stopped \
estrellaxd/auto_bangumi:latest
```
**进阶部署:**
Docker-Compose（推荐）
```yaml
version: '3.3'
services:
auto_bangumi:
container_name: AutoBangumi
environment:
- TZ=Asia/Shanghai
- AB_INTERVAL_TIME=1800
- AB_DOWNLOADER_HOST=localhost:8080
- AB_DOWNLOADER_USERNAME=admin
- AB_DOWNLOADER_PASSWORD=adminadmin
- AB_METHOD=pn
- AB_GROUP_TAG=True
- AB_NOT_CONTAIN=720
- AB_DOWNLOAD_PATH=${DOWNLOAD_PATH}
- AB_RSS=${RSS}
- AB_RULE_DEBUG=False
- AB_DEBUG_MODE=False
- AB_EP_COMPLETE=True
- AB_SEASON_ONE=True
network_mode: host
dns:
- 8.8.8.8
- 223.5.5.5
restart: unless-stopped
image: estrellaxd/auto_bangumi:latest
```
Docker-cli
```dash
docker run -d \
--name=AutoBangumi \
-e TZ=Asia/Shanghai \ #optional
-e AB_INTERVAL_TIME=1800 \ #optional
-e AB_DOWNLOADER_HOST=localhost:8080 \ #optional
-e AB_DOWNLOADER_USERNAME=admin \ #optional
-e AB_DOWNLOADER_PASSWORD=adminadmin \ #optional
-e AB_METHOD=pn \ #optional
-e AB_GROUP_TAG=True \ #optional
-e AB_DOWNLOAD_PATH=/path/downloads \
-e AB_NOT_COTAIN=720 \
-e AB_RSS= \
--network=host \
--dns=8.8.8.8 \
--restart unless-stopped \
estrellaxd/auto_bangumi:latest
```
### 参数说明
| 环境变量 | 作用 | 参数 |
| --------------- |---------------------|------------------|
| `TZ` | 时区 | `Asia/Shanghai` |
| `TIME` | 间隔时间 | `1800` |
| `HOST` | qBittorrent 的地址和端口号 | `localhost:8080` |
| `USER` | qBittorrent 的用户名 | `admin` |
| `PASSWORD` | qBittorrent 的密码 | `adminadmin` |
| `METHOD` | 重命名方法 | `pn` |
| `GROUP_TAG` | 是否在下载规则中添加组名 | `False` |
| `NOT_CONTAIN` | 正则表达式过滤器 | `720` |
| `DOWNLOAD_PATH` | qBittorrent 中的下载路径 | 必填项 |
| `RSS` | RSS 订阅地址 | 必填项 |
- `TIME` : 程序运行的间隔时间，默认为 `1800` 也就是 30 分钟，如果更新时间要求比较高可以适当降低该值。
- `HOST`, `USER`, `PASSWORD`: qBittorrent 的地址，用户名，密码。
- `METHOD`: 重命名规则
- `pn`: Pure Name 模式，去掉所有字幕组以及番剧额外信息，只保留名称、季度和集数。
- `normal`: 正常模式，仅重命名会影响搜刮的非正常字符。
- `GROUP_TAG`: 开启后自动在自动下载规则中创建组名，方便管理。
- `DOWNLOAD_PATH`: qBittorrent 的下载地址。
- `RSS`: Mikan Project 的个人 RSS 订阅链接
- `NOT_CONTAIN`: 可以自行添加过滤的正则表达式
3. 检查 Docker 运行日志，出现：
```other
[2022-05-20 12:47:47] RSS Already exists.
[2022-05-20 12:47:47] add Summer Time Rendering
[2022-05-20 12:47:47] add Paripi Koumei
[2022-05-20 12:47:47] add Tomodachi Game
[2022-05-20 12:47:47] add Tate no Yuusha no Nariagari S02
[2022-05-20 12:47:47] add Shijou Saikyou no Daimaou
[2022-05-20 12:47:47] add Yuusha, Yamemasu
[2022-05-20 12:47:47] add Aharen-san wa Hakarenai
[2022-05-20 12:47:47] add Kawaii dake ja Nai Shikimori-san
[2022-05-20 12:47:47] add Kakkou no Iinazuke
[2022-05-20 12:47:47] add SPYxFAMILY
[2022-05-20 12:47:47] add Love Live S02
[2022-05-20 12:47:47] add BUILD-DIVIDE
[2022-05-20 12:47:47] add Machikado Mazoku:-choume
[2022-05-20 12:47:47] add CUE!
[2022-05-20 12:47:47] add Kaguya-sama wa Kokurasetai S03
[2022-05-20 12:47:47] add Shokei Shoujo no Virgin Road
[2022-05-20 12:47:47] add Kakkou no Iikagen
[2022-05-20 12:47:47] Start adding rules.
[2022-05-20 12:47:47] Finished.
[2022-05-20 12:47:47] 已完成对0个文件的检查
[2022-05-20 12:47:47] 已对其中0个文件进行重命名
[2022-05-20 12:47:47] 完成
```
说明运行成功。之后可以检查 qb 中是否建立自动下载规则。
4. 安装媒体库软件
## Roadmap
***开发中的功能：***
- RSS 解析器：AutoBangumi 可以自行解析分析种子无需依赖下载器。
- Transmission & Aria2 的支持。
- 遗漏番剧下载：中间开始追番可以补全之前的剧集。
***计划开发的功能：***
- Web UI
- 更为智能细致的分类预设。
# 声明
本项目的自动改名规则根据 [miracleyoo/anime_renamer](https://github.com/miracleyoo/anime_renamer) 项目