diff --git a/README.md b/README.md index 9504a215..5ee7876f 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@

# 项目说明 + 本项目是基于 [Mikan Project](https://mikanani.me)、[qBittorrent](https://qbittorrent.org) 的全自动追番整理下载工具。只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧,就可以全自动追番。并且整理完成的名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别,无需二次刮削。 基于 [infuse]() 与 [Plex]() 的效果如下: @@ -18,9 +19,9 @@ - [AutoBangumi V2 简易说明](https://www.craft.do/s/4viN6M3tBqigLp) - 更新推送:[Telegram Channel](https://t.me/autobangumi_update) -- 测试群:[Telegram](t.me/autobangumi) +- Bug 反馈群:[Telegram](t.me/autobangumi) -## 部署说明 +# 部署说明 1. 用 Docker 部署 `AutoBangumi` : @@ -40,6 +41,7 @@ docker run -d \ --restart unless-stopped \ estrellaxd/auto_bangumi:latest ``` +### 参数说明 | 环境变量 | 作用 | 参数 | | --------------- | ------------------- | ---------------- | @@ -53,7 +55,16 @@ docker run -d \ | `DOWNLOAD_PATH` | qBittorrent 中的下载路径 | 必填项 | | `RSS` | RSS 订阅地址 | 必填项 | -1. 检查 Docker 运行日志,出现: +- `TIME` : 程序运行的间隔时间,默认为 `1800` 也就是 30 分钟,如果更新时间要求比较高可以适当降低该值。 +- `HOST`, `USER`, `PASSWORD`: qBittorrent 的地址,用户名,密码。 +- `METHOD`: 重命名规则 + - `pn`: Pure Name 模式,去掉所有字幕组以及番剧额外信息,只保留名称、季度和集数。 + - `normal`: 正常模式,仅重命名会影响搜刮的非正常字符。 +- `GROUP_TAG`: 开启后自动在自动下载规则中创建组名,方便管理。 +- `DOWNLOAD_PATH`: qBittorrent 的下载地址。 +- `RSS`: Mikan Project 的个人 RSS 订阅链接 + +2. 检查 Docker 运行日志,出现: ```other [2022-05-20 12:47:47] RSS Already exists. @@ -81,64 +92,7 @@ docker run -d \ [2022-05-20 12:47:47] 完成 ``` - 说明运行成功。之后可以检查 qb 中是否建立自动下载规则。 -# V 1.0 -本版本只能作为番剧重命名方便刮削 -## 说明 -本项目根据 qBittorrent, Plex 以及 infuse 搭建 -![Image](https://cdn.sspai.com/2022/02/09/d94ec60db1c136f6b12ba3dca31e5f5f.png?imageView2/2/w/1120/q/90/interlace/1/ignore-error/1) -完整教程请移步 [自动追番机器建立教程](https://www.craft.do/s/48MFW9QwaCQMzt) -### 需要依赖 -```bash -pip install qbittorrent-api -``` -## 使用之前 -在 `config.json` 中填入你的 `hostip` `username` `password` `savepath`: -```json -{ - "host_ip": "192.168.31.10:8181", - "username": "admin", - "password": "adminadmin", - "savepath": "/downloads/Bangumi", - "method": "pn" -} -``` -## 自动下载规则建立 -```shell -python3 rule_set.py --name <新番名称> -``` -## rename_qb -```shell -python3 rename_qb.py --help -``` -目前有三种重命名模式 -- `normal`: 普通模式,直接重命名,保留番剧字幕组信息。 -- `pn`: 纯净模式,保留番剧名称和剧集信息,去掉多余信息。 +说明运行成功。之后可以检查 qb 中是否建立自动下载规则。 -然后运行 `rename_qb.py` 即可, 如果只想对新番进行重命名,可以在程序中添加添加 `categories="Bangumi"` 语句 - -根据 `qBittorrent` API 自动重命名下载的种子文件,且不会让种子失效。 - -- 可以作为 `bash` 脚本运行,可以直接使用仓库中的 `rename.sh` -- 可以构建 `crontab` 定时运行 -- 可以使用 Docker 部署,详见文末(推荐) -```shell -0,30 * * * * python3 /path/rename_qb.py -``` -- 也可以监测文件夹变化运行。 - -## Docker 部署 -可以使用 Docker 部署重命名应用: -```shell -docker run -d \ - --name=Bangumi_rename \ - -e HOST=192.168.31.10:8181 \ - -e USER=admin \ - -e PASSWORD=adminadmin \ - -e METHOD=pn \ - -e TIME=1800 \ - estrellaxd/bangumi_rename_qb:latest -``` -`TIME` 为间隔运行时间,单位为秒 # 声明 本项目的自动改名规则根据 [miracleyoo/anime_renamer](https://github.com/miracleyoo/anime_renamer) 项目