| name | agd-deobfuscate |
| description | Identify and add new AnimeGameData field deobfuscation mappings by comparing cleartext and obfuscated AGD revisions. Use when a new Genshin Impact build changes obfuscated JSON field names or when rust/istaroth-agd-regen/src/deob.rs needs a new version mapping block. |
Fill in new deobfuscation entries in rust/istaroth-agd-regen/src/deob.rs by comparing a cleartext AGD revision against a new obfuscated HEAD revision.
Context
AnimeGameData (AGD, at path <AGD>) periodically ships new builds where field names in JSON files are obfuscated. The file rust/istaroth-agd-regen/src/deob.rs maintains COMMON, a static map of obfuscated keys → cleartext field names. Each new obfuscation round needs a new batch of entries.
The set of fields to find is determined by reading the latest comment block section already in COMMON (e.g. // OSRELWin6.3.0_R41701329_S41708913_D41667700) and using its cleartext values as the target list.
Workflow
1. Read the existing file
Read rust/istaroth-agd-regen/src/deob.rs to find:
- The latest comment section block and the cleartext field names it maps (these are the fields to find for the new version)
- All existing obfuscated keys (to avoid duplicates)
2. Identify the HEAD commit title
cd <AGD> && git log --oneline HEAD | head -1
This gives the comment label for the new section (e.g. CNRELWin6.4.0_R42630645_S42523468_D42623923).
3. Compare reference files
Use these four reference file types (adjust filenames to ones that exist at both revisions):
BinOutput/Quest/<id>.json — quest-level fields plus subQuests and talks itemsBinOutput/Talk/Npc/<id>.json — talkId, dialogList, dialog item fieldsBinOutput/Talk/GadgetGroup/<id>.json — configId, talks (group-level)BinOutput/Talk/NpcGroup/<id>.json — npcId, talks (group-level)
For each file, show both revisions:
cd <AGD>
git show <cleartext_rev>:<file_path>
git show HEAD:<file_path>
4. Build the mapping
Match values between cleartext and obfuscated versions to identify which obfuscated key corresponds to which cleartext field.
Quest file disambiguation tip: id, resId, series, and chapterId can all share the same value in some quests. Cross-check with a second quest (e.g. BinOutput/Quest/74078.json) where they differ:
git show <cleartext_rev>:BinOutput/Quest/74078.json | python3 -c "
import json,sys; d=json.load(sys.stdin)
print('id:', d.get('id'), 'resId:', d.get('resId'), 'series:', d.get('series'), 'chapterId:', d.get('chapterId'))"
git show HEAD:BinOutput/Quest/74078.json | python3 -c "
import json,sys; d=json.load(sys.stdin)
for k,v in d.items():
if isinstance(v,int) and v>1000: print(k,':',v)"
5. Verify
Cross-check identified keys against a second quest file to confirm subId/order/questId/npcId:
git show HEAD:BinOutput/Quest/74078.json | python3 -c "
import json,sys; d=json.load(sys.stdin)
sq=d.get('<subQuests_key>',[])
for s in sq[:2]: print({k:v for k,v in s.items() if isinstance(v,int) and v>0})
tk=d.get('<talks_key>',[])
for t in tk[:2]: print({k:v for k,v in t.items() if isinstance(v,(int,list)) and v})"
6. Add entries to deob.rs
Append a new block at the end of COMMON in rust/istaroth-agd-regen/src/deob.rs, covering exactly the fields from the latest previous section that were found in the reference files:
("<OBF_KEY>", "<cleartext_field>"),
...
Only include fields actually observed in the reference files. Skip any that could not be confirmed. Rebuild and run the tests (AGD_PATH=<AGD> cargo test --manifest-path rust/Cargo.toml) to confirm.
Notes
- The same obfuscated key may appear at multiple nesting levels (e.g.
id appears in top-level quest, inside subQuests items, and inside talks items — all map to the same key).
npcId in NpcGroup files also appears as activityId at the group's top level — false collision; npcId is correct for item context and the top-level field is unused by this codebase.- Confirm no new key duplicates an existing entry in
COMMON before adding.
ANECDOTE (for ExcelBinOutput/AnecdoteExcelConfigData.json) is a separate per-file mapping whose cleartext names are invented — the file has shipped obfuscated since its 5.4 introduction, so no cleartext revision exists to diff against. Re-derive its keys each build by value-matching entries against the previous build's file: anecdote ids, quest ids, and the cleartext isHide are stable anchors, and the deobfuscate_anecdote_excel_config_data test in rust/istaroth-agd-regen/tests/agd_integration.rs pins the expected hashes for entry 100001.
