nas/Auto_Bangumi
1
0
Fork 0
mirror of https://github.com/EstrellaXD/Auto_Bangumi.git synced 2026-04-13 10:39:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update docs.

Browse Source
This commit is contained in:
EstrellaXD
2023-09-24 22:56:32 +08:00
parent a5be83a8c6
commit f1b915f205
7 changed files with 18 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -19,7 +19,8 @@
<img title="AutoBangumi" src="docs/image/preview/window.png" alt="" width=75%>
</p>
本项目是基于 [Mikan Project](https://mikanani.me)、[qBittorrent](https://qbittorrent.org) 的全自动追番整理下载工具。只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番。并且整理完成的名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。
本项目是基于 RSS 的全自动追番整理下载工具。只需要在 [Mikan Project][mikan] 等网站上订阅番剧，就可以全自动追番。
并且整理完成的名称和目录可以直接被 [Plex][plex]、[Jellyfin][plex] 等媒体库软件识别，无需二次刮削。
## AutoBangumi 功能说明
@@ -55,9 +56,9 @@
- 自定义重命名，可以根据上级文件夹对所有子文件重命名。
- 季中追番可以补全当季遗漏的所有剧集
- 高度可自定义的功能选项，可以针对不同媒体库软件微调
- 支持多种 RSS 站点，支持聚合 RSS 的解析。
- 无需维护完全无感使用
- 内置 TDMB 解析器，可以直接生成完整的 TMDB 格式的文件以及番剧信息。
- 对于 Mikan RSS 的反代支持。
## 相关群组
@@ -66,15 +67,9 @@
## [Roadmap](https://github.com/users/EstrellaXD/projects/2)
***开发中的功能：***
- 内置 RSS 推送更新器。
- 搜索功能
***计划开发的功能：***
- 对其他站点种子的解析归类。
- 本地化番剧订阅方式。
- Transmission 的支持。
## Star History
@@ -93,3 +88,7 @@
## Licence
[MIT licence](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/LICENSE)
[mikan]: https://mikanani.me
[plex]: https://plex.tv
[jellyfin]: https://jellyfin.org

2
docs/deploy/windows.md
View File

@@ -21,7 +21,7 @@
4. 下载 WebUI 并安装：
```powershell
Invoke-WebRequest -Uri "https://github.com/Rewrite0/Auto_Bangumi_WebUI/releases/latest/download/dist.zip" -OutFile "dist.zip"
Invoke-WebRequest -Uri "https://github.com/EstrellaXD/Auto_Bangumi/releases/latest/download/dist.zip" -OutFile "dist.zip"
Expand-Archive -Path "dist.zip"
mv dist\* backend\src\templates
```

10
docs/home/index.md
View File

@@ -24,9 +24,8 @@ title: 项目说明
>
</p>
**`AutoBangumi`** 是从 [Mikan Project](https://mikanani.me) 全自动追番整理下载工具。
只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番、下载并整理文件，
整理后的番剧名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。
**`AutoBangumi`** 是基于 RSS 的全自动追番整理下载工具。只需要在 [Mikan Project][mikan] 等网站上订阅番剧，就可以全自动追番。
并且整理完成的名称和目录可以直接被 [Plex][plex]、[Jellyfin][plex] 等媒体库软件识别，无需二次刮削。
## 功能说明
@@ -97,3 +96,8 @@ AutoBangumi 仅供学习交流使用。
## Licence
[MIT licence](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/LICENSE)
[mikan]: https://mikanani.me
[plex]: https://plex.tv
[jellyfin]: https://jellyfin.org

BIN
docs/image/preview/webui-home.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.4 MiB

BIN
docs/image/preview/window.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.7 MiB

After

Width:  |  Height:  |  Size: 2.6 MiB

6
docs/index.md
View File

@@ -8,7 +8,7 @@ titleTemplate: 自动追番，解放双手！
hero:
name: AutoBangumi
text: 自动追番，解放双手！
tagline: 从 Mikan Project 全自动 订阅解析、下载管理、重命名整理
tagline: 从 RSS 全自动 订阅解析、下载管理、重命名整理
# image:
# dark: /image/icons/dark-logo.svg
# light: /image/icons/light-logo.svg
@@ -27,8 +27,8 @@ hero:
features:
- icon:
src: /image/icons/mikan-pic.png
title: Mikan Project 订阅源
details: 自动识别蜜柑计划 RSS 订阅格式，无需手动输入番剧，仅需订阅即可自动解析、下载、整理。
title: RSS 订阅解析
details: 自动识别解析各种番剧 RSS，无需手动输入番剧，仅需订阅即可自动解析、下载、整理。
- icon:
src: /image/icons/qbittorrent-logo.svg
title: qBitTorrent 下载器

171
docs/usage/使用说明.md
View File

@@ -1,171 +0,0 @@
# API
## 与 AutoBangumi 数据相关的 API
### `api/v1/log`
查看日志
```bash
curl -X GET http://ab_host:7892/api/v1/log
```
### `api/v1/data`
获得当前 AB 中的存储信息
```bash
curl --request GET -sL \
--url 'http://ab_host:7892/api/v1/data'\
```
### `api/v1/resetRule`
重置 AB 的数据，程序会在下一轮检索中重新添加 RSS 订阅信息。
```bash
curl --request GET -sL \
--url 'http://ab_host:7892/api/v1/resetRule'\
```
### `api/v1/removeRule/{name}`
删除规则
```bash
curl --request GET -sL \
--url 'http://ab_host:7892/api/v1/removeRule/{name}'\
```
## 订阅相关的 API
如果番剧还在更新，请使用 subscribe 来订阅，如果番剧已经完结，请使用 collection 来下载。
### `api/v1/subscribe`
添加全集订阅
```bash
curl --request POST -sL \
--url 'http://host:7892/api/v1/subscribe'\
--data '{"rss_link":"link"}'\
--header 'Content-Type: application/json'
```
### `api/v1/collection/`
```bash
curl --request POST -sL \
--url 'http://host:7892/api/v1/collection/'\
--data '{"rss_link":"link"}'\
--header 'Content-Type: application/json'
```
# 环境变量说明
## 注意
环境变量相关配置在 `2.6` 以后的版本中已经移除，现在使用 `config.json` 来配置系统设置。
## 环境列表
| 环境变量 | 作用 | 参数 |
| ------------------------ | ---------------------------------------------------- | -------------------- |
| `TZ` | 时区 | `Asia/Shanghai` |
| `AB_INTERVAL_TIME` | 间隔时间 | `7200` |
| `AB_RENAME_FREQ` | 在一个运行周期内重命名频率 | `20` |
| `AB_DOWNLOADER_HOST` | qBittorrent 的地址和端口号 | `localhost:8080` |
| `AB_DOWNLOADER_USERNAME` | qBittorrent 的用户名 | `admin` |
| `AB_DOWNLOADER_PASSWORD` | qBittorrent 的密码 | `adminadmin` |
| `AB_METHOD` | 重命名方法 `normal` 保留字幕组信息， `pn` 为纯净模式 | `pn` |
| `AB_GROUP_TAG` | 是否在下载规则中添加组名 | `False` |
| `AB_DOWNLOAD_PATH` | qBittorrent 中的下载路径 | `/downloads/Bangumi` |
| `AB_RSS` | RSS 订阅地址 | 必填项 |
| `AB_ENABLE_TMDB` | 启动 TMDB 解析 | `False` |
| `AB_LANGUAGE` | 选择语言 | `zh` |
| `AB_NOT_CONTAIN` | 输入想要过滤的元素 | `720` |
| `AB_DEBUG_MODE` | 调试模式 | `False` |
| `AB_EP_COMPLETE` | 历史番剧下载 | `False` |
| `AB_REMOVE_BAD_BT` | 碰到无法重命名的合集等，自动删除种子 | `False` |
| `AB_WEBUI_PORT` | Web API | `7892 ` |
| `AB_HTTP_PROXY` | HTTP 代理 | `127.0.0.1:6352` |
| `AB_SOCKS` | SOCKS5 代理 | `HOST,PORT,USR,PWD` |
| `AB_RENAME` | RENAME 开关 | `True` |
| `AB_RSS_COLLECTOR` | RSS 解析器开关 | `True` |
| `AB_RESET_FOLDER` | 修复错误命名文件夹 | `False` |
## 进阶参数说明
### 与 qBittorrent 连接
- `AB_DOWNLOADER_HOST`: qBittorrent 的地址和端口号，如果开启 HTTPS 请使用 `https://` 开头。
### 运行相关
`AB_INTERVAL_TIME`: 解析器的运行间隔时间，单位为秒，默认为 7200 秒，即两个小时检查一次 RSS 更新。
`AB_RENAME_FREQ`: 在一个运行周期内重命名频率，默认为 20，即 6 分钟运行一次。
### 文件路径以及重命名相关
`AB_METHOD`: 重命名方法
- `normal` 保留字幕组
- `pn` 为纯净模式，不保留字幕组，不保留其他信息，只保留名称，会根据 `Season` 文件夹的名称重命名。
- `advance` 为高级模式，基于文件夹名称重命名，不保留其他信息。
- 源文件路径：`/downloads/Bangumi/约会大作战/Season 4/DATE A LIVE - 1.mp4` >> `/downloads/Bangumi/约会大作战/Season 1/约会大作战 S04E01.mp4`
- `none` 为空模式，不重命名。
`AB_ENABLE_TMDB`: 启动 TMDB 解析, 建议同时启用代理。
`AB_LANGUAGE`: TMDB 解析后选择语言，仅在 `TMDB` 开启时有效。
- `zh` 中文
- `jp` 日语
### 下载和过滤相关
`AB_GROUP_TAG`: 是否在下载规则中添加组名，方便查看。开启后规则命名为 [组名]规则名，关闭后规则命名为 [规则名]
`AB_NOT_CONTAIN`: 输入想要过滤的元素，如 720，1080，等。
- 不同的元素用 `|` 分隔，例如 `720|CHT`
- 可以使用正则表达式，但是需要注意，特殊符号需要转义，例如 `\(` 表示 `(`。
- 这个选项建议填写：`720|\d+-\d+`，如果过滤选项添加过多，会影响到正常的 RSS 识别。对于番剧单独的自定义可以在 qBitorrent 中自定义。
`AB_EP_COMPLETE`: 历史番剧下载，开启后，将会下载已加入时之前的剧集。
`AB_REMOVE_BAD_BT`: 碰到无法重命名的合集等，自动删除种子
`AB_RESET_FOLDER`: 修复错误命名文件夹，如 S01 >> Season 1
### 网络代理相关
`AB_WEBUI_PORT`: HTTP API Port
`AB_HTTP_PROXY`: 开启 HTTP 代理，填入 HTTP 代理服务器地址和端口号
`AB_SOCKS`:开启 SOCKS5 代理
- `HOST,PORT,USR,PWD`
### 调试模式
`AB_DEBUG_MODE`: 调试模式
### 功能开关
`AB_RENAME`: RENAME 开关
`AB_RSS_COLLECTOR`: RSS 解析器开关
# 如何正确的使用 AutoBangumi 以及 qBittorrent
## 如何使用 AB 重命名其他番剧
- 只需要在 QB 中将种子类型设置为 Bangumi 即可被 AB 识别并重命名。
## 以下操作不影响程序正常运行
- 在 QB 中更改自动下载规则，更改自动下载路径
- 在 QB 中按照规范更改文件路径