docs/building.md merges the two toolchain docs and the README build steps, and lists the developer checks. The Maxwell reference moves to docs/maxwell.md. architecture.md loses the milestone table, controls.md describes timed script lines and input recording, and the tester guide includes shader preparation. The agent skills, hooks, playbook, backlog and the study notes on upstream projects are the maintainer's local setup: .claude/, notes/ and CLAUDE.local.md are ignored now, and tools/worktree.py links them into task worktrees. AGENTS.md keeps the project rules. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
3.6 KiB
Tester guide: running TotK Recomp on your GPU
This guide is for testing the build on a GPU other than the developer's (AMD RX 9070). You build it from source with your own copy of the game and your own console keys. Nothing from the game is in this repository, and nothing you build from it may be shared.
What you need
- Windows 10 or later, an x86-64 CPU with AVX2, about 60 GB free.
- A GPU with Vulkan 1.3 and
VK_EXT_external_memory_host, with a current driver. - Tears of the Kingdom base game (1.0.0) and the 1.2.1 update, dumped from your own Switch as NSP or XCI.
prod.keysdumped from your own Switch. Never send it to anyone, and never paste it into a log or an issue.
Build
- Follow building.md: the toolchain, then build steps 1-6 (Python environments,
config.local.tomlwith your own paths, extraction, the shader translator, lifting and linking, shader preparation). The result isbuild\v121\totk.exe. - Check the build without the game:
build\v121\totk.exe --selftestmust print a pass. - To run the build on another of your machines, package a portable folder (building.md, "Portable folder"). The folder holds game code: for your own machines only.
- The installer (installer.md) is the other route to a machine without the toolchain: it builds the game there from your own files. No installer release is published yet.
Run and collect the log
The log goes to stderr. Run from cmd.exe in the repository root, so the log lands in a file:
set TOTK_VK_VALIDATION=1
build\v121\totk.exe 2> totk-log.txt
TOTK_VK_VALIDATION=1 turns on the Vulkan validation layer (it comes with the Vulkan SDK). It makes the game slower;
do one run with it and one without (set TOTK_VK_VALIDATION=).
Keep the window in the foreground: an unfocused window stalls the game. Shaders the preparation did not cover compile on first use, so the first minutes of play can stutter. Play into the open field (load a save, walk around for a minute, fight something if you can), then close the window.
Choosing the GPU
A laptop with an iGPU and a discrete GPU, or two cards, lists every GPU at the top of the log (vk: gpu 0: ...).
set TOTK_GPU_NAME=Radeonpicks the first usable GPU whose name contains that text (case does not matter).set TOTK_GPU_INDEX=1picks GPU 1 from that list.
The line vk: using gpu N: <name> says which one ran.
What to send back
totk-log.txtfrom each run. It contains no keys and no game files. The lines that matter most start withvk caps:(GPU, driver, features and the fallbacks taken),vk: gpu,validationandgfx_shader:.- GPU model, driver version, CPU, RAM, and whether it is a laptop.
- What you saw: how far it got (menu, loading, field), roughly how smooth it ran, and screenshots of anything wrong (black or missing areas, flickering, wrong colours, missing grass). Win+Shift+S is fine.
- If it crashed or hung: the last 50 lines of the log and what you were doing.
- For a bug you can trigger again: a recording of your input (
set TOTK_INPUT_RECORD=input.txt, see controls.md, "Scripted input") and the save you started from.
Switches for the developer's questions
Only set these when asked; each forces a fallback the build picks by itself on GPUs that need it.
| Variable | Effect |
|---|---|
TOTK_VK_NO_FLOAT64=1 |
Translate shaders without 64-bit floats |
TOTK_VK_SSBO_ALIGN=64 |
Treat storage buffers as needing 64-byte alignment |
TOTK_VK_SUBGROUP_PIN=0 |
Do not pin shaders to 32 lanes; tell the translator the GPU's own subgroup size |
Each switch makes the first launch translate every shader again.