Version 3.1.0: voice lines linked across all languages from the game data

data/catalog/README.md

@@ -6,7 +6,7 @@
 | `BANK_locations.csv.gz` | every stored copy of the `BANK` sounds, and the prefetch heads of speech lines (below) |
 | `SUB_<LANG>.csv` | subtitles of the speech lines, one file per language (11 languages; `docs/formats/subtitles.md`) |
 | `SUB_locations.csv.gz` | every stored copy of each subtitle string (dialogue objects in the packages) |
-| `characters.csv` | `name,character,language`: verified speaker per line name (empty `language`: every language; `ITA`: an ITA position name, for lines without a game line name) |
+| `characters.csv` | `name,character,language`: verified speaker per line name (empty `language`: every language, the same line everywhere; a language code would label a sound of that language only - none needs it now) |
 | `index.json` | per archive: fingerprint of the game files the CSV was built from (`ackit/game.py: wad_fingerprint`, `ackit/banks.py: game_fingerprint`) and counts |
 | `source/<lang>/*.txt` | **the curated original lists** (one file per character, one wemscan-style file name per line, e.g. `Speech_TAPE_JOKER_1_4.wem`). `Files.txt` = all files, `Stats.txt` = counts, `Checkpoint.txt` = progress marker. Never edited by tools. |
 
@@ -17,12 +17,13 @@ All CSVs are UTF-8 with a header row. They contain only names and metadata (no g
 |--------|---------|
 | `archive` | `ITA`, `INT`, ..., `SFX` or `BANK` |
 | `target` | location: `HASH` (WAD entry with one WEM), `HASH:i` (i-th variation, 0-based), `PACK/MEDIA` (music stream pack), `MEDIA` (BANK: Wwise media ID) |
-| `name` | display name. Speech: the game's line name (the speech event, e.g. `Speech_TAPE_JOKER_1_04`), the same line in every language; lines no event plays keep `NAME` / `NAME_i` (position). SFX: `NAME`, `NAME_1..n`. BANK: the Wwise event that plays it (`Play_..._i`) or `<Bank>_<n>` |
+| `name` | display name. Speech: the line's name, the same in every language (`docs/decisions.md` 5): its speech event (e.g. `Speech_TAPE_JOKER_1_04`, `NAME#2` = second version an event plays) or, for lines no named event plays, the INT recording's position name. A recording stored twice keeps its position name in the second place. SFX: `NAME`, `NAME_1..n`. BANK: the Wwise event that plays it (`Play_..._i`) or `<Bank>_<n>` |
 | `aliases` | other accepted names, `\|`-separated: `NAME#i` = i-th WEM of the entry in this language's WAD (positions differ between languages), the entry name for single entries, `<Bank>/<MEDIA>` for BANK |
 | `group` | Speech, Music, Ambience, SFX, Unknown (`docs/categories.md`) |
 | `category` | finer category (`docs/categories.md`) |
 | `bank` | BANK: the soundbank holding the sound (first by name if several do); empty for WAD sounds |
-| `language` | BANK: language of a localized speech line (`INT`, `FRA`, `ITA`, `DEU`, `ESN`); empty = shared by all languages. The editor shows the shared sounds + the selected language's lines; names are unique per language |
+| `language` | BANK: language(s) of a localized speech line, `;`-separated (`ITA`, or `ESN;FRA;INT;ITA` for one recording shared by those); empty = the same sound in every language. The editor shows the sounds of the selected language; names are unique per language |
+| `line` | speech (WAD and BANK): the line's identity, the same in every language (smallest Wwise Sound object ID of the line; `ackit/lines.py`). Two rows of one archive with the same `line` are one recording stored twice (written together). Empty for non-speech sounds |
 | `character` | verified speaker(s) from `characters.csv`, `; `-separated, empty if unknown |
 | `characters_inferred` | characters/roles mentioned by the name (and bank) (hint only) |
 | `seconds`, `rate`, `channels` | of the original sound |
@@ -51,7 +52,7 @@ heads (`docs/formats/banks.md`).
 | `text` | original subtitle text |
 | `room` | maximum length of a replacement in characters (it is written in place) |
 | `enc` | `a` = cp1252 string, `w` = UTF-16 string |
-| `sound` | key of the linked speech sound: this language's WAD line or in-memory `BANK:` line (the INT ones for languages without voices); empty when no event reaches a sound |
+| `sound` | key(s) of the linked voice recording(s), `;`-separated when the event plays two versions: this language's WAD line or in-memory `BANK:` line (the INT ones for languages without voices); empty when no event reaches a sound |
 
 `SUB_locations.csv.gz`: `lang, speech, line, file, pos` (hex, uncompressed offset of the FString), `size`, `enc`.
 Menu text has no catalog: the localization files are read directly (`docs/formats/text.md`).
@@ -62,9 +63,12 @@ scans the game itself and applies the same rules (no checksums then; the bank sc
 
 ## Rebuilding / adding a language
 1. Make sure the game files are original (`ackit status`; `ackit revert --all`).
-2. Optional: add listening-based lists for another language in `source/<lang>/<Character>.txt` (same format;
-   names are the same in every language, so the Italian lists already label all languages).
+2. Optional: add listening-based lists for another language in `source/<lang>/<Character>.txt` (same format:
+   wemscan names of THAT language's WAD). Each list is resolved against its own language's positions and moved
+   to the lines, so a label then applies to the same recording in every language.
 3. Run `python tools/build_catalog.py` - it scans every archive and all soundbanks of the installed game (all
-   languages present; ~5 minutes) and rewrites the CSVs, the location index, `characters.csv` and `index.json`.
+   languages present; ~5 minutes) and rewrites the CSVs, the location indexes, `characters.csv` and `index.json`.
+   It stops before writing anything if a sound differs from the current catalog (a modified game); after a game
+   update run it with `--accept-changes`.
 4. Run `ackit verify --catalog` (no issues expected).
 New character labels need a display name in `ackit/classify.py: USER_LABELS` (otherwise the file name is used).