Skip to content

Add an opt-in BOTW model heap overlay - #2415

Open
NotRllyRn wants to merge 4 commits into
seedds:mainfrom
NotRllyRn:fix/botw-model-heap-overlay
Open

NotRllyRn wants to merge 4 commits into
seedds:mainfrom
NotRllyRn:fix/botw-model-heap-overlay

Conversation

@NotRllyRn

Copy link
Copy Markdown

What and why

Add an opt-in script adapted from #27 that creates a separate BOTW RomFS overlay with increased model heap budgets. It addresses a remaining model-loading crash near Gerudo Canyon Stable. This is a workaround; the remaining runtime overhead is unresolved.

The script preserves source files, bounds parsing, rejects ambiguous discovered model hashes, and publishes complete output without overwriting existing files.

Checked

  • Passed: 12 synthetic overlay tests, 6 documentation tests, and full-diff whitespace checks.
  • BOTW 1.9.0 (01007EF00011E000), Apple M3 Max, macOS 26.6.2: the player confirmed the same stable crash-point check passed without crashes or major lag. The log contained no crash entries or [RED] errors.
  • Gameplay used contribution commit e1f9051f: a freshly built host and regenerated game patches, a matching reused shader cache, a newly generated overlay, and a separate verified copy of the saves. The later commit only records this validation.
  • Pinned Ruff/Pyright reports no new findings in this contribution. The full ratchet still fails on two findings in unchanged dm/gfx/tools/dmsh_entry.py (Ruff F401 and Pyright reportOptionalSubscript).
  • Other locations, iOS, and long-session memory behavior remain untested. Earlier measurements in the game note used a customized runtime and are labeled separately.
  • No broad multi-game regression: this adds an opt-in BOTW-only script, tests, and a game note, with no runtime or shared-tool changes.

Docs

  • BOTW game note covers generation, rollback, scope, limitations, and gameplay evidence.
  • No game files, keys, or extracted game data are included.

@github-actions github-actions Bot added tools Tools and scripts (dm/tools, scripts) docs Documentation game: 01007EF00011E000 The Legend of Zelda: Breath of the Wild labels Nov 12, 2026
@dontpokethebear3893

Copy link
Copy Markdown

I created a PR for the game launcher to have a slider for higher heap budgets. I found it was required for higher resolutions:
#2284

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation game: 01007EF00011E000 The Legend of Zelda: Breath of the Wild tools Tools and scripts (dm/tools, scripts)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants