Generate compact classic NPC mapping from ProjectEQ data

2026-07-29 10:40:45 -07:00
parent 561ace9443
commit b4e622c79b
7 changed files with 920 additions and 4 deletions
@@ -18,6 +18,25 @@ cargo test
 cargo build --release
 ```

+## Refreshing the PEQ NPC gender index
+
+The checked-in `generated/peq-npc-gender-index.json` is generated data, not a
+runtime database dependency. Regenerate it from an explicit ProjectEQ dump
+with the tool below; it reads either `create_tables_content.sql` directly or
+the `peq-dump/create_tables_content.sql` member of the supplied zip archive.
+`unzip` is available in `shell.nix` for the latter.
+
+```bash
+cargo run --bin generate_peq_npc_index -- \
+  --dump "$HOME/Downloads/peq-1759046415.zip" \
+  --output generated/peq-npc-gender-index.json
+```
+
+The tool prints its input identity, complete conflict/neuter statistics, and
+output size. Run it twice and compare the output hashes before updating the
+checked-in artifact. The source archive and any temporary database files must
+not be committed or included in release archives.
+
 The parser tests cover the observed log formats, including NPC dialogue,
 channel-chat exclusion, zone events, normalization, persistent/random speaker
 voice policies, log truncation, and first-run log discovery.