Skip to content

feat(builder): the damaged game files a build replaced are listed in the game folder (#2237) - #2254

Merged
hckrman101 merged 2 commits into
NotRexed:mainfrom
bronze-ff:feat/damaged-files-note
Nov 11, 2026
Merged

hckrman101 merged 2 commits into
NotRexed:mainfrom
bronze-ff:feat/damaged-files-note

Conversation

@bronze-ff

Copy link
Copy Markdown
Contributor

Part of #2237 (its item 2: write the list into the game folder).

The problem

When a dump is incomplete, the build replaces each damaged game file with a similar one and prints the list (Your game dump is incomplete: ...). The list is easy to miss in the build's output, and it is printed only once per unpack: a later build or update of the same folder skips the check. The player then reports a missing floor or a wrong texture (#1700), and nothing in the game folder says the dump was the cause.

The change

  • stand_in_damaged_files() also writes the same text to hookshot_damaged_files.txt in the game folder, beside hookshot_version.txt.
  • The file is removed when a later unpack finds no damaged file (a complete dump built into the same folder).
  • The readme's problem table has a row for it, so triage can ask "is there a hookshot_damaged_files.txt in your game folder?".

The printed text is unchanged. Items 1, 3 and 4 of #2237 are not in this change.

Tests

nx2/test_nup_zstd_heads.py checks that the file is written with the damaged file and its stand-in, and that it is removed after an unpack with no damage.

Run on Windows 11, Python 3.14:

  • python -I -B nx2/test_nup_zstd_heads.py: 5 tests, OK
  • python -I -B nx2/test_nup_stand_in.py: ok
  • python -I -B tests/test_make_game_cache.py: 11 tests, OK (1 skipped)
  • python -I -B tests/test_missing_nup.py: 8 tests, OK

Not tested: a full build from a real incomplete dump.

Note: #2096 and #2253 touch the same function; whichever lands second needs a small rebase, which I will do.

🤖 Generated with Claude Code

bronze-ff and others added 2 commits November 11, 2026 09:02
…the game folder (NotRexed#2237)

The list of damaged dump files and their stand-ins was only printed, once
per unpack. It is now also written to hookshot_damaged_files.txt in the
game folder, and removed when a later unpack finds no damaged file. The
readme's problem table names the file.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@hckrman101
hckrman101 merged commit 6b2bcba into NotRexed:main Nov 11, 2026
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant