Ab-Integro / AGENTS.md
Ame
feat(tools): 翻译清单改为 v3 紧凑格式并增量校验
20cc92a
|
Raw
History Blame Contribute Delete
6.27 kB
# Ab Integro agent 手册
本工作树是《欧陆风云 IV》1.37.5 模组 `Ab_Integro` 的唯一内容真源。
## 重要文档
|文件|用途|
|---|---|
|`CHANGELOG.md`|版本记录,每次有玩家可感知的改动时更新|
|`README.md`|模组简介|
|`LOADING_ATTRIBUTION.md`|加载画面素材来源与授权|
## 这是什么
Ab Integro 是一个持续开发中的 EU4 1.37.5 模组,目标是在欧陆风云4停更后,一站式整合中文汉化、省份扩展、界面美化和玩法增强。当前以原版游戏为基底,已合并 Comprehensive Map(全球省份扩展,新增省份 ID 4942-6975)和 India Extended(印度省份扩展,189 个省份重映射至 6976-7164),并叠加了中文汉化、英文回填层和界面美化。所有原版省份 ID 完整保留。
完整整合清单见 `CHANGELOG.md``[0.1.0]` 段。每次有玩家可感知的改动都要更新 `CHANGELOG.md`
## 路径
|用途|路径|
|---|---|
|工作树|`C:/Users/Ame/Documents/Paradox Interactive/Europa Universalis IV/mod/Ab_Integro`|
|EU4 游戏目录|`C:/Program Files (x86)/Steam/steamapps/common/Europa Universalis IV`|
|发布远端|`origin``https://huggingface.co/datasets/raincandy-u/Ab-Integro`|
发布用 `git push origin main`。该远端是 Hugging Face 数据集,不创建 GitHub Pull Request。
创意工坊订阅目录(`C:/Program Files (x86)/Steam/steamapps/workshop/content/236850/`)仅供逐项对照,不能作为整文件恢复来源。
## 怎么改数据
### Clausewitz 数据(history/、common/、events/、decisions/、missions/)
`tools/eu4_clausewitz` 按字节偏移写入,保留注释、缩进和未改字段。禁止整份重写。
```js
import { load } from './tools/eu4_clausewitz/src/index.mjs';
const eu4 = await load({ game, mod });
const provinces = await eu4.dir('history/provinces');
const province = await provinces.get('219');
province.set('culture', 'x');
await eu4.save();
```
### 中文本地化
`localisation_source/`,跑 `tools/localisation.ps1 build``localisation/` 是构建产物,不要直接改。
### 英文覆盖层
`localisation_english_source/`,来源记录补到 `localisation_english_provenance.json`,跑 `tools/build_variants.mjs build-english`
### 直写中文(history/、common/ 里的姓名、王朝、省会名)
不走 `.yml` 流程,保持原始字节格式,不加 BOM。改了或新增时,必须同步翻译清单 `history_language_manifest.json`(见下文)。
## 翻译清单(history_language_manifest.json)
这份文件(v3 紧凑格式,每个文件记录一行)记录了 `history/``common/` 里所有直写中文的英文翻译,供英文覆盖层使用。每个文件还存了字节的 sha256,校验时只重新解析变过的文件。
每条记录用"在哪个键下面、第几次出现"来定位中文文本,不用行号(行号会随编辑漂移)。清单由工具维护,不要手改 JSON:
- 新增中文条目:`node tools/history_language_manifest.mjs add <file> <chinese> <english> [--occurrence N]`
- 改了 `history/``common/` 文件后若 `validate.mjs``manifest-stale``node tools/history_language_manifest.mjs stamp` 刷新哈希(会先全量校验,内容不合法会拒绝)
- `build_history_english.mjs build` 在清单过期时拒绝构建,构建成功后会自动 stamp
改了这个清单等于改了英文层。直接改英文层文件会绕过清单,下次校验会失败。
需要同步更新清单的情况:
- **删了文件** -> stamp 自动移除对应文件块
- **新增了含中文的字段** -> 用 add 命令添加条目
- **改动不动中文 token**(改数值、日期、注释等)-> stamp 刷新哈希即可
- **改了字段名、删了字段、改了文件结构** -> 对应条目定位会失败(validate 报错),必须先手工修正清单条目再 stamp
## 校验
改完跑:
```sh
node tools/validate.mjs
```
一个命令查所有:引用完整性、重复定义、本地化完整性、编码、翻译清单一致性、英文覆盖层。有 error 时退出码非零,必须修到零 error 再收工。
## 编码与实现规则
- 不写防御性代码:不要添加 fallback、旧逻辑兼容、宽泛 `try/catch`、猜测性类型转换或针对假想输入的分支。输入不符合约定时让错误暴露,先查调用方和数据。
- 不为私有实现细节、过去事故的固定数字、当前数据的偶然状态或假想边界添加测试。测试必须对应已知、可复现的风险。
- 新增测试前先确认现有校验没有覆盖该风险。删除不能证明当前行为的测试。
- 批量修改前统计目标文件和字段数。发现同名、重复值或上下文不唯一时停止自动替换,逐项核对。
- 批处理报错或中断后,先检查已写入内容,再决定继续或回退;不得直接重跑。
## 已知合法状态
- 282、283、2406、5355、5365、5538、5539、5600 是有 `add_core` 的合法无主荒野;未殖民省份也可无 `owner`
- 5806-6441 范围内的 137 个省份是 Comprehensive Map 新增的合法无主荒地(西伯利亚、澳大利亚、波利尼西亚、中非等),有 culture/religion 但无 owner。
- 1098(圣赫勒拿)、856(萨卡特卡斯)是原版无主省份。
- `REB` 是原版 `countries/Rebels.txt` 定义的真实 tag。
- `DTK` 没有国旗,且开局不可达;不要补造资源。
- SOF 标签在原版层有 Segu/Sofala 歧义,这是原版自身问题,mod 层已消除。
- `flavorTUR.txt` 中的 EY0-EY9、E10-E17 是 `eyalet_effect` 的字符串标识符,不是国家标签。
- 注释中的部分重音字符损坏(如 `flavorDAN.txt` 里 Sara Wendel-Örtqvist 的 Ö)来自上游,不影响游戏。
## 危险操作
执行前先征得用户确认:
- 删除或覆盖多个数据文件,或从其他工作树整目录恢复。
- 修改 `map/definition.csv``map/default.map``provinces.bmp`
- 强制 push、`reset --hard``clean -f`
其他分支、工作树、临时目录和上游模组只能用于逐项对照,不能作为整文件恢复来源。提交前检查没有把创意工坊下载、临时对比文件或本地存档纳入版本控制。