astrbot_plugin_jmdowloads/README.md

58 行
1.9 KiB
Markdown

2026-07-07 00:01:44 +08:00
# JMDownload 归档器
这是一个 AstrBot 插件,用于下载 JM 本子,并归档为 Komga 可直接扫描读取的漫画库文件。
## 命令
- `/jm download <id>` 或 `/jm 下载 <id>`:下载、归档,并按配置触发 Komga 扫描。
- `/jm status`:查看当前归档与 Komga 配置状态。
- `/jm scan`:手动触发一次 Komga 扫描。
2026-07-07 00:35:15 +08:00
- `/jm cleanup`:清理超过 `cleanup_retention_days` 的临时工作目录。
2026-07-07 00:01:44 +08:00
## 归档结构
默认归档为 `cbz`,目录结构如下:
```text
<archive_root>/
<系列名>/
<系列名> [<JM ID>].cbz
```
Komga 扫描时会把父文件夹识别为 Series,把文件识别为 Book,所以 `archive_root` 建议直接填写 Komga library 的根目录。插件也保留 `pdf` 输出,用于兼容原 NoneBot 插件习惯。
2026-07-07 00:16:40 +08:00
CBZ 内部会包含:
- `ComicInfo.xml`:标题、系列、页数、JM ID、来源链接等 Komga 可读取的元数据。
- `0001.jpg`、`0002.jpg` ...:按下载顺序编号的页面图片。
2026-07-07 00:28:06 +08:00
当 `archive_format` 设置为 `pdf` 时,插件会按 `pdf_chunk_size` 分块生成临时 PDF,再合并为最终文件,避免大本子转换时一次性占用过多内存。
2026-07-07 00:35:15 +08:00
归档成功后,插件默认删除本次临时下载目录;归档库中的 CBZ/PDF 不会被自动删除。历史临时目录可通过 `/jm cleanup` 清理。
2026-07-07 00:01:44 +08:00
## Komga 联动
在 AstrBot 插件配置里填写:
- `archive_root`:Komga library 根目录
- `komga.enabled`:是否启用自动扫描
- `komga.base_url`:Komga 服务地址
- `komga.library_id`:Komga library ID
- `komga.api_key` 或 `komga.username` + `komga.password`
归档完成后,插件会请求:
```text
POST /api/v1/libraries/{libraryId}/scan
```
2026-07-07 00:38:01 +08:00
## 测试
```bash
python -m unittest discover -s tests
```
2026-07-07 00:43:22 +08:00
详细部署步骤见 [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md)。
2026-07-07 00:46:02 +08:00
后续增强计划见 [docs/ROADMAP.md](docs/ROADMAP.md)。