3.3 KiB
3.3 KiB
JMDownload 归档器
这是一个 AstrBot 插件,用于下载 JM 本子,并归档为 Komga 可直接扫描读取的漫画库文件。
命令
/jm download <id>或/jm 下载 <id>:下载、归档,并按配置触发 Komga 扫描。/jm status:查看当前归档与 Komga 配置状态。/jm scan:手动触发一次 Komga 扫描。/jm cleanup:清理超过cleanup_retention_days的临时工作目录。
访问控制
插件默认启用白名单:只有 access_control 白名单中的群聊或私聊账号可以触发命令。黑名单优先于白名单。
- OneBot v11 / aiocqhttp 群聊:
allow_group_ids填群号,例如123456789。 - OneBot v11 / aiocqhttp 私聊:
allow_private_user_ids填 QQ 号,例如10001。 - OneBot v11 / aiocqhttp 机器人自身账号:
allow_self_ids填机器人 QQ 号,可用于多账号场景。 - 多平台实例:可写
平台ID:群号或平台ID:QQ号,也可用完整 UMO:平台ID:GroupMessage:群号、平台ID:FriendMessage:QQ号。 - 平台 ID:来自 AstrBot 平台实例 ID,
/jm status会显示当前事件的平台 ID、机器人自身 ID、群聊 ID、发送者 ID和UMO。
归档结构
默认归档为 cbz,目录结构如下:
<archive_root>/
<系列名>/
<系列名> [<JM ID>].cbz
Komga 扫描时会把父文件夹识别为 Series,把文件识别为 Book,所以 archive_root 建议直接填写 Komga library 的根目录。插件也保留 pdf 输出,用于兼容原 NoneBot 插件习惯。
CBZ 内部会包含:
ComicInfo.xml:标题、系列、页数、JM ID、来源链接等 Komga 可读取的元数据。0001.jpg、0002.jpg...:按下载顺序编号的页面图片。
当 archive_format 设置为 pdf 时,插件会按 pdf_chunk_size 分块生成临时 PDF,再合并为最终文件,避免大本子转换时一次性占用过多内存。
归档成功后,插件默认删除本次临时下载目录;归档库中的 CBZ/PDF 不会被自动删除。历史临时目录可通过 /jm cleanup 清理。
Komga 联动
在 AstrBot 插件配置里填写:
archive_root:Komga library 根目录komga.enabled:是否启用自动扫描komga.base_url:Komga 服务地址komga.library_id:Komga library IDkomga.api_key或komga.username+komga.password
归档完成后,插件会请求:
POST /api/v1/libraries/{libraryId}/scan
代理与登录
- 代理:配置
jm_proxy.mode。常用值是system、clash、v2ray、custom。 - 自定义代理:
jm_proxy.mode=custom,再填写jm_proxy.proxy_url,例如127.0.0.1:7890。 - 账号登录:默认不需要。少部分敏感题材可能需要登录,此时可启用
jm_login.enabled并填写jm_login.username/jm_login.password,插件会调用 jmcomic 的login插件自动获取 Cookie。 - 手动 Cookie:如果不想保存账号密码,也可以填写
jm_avs_cookie,只填浏览器 Cookie 中AVS的值。
测试
python -m unittest discover -s tests
详细部署步骤见 docs/DEPLOYMENT.md。
项目迁移和 Codex 账号交接见 docs/MIGRATION_HANDOFF.md。
后续增强计划见 docs/ROADMAP.md。