Skip to content

Commit c58ec29

Browse files
committed
docs: improve README config table and update file structure
1 parent cdff85b commit c58ec29

1 file changed

Lines changed: 36 additions & 48 deletions

File tree

README.md

Lines changed: 36 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -240,67 +240,55 @@ pip install -r requirements.txt
240240

241241
所有配置可在 AstrBot 管理面板中修改:
242242

243-
| 配置项 | 说明 | 默认值 |
244-
| ------------------------ | -------------------------- | -------------- |
245-
| `download_dir` | 漫画下载目录 | `./downloads` |
246-
| `image_suffix` | 图片格式 (.jpg/.png/.webp) | `.jpg` |
247-
| `client_type` | 客户端类型 (api/html) | `api` |
248-
| `use_proxy` | 是否使用代理 | `false` |
249-
| `proxy_url` | 代理服务器地址 ||
250-
| `pack_format` | 打包格式 (zip/pdf/none) | `zip` |
251-
| `pack_password` | 打包密码(留空则不加密) ||
252-
| `auto_delete_after_send` | 发送后自动删除 | `true` |
253-
| `send_cover_preview` | 发送封面预览 | `true` |
254-
| `auto_recall_enabled` | 自动撤回文件消息 (仅QQ) | `false` |
255-
| `auto_recall_delay` | 自动撤回延迟时间 (秒) | `60` |
256-
| `enabled_groups` | 启用的群列表(逗号分隔) | 空(全部启用) |
257-
| `admin_only` | 仅管理员可用 | `false` |
258-
| `admin_list` | 管理员用户 ID 列表 ||
259-
| `search_page_size` | 搜索结果数量 | `5` |
260-
| `daily_download_limit` | 每日下载次数限制 (0=不限) | `0` |
261-
| `debug_mode` | 调试模式 | `false` |
262-
| `jm_username` | JM账号用户名 | 空(可选) |
263-
| `jm_password` | JM账号密码 | 空(可选) |
264-
265-
> [!NOTE]
266-
> **关于每日下载限制**
267-
>
268-
> 设置 `daily_download_limit` 后,每个用户(按 QQ 号识别)每日下载次数受限。`admin_list` 中的管理员不受此限制。
269-
270-
> [!NOTE]
271-
> **关于 webp 图片格式**
272-
>
273-
> `image_suffix` 设置为 `.webp` 时,**仅支持 ZIP 打包**。由于 pymupdf 库不支持 webp 格式,使用 PDF 打包将无法正常输出文件。webp 格式的优势在于体积更小,适合追求轻量化的用户;如无特殊需求,建议使用默认的 `.jpg` 格式以获得最佳兼容性。
274-
275-
> [!TIP]
276-
> **防风控建议**
277-
>
278-
> 为避免 QQ 账号被风控,强烈建议设置 `pack_password`(打包密码)。加密后的 ZIP/PDF 文件内容会被完全加密,QQ 无法扫描内部图片进行哈希比对或内容识别,可有效降低风控触发概率。
279-
280-
> [!IMPORTANT]
281-
> **关于登录持久化的重要说明**
282-
>
283-
> - **在面板中配置账号密码**:插件重载/Bot重启后会**自动登录**,推荐使用此方式
284-
> - **仅使用 `/jmlogin` 命令登录**:登录状态仅保存在内存中,插件重载后需要**重新登录**
285-
>
286-
> 如需使用收藏夹等登录功能,建议在 AstrBot 管理面板中配置 `jm_username``jm_password`
243+
| 配置项 | 说明 | 默认值 | 备注 |
244+
| ------------------------ | -------------------------- | -------------- | ---- |
245+
| `download_dir` | 漫画下载目录 | `./downloads` | |
246+
| `image_suffix` | 图片格式 (.jpg/.png/.webp) | `.jpg` | webp 仅支持 ZIP 打包 |
247+
| `client_type` | 客户端类型 (api/html) | `api` | api 兼容性好,html 效率高但限 IP |
248+
| `use_proxy` | 是否使用代理 | `false` | |
249+
| `proxy_url` | 代理服务器地址 || 格式: `http://host:port` |
250+
| `max_concurrent_photos` | 最大并发章节数 | `3` | 建议 3-5 |
251+
| `max_concurrent_images` | 最大并发图片数 | `5` | 建议 5-10 |
252+
| `pack_format` | 打包格式 (zip/pdf/none) | `zip` | |
253+
| `pack_password` | 打包密码 || **强烈建议设置,可降低风控** |
254+
| `filename_show_password` | 文件名显示密码提示 | `false` | 开启后文件名末尾添加 #PWxxx |
255+
| `auto_delete_after_send` | 发送后自动删除 | `true` | |
256+
| `send_cover_preview` | 发送封面预览 | `true` | |
257+
| `auto_recall_enabled` | 自动撤回文件消息 | `false` | 仅支持 QQ/NapCat 平台 |
258+
| `auto_recall_delay` | 自动撤回延迟 (秒) | `60` | 建议 30-120 |
259+
| `enabled_groups` | 启用的群列表 || 逗号分隔,空=全部启用 |
260+
| `admin_only` | 仅管理员可用 | `false` | |
261+
| `admin_list` | 管理员 ID 列表 || 逗号分隔,不受下载限制 |
262+
| `search_page_size` | 搜索结果数量 | `5` | |
263+
| `daily_download_limit` | 每日下载限制 | `0` | 0=不限,管理员豁免 |
264+
| `debug_mode` | 调试模式 | `false` | |
265+
| `jm_username` | JM账号用户名 || 面板配置可自动登录 |
266+
| `jm_password` | JM账号密码 || 命令登录重启后失效 |
287267

288268
## 文件结构
289269

290270
```
291-
jm_cosmos2/
271+
astrbot_plugin_jm_cosmos/
292272
├── main.py # 插件入口和命令注册
293273
├── metadata.yaml # 插件元数据
294274
├── _conf_schema.json # 配置模式定义
295275
├── requirements.txt # 依赖库列表
296276
├── core/ # 核心模块
297277
│ ├── __init__.py
298-
│ ├── config.py # 配置管理器
278+
│ ├── auth.py # 认证管理器
279+
│ ├── browser.py # 浏览查询器(搜索、排行、详情)
280+
│ ├── constants.py # 常量定义
299281
│ ├── downloader.py # 下载管理器
300-
│ └── packer.py # 打包模块 (ZIP/PDF)
282+
│ ├── packer.py # 打包模块 (ZIP/PDF)
283+
│ ├── quota.py # 下载配额管理器
284+
│ └── base/ # 基础模块
285+
│ ├── client.py # 客户端混入类
286+
│ └── config.py # 配置管理器
301287
└── utils/ # 工具模块
302288
├── __init__.py
303-
└── formatter.py # 消息格式化器
289+
├── filename.py # 文件名生成器
290+
├── formatter.py # 消息格式化器
291+
└── recall.py # 消息撤回工具
304292
```
305293

306294
## 常见问题

0 commit comments

Comments
 (0)