mirror of
https://gitlab.com/KenanZhu/AutoLibraryManuals.git
synced 2026-11-05 05:35:51 +08:00
Reorganize docs into 4 group subdirectories with clean file names
- Group files into installation/, configuration/, features/, faq/ - Rename files without group prefix (e.g. features/timer.mdx, configuration/ui.mdx) - Fix heading levels: title as H1, content starts at H2 - Normalize sub-field headings in configuration/file.mdx - Add style.css for font size adjustment Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
GogsandClaude Opus 4.7 committed
1 parent
c772626689
commit
3e9cb32368
14 files changed
+511
-458
No files matched your search
@@ -0,0 +1,206 @@
|
||||
---
|
||||
title: "通过文件配置"
|
||||
description: "AutoLibrary JSON 配置文件参考 - run.json 与 user.json"
|
||||
---
|
||||
|
||||
软件启动时，将自动在用户主目录下创建运行配置文件 `run.json` 和用户配置文件 `user.json`。
|
||||
配置文件统一存放于用户主目录下的 `AutoLibrary/config` 文件夹中。以 Windows 系统为例：
|
||||
|
||||
```path
|
||||
C:\Users\<用户名>\AppData\Roaming\AutoLibrary\config
|
||||
```
|
||||
|
||||
<Warning>
|
||||
任何情况下都不建议在该目录下修改除运行配置文件和用户配置文件以外的任何文件。
|
||||
|
||||
即使是修改配置文件，也请务必保持 JSON 格式正确，否则可能导致软件无法正常启动或运行。
|
||||
</Warning>
|
||||
|
||||
## 运行配置文件 (run.json)
|
||||
|
||||
```json
|
||||
{
|
||||
"library": {
|
||||
"host_url": "http://10.1.20.7",
|
||||
"login_url": "/login"
|
||||
},
|
||||
"mode": {
|
||||
"run_mode": 1
|
||||
},
|
||||
"login": {
|
||||
"auto_captcha": true,
|
||||
"max_attempt": 3
|
||||
},
|
||||
"web_driver": {
|
||||
"driver_type": "edge",
|
||||
"driver_path": "",
|
||||
"headless": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 字段 (library)
|
||||
|
||||
关于图书馆的相关配置，目前版本下无需更改
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `host_url` | String | 图书馆主机URL，无需更改 |
|
||||
| `login_url` | String | 登录页面URL，无需更改 |
|
||||
|
||||
### 字段 (mode)
|
||||
|
||||
AutoLibrary 的运行模式
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `run_mode` | Number | 运行模式组合（+1 预约, +2 签到, +4 续约） |
|
||||
|
||||
### 字段 (login)
|
||||
|
||||
AutoLibrary 处理登录时的相关配置
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `auto_captcha` | Boolean | 自动验证码识别，建议保持 `true` |
|
||||
| `max_attempt` | Number | 登录尝试次数，默认 3 次 |
|
||||
|
||||
### 字段 (web_driver)
|
||||
|
||||
AutoLibrary 使用的浏览器及其驱动的相关配置
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `driver_type` | String | 浏览器类型：`edge` / `chrome` / `firefox` |
|
||||
| `driver_path` | String | 驱动文件路径，为空则运行失败 |
|
||||
| `headless` | Boolean | 无头模式，默认 `false` |
|
||||
|
||||
## 用户配置文件 (user.json)
|
||||
|
||||
```json
|
||||
{
|
||||
"groups": [
|
||||
{
|
||||
"name": "分组名",
|
||||
"enable": true,
|
||||
"users": [
|
||||
{
|
||||
"username": "您的学号",
|
||||
"password": "您的密码",
|
||||
"enable": true,
|
||||
"reserve_info": {
|
||||
"date": "2025-10-30",
|
||||
"place": "1",
|
||||
"floor": "4",
|
||||
"room": "5",
|
||||
"begin_time": {
|
||||
"time": "09:30",
|
||||
"max_diff": 30,
|
||||
"prefer_early": true
|
||||
},
|
||||
"end_time": {
|
||||
"time": "21:23",
|
||||
"max_diff": 30,
|
||||
"prefer_early": false
|
||||
},
|
||||
"renew_time": {
|
||||
"expect_duration": 1.0,
|
||||
"max_diff": 30,
|
||||
"prefer_early": false
|
||||
},
|
||||
"seat_id": "31A",
|
||||
"expect_duration": 6,
|
||||
"satisfy_duration": true
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 字段 (groups)
|
||||
|
||||
这是用户配置的最外层的用户分组，分组中会包含一个用户列表，
|
||||
|
||||
<Tip>
|
||||
即使只添加用户列表而不使用分组包裹，AutoLibrary 也会默认为该用户列表创建兼容分组。
|
||||
</Tip>
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `name` | String | 分组名称 |
|
||||
| `enable` | Boolean | 是否启用该分组，`false` 时跳过 |
|
||||
|
||||
### 字段 (users)
|
||||
|
||||
用户分组中的用户列表
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `username` | String | 学号 |
|
||||
| `password` | String | 密码 |
|
||||
| `enable` | Boolean | 是否启用该用户，`false` 时跳过 |
|
||||
|
||||
### 字段 (reserve_info)
|
||||
|
||||
该字段包含了用户的座位预约信息
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `date` | String | 预约日期（格式 `yyyy-MM-dd`） |
|
||||
| `place` | String | `"图书馆"` 或 `"1"` |
|
||||
| `floor` | String | 楼层代码，详见下方楼层映射 |
|
||||
| `room` | String | 区域代码，详见下方区域映射 |
|
||||
| `seat_id` | String | 座位编号，如 `12A` `012a` |
|
||||
| `expect_duration` | Number | 期望预约时长（分钟） |
|
||||
| `satisfy_duration` | Boolean | 是否满足期望时长 |
|
||||
|
||||
<Accordion title="楼层映射">
|
||||
| 代码 | 楼层 |
|
||||
| --- | --- |
|
||||
| `2` | 二层 |
|
||||
| `3` | 三层 |
|
||||
| `4` | 四层 |
|
||||
| `5` | 五层 |
|
||||
</Accordion>
|
||||
<Accordion title="区域映射">
|
||||
| 代码 | 区域 |
|
||||
| --- | --- |
|
||||
| `1` | 二层内环 |
|
||||
| `2` | 二层西区 |
|
||||
| `3` | 三层内环 |
|
||||
| `4` | 三层外环 |
|
||||
| `5` | 四层内环 |
|
||||
| `6` | 四层外环 |
|
||||
| `7` | 期刊区 |
|
||||
| `8` | 五层考研 |
|
||||
</Accordion>
|
||||
|
||||
#### 子字段 begin_time
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `time` | String | 开始时间（格式 `HH:mm`） |
|
||||
| `max_diff` | Number | 最大时间差（分钟） |
|
||||
| `prefer_early` | Boolean | 是否优先较早时间 |
|
||||
|
||||
#### 子字段 end_time
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `time` | String | 结束时间（格式 `HH:mm`） |
|
||||
| `max_diff` | Number | 最大时间差（分钟） |
|
||||
| `prefer_early` | Boolean | 结束时间优先较晚 |
|
||||
|
||||
#### 子字段 renew_time
|
||||
|
||||
<Tip>
|
||||
该子字段只在用户的续约模式下才会被 AutoLibrary 读取
|
||||
</Tip>
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| `expect_duration` | Number | 期望续约时长（小时） |
|
||||
| `max_diff` | Number | 最大时间差（分钟） |
|
||||
| `prefer_early` | Boolean | 续约时间优先较晚 |
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: "启动工具"
|
||||
description: "AutoLibrary 启动与运行说明"
|
||||
---
|
||||
|
||||
运行 AutoLibrary 文件，工具将启动主界面。
|
||||
|
||||
|
||||
|
||||
软件首次启动时，未初始化配置文件，直接运行脚本会提示配置文件未找到。这属于预期行为，请先完成下方配置。
|
||||
|
||||
<Tip> 为适应不同的用户需求，这里分别提供了通过界面与直接修改配置文件两种方式，请按照需求参考选择 </Tip>
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
title: "通过界面配置"
|
||||
description: "AutoLibrary 界面配置指南 - 用户、预约、系统设置与运行模式"
|
||||
---
|
||||
|
||||
点击主界面窗口右上角的配置按钮，打开配置窗口。
|
||||
|
||||
<Tabs>
|
||||
<Tab title="用户配置">
|
||||
|
||||
|
||||
<Tip>初次运行软件时，用户配置默认为空，需要手动添加。</Tip>
|
||||
|
||||
### 用户列表
|
||||
|
||||
| 功能 | 说明 | 备注 |
|
||||
| --- | --- | --- |
|
||||
| 用户列表 | 显示当前配置文件中的所有用户 | 支持添加、删除用户操作，选中用户项进行详细配置 |
|
||||
|
||||
### 用户信息
|
||||
|
||||
| 参数 | 说明 | 默认值/可选值 |
|
||||
| --- | --- | --- |
|
||||
| 学号 | 用户的学号 | 必填项，用于登录图书馆系统 |
|
||||
| 密码 | 用户的密码 | 默认值为 `000000`，请根据实际情况修改 |
|
||||
|
||||
### 预约信息
|
||||
|
||||
| 参数 | 说明 | 默认值/可选值 |
|
||||
| --- | --- | --- |
|
||||
| 日期 | 座位预约日期 | 格式 `yyyy-MM-dd`，18:00-23:00可预约次日 |
|
||||
| 地点 | 预约座位的地点 | 默认值：`图书馆` |
|
||||
| 楼层 | 预约座位的楼层 | `二层` `三层` `四层` `五层` |
|
||||
| 区域 | 预约座位的区域 | 默认值：`二层内环`，可选随楼层变化 |
|
||||
| 座位号 | 预约座位的座位号 | 例如：`12A` `012a` |
|
||||
| 开始时间 | 预约开始时间 | 格式 `HH:mm`，可选范围 7:30-23:30 |
|
||||
| 结束时间 | 预约结束时间 | 格式 `HH:mm`，默认当前时间+2小时 |
|
||||
| 最大时间偏差 | 时间不可用时的偏差范围 | 0-120分钟，0 表示严格按选择时间 |
|
||||
| 优先最早/晚 | 多可选时间时的优先选择 | 开始时间优先最早，结束/续约时间优先最晚 |
|
||||
| 期望预约时长 | 预约期望时长 | 0-8 小时，默认 2 小时 |
|
||||
| 期望续约时长 | 续约期望时长 | 0-4 小时，默认 1 小时 |
|
||||
| 优先满足期望时长 | 是否优先满足时长限制 | 勾选后尽量满足，但可能因座位紧张导致预约失败 |
|
||||
</Tab>
|
||||
<Tab title="运行配置">
|
||||
|
||||
|
||||
### 图书馆设置
|
||||
|
||||
| 参数 | 说明 | 默认值 |
|
||||
| --- | --- | --- |
|
||||
| 访问网址 | 图书馆系统的主机URL | `http://10.1.20.7`（无需更改） |
|
||||
| 登录页面 | 登录页面的URL路径 | `/login`（无需更改） |
|
||||
|
||||
### 浏览器设置
|
||||
|
||||
| 参数 | 说明 | 默认值/可选值 |
|
||||
| --- | --- | --- |
|
||||
| 浏览器类别 | 使用的浏览器类型 | Microsoft Edge / Google Chrome / Mozilla Firefox |
|
||||
| 浏览器驱动路径 | 驱动程序路径 | 通过浏览按钮选择 |
|
||||
| 无头模式 | 是否隐藏浏览器窗口 | `false`（显示窗口），`true` 为隐藏运行 |
|
||||
|
||||
### 登录设置
|
||||
|
||||
| 参数 | 说明 | 默认值 |
|
||||
| --- | --- | --- |
|
||||
| 自动识别验证码 | 是否自动处理验证码 | 勾选（推荐） |
|
||||
| 登录尝试次数 | 登录失败后最大重试次数 | 3 次 |
|
||||
|
||||
### 运行模式
|
||||
|
||||
| 功能 | 说明 | 触发条件 |
|
||||
| --- | --- | --- |
|
||||
| 自动预约 | 按配置进行座位预约 | 用户当天无有效预约时执行 |
|
||||
| 自动签到 | 自动完成图书馆签到 | 满足条件时执行，否则跳过 |
|
||||
| 自动续约 | 自动延长座位使用时间 | 满足条件时执行，否则跳过 |
|
||||
</Tab>
|
||||
<Tab title="其它">
|
||||
|
||||
|
||||
### 配置文件的保存与读取
|
||||
|
||||
| 参数 | 说明 |
|
||||
| --- | --- |
|
||||
| 运行配置文件路径 | 可通过浏览按钮选择新的配置文件 |
|
||||
| 用户配置文件路径 | 可通过浏览按钮选择新的配置文件 |
|
||||
|
||||
### 导出配置
|
||||
|
||||
支持将当前配置导出为文件，选择目标路径和文件名后点击导出按钮。
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## 运行工具
|
||||
|
||||
配置完成后，点击主界面窗口顶部右侧的绿色按钮 **"启动脚本"**，工具将按配置自动执行预约、签到、续约等操作。
|
||||
|
||||
<Tip>AutoLibrary 将按照配置文件处理所有启用的用户组中的可用用户。</Tip>
|
||||
Reference in new issue
Block a user