Clean up docs

This commit is contained in:
2026-10-09 01:15:22 +02:00
parent c1e0bddfff
commit f2bc986a82
4 changed files with 6 additions and 21 deletions

View File

@@ -21,10 +21,6 @@
Contains a per-user installer (`Install.cmd`): install, upgrade and uninstall (Settings > Apps) verified.
## What is not verified / limitations
- **Linux package not executed**: no Linux machine, WSL distribution or container runtime was available. The code
is portable (no Windows-only calls outside the developer-only in-game harness), Linux/Proton discovery is unit
tested with a simulated home folder, and the build procedure + CI workflow are provided
(`docs/building.md`, `.github/workflows/build.yml`).
- Speech lines being *heard* in the game needs gameplay; verified indirectly (same decoder/WAD path as the music
test, byte-level apply/revert, boot test with modified speech WAD).
- Speech/effects replacements must fit the original's size (index lives in compressed `.upk` packages).
@@ -33,7 +29,5 @@
- Character labels outside the user's lists are inferred from names (marked as such), not verified speakers.
## Next steps
1. Run the CI workflow (or the Linux steps in `docs/building.md`) on Ubuntu 22.04 and test the tarball on a Steam
Deck/desktop with the game under Proton.
2. Extend the curated speaker lists (`data/catalog/source/<lang>/*.txt`) and rebuild with `tools/build_catalog.py`.
3. Optional: rewrite the BKPK indexes inside `.upk` packages (LZO) to lift the size limit for speech.
1. Extend the curated speaker lists (`data/catalog/source/<lang>/*.txt`) and rebuild with `tools/build_catalog.py`.
2. Optional: rewrite the BKPK indexes inside `.upk` packages (LZO) to lift the size limit for speech.