mirror of https://github.com/tangerineturtle1/NX2navi.git synced 2026-11-15 19:19:58 -04:00

Files

chrg6 d15d4e2fbd Keep the runtime's shaders in the repository as source only, and compile them when the game is built.

The fifteen headers of SPIR-V words under runtime/ are no longer tracked. tools/build_shaders.py builds all of them:
the GLSL with glslc, the SPIR-V assembly with spirv-as, and the two shaders assembled in Python from their scripts.
build_game.py builds the missing and the stale ones before it compiles the runtime, and the build kit, the launcher
release and the AppImage build them before they copy runtime/, so a player's PC still needs no shader compiler.
git ignores the headers and check_content.py refuses a compiled shader in a commit. The headers built this way are
byte for byte the ones removed here. vk_mvobj_fs.h is now mvobj_fs_spv.h, named like the others.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

2026-11-10 01:53:41 -05:00

3.0 KiB

Raw Blame History

NX2navi

Static recompilation of Ocarina of Time (Switch 2, ARM64, game version 1.1.1) into a native Windows x86-64 exe with a Vulkan renderer. Design: docs/architecture.md. Toolchain, build commands and tests: docs/building.md. The players' launcher, setup and updates: docs/launcher.md.

Game content boundary

The user's game and key paths are in config.local.toml (ignored). Pass the keys file path to tools; the tools read it themselves. Key values stay out of your output, logs, commands and files.
Everything extracted or generated goes under build/ or generated/.
Every file the code generator emits carries the marker defined as GENERATED_MARKER in tools/check_content.py.
Run python tools/check_content.py --staged before proposing a commit. It is the same check CI runs.

Reusing code

refs/ holds the pinned checkout the build reads (tools/fetch_refs.sh recreates it). Read-only.

Copy only MIT, BSD, ISC, zlib or Apache-2.0 code, keep its header, and add a row to THIRD_PARTY_NOTICES.md.
GPL code is never copied: write our own.
tools/vendor/ stays byte-identical to its source; Windows changes go in tools/extract.py.

Code

Build C with MSYS2 UCRT64 Clang (C:\msys64\ucrt64\bin). Generated C uses GNU extensions, so cl.exe is out. Call Ninja from that directory by full path or put it first on PATH.
Two Python environments: .venv (3.12) for the lifter and the build, .venv-py314 for the extraction and shader scripts, which need compression.zstd.
Generated C is never edited by hand: change the generator (recomp/).
The runtime's own shaders are checked in as source only (runtime/shaders/, tools/make_dlaa_mask.py, tools/make_mvobj_fs.py). tools/build_shaders.py builds runtime/<name>_spv.h from them, build_game.py runs it, git ignores the headers and check_content.py refuses them in a commit.
Every lifter change passes the differential tests against Unicorn (docs/building.md, "Checks"). After changing recomp/jumptables.py, tests\jumptables_check.py reports 0 disagreements on 1.2.1 and 1.4.3.
recomp/layout.py alone decides module bases.
Graphics bugs: docs/maxwell.md lists the Maxwell behaviour the Vulkan path must match, what goes wrong when it does not, and what our runtime does.
Comments say what the code does and why, in words that stand on their own. Cite our code by file plus function (a line number may follow as a hint). Comments and docs do not name other projects or say where code came from: the license header of copied code and its THIRD_PARTY_NOTICES.md row carry that.

Writing

Code, comments, docs and commit messages are in English. Commit messages are plain sentences without type prefixes.