recomp/patches-v121.txt gets set fov on the two camera routines the aspect set already patches, at the load of the
camera's vertical view angle (+0x13c): camera update main+0xcb4ad8, camera setup main+0x1252194. The update site matches
1.4.3's instruction for instruction around the load; the setup site copies the camera's fields with other instructions
and registers before it and matches 1.4.3's from the load on. Both call sinf, cosf and tanf in the same order as on
1.4.3. Each version fills sead's perspective projection this way in ten places, each with its counterpart in the other
version: these two camera copies, which are the only places 1.4.3 patches, and eight others (inlined copies, projection
routines and four projections on the stack), none patched. The replacement words are those of the 1.1.0 and 1.4.3 sets
(x10 kept on the stack, s8 overwritten by the next instruction), so no register liveness is assumed. #621 (ipavlin98,
closed by its author) chose the same two sites with x8 and s2 as scratch registers.
The setting's text in totk.ini.example and in the four menu languages names 1.2.1, and the comment of
runtime/resolution.c res_fov_live names the patch files of all three versions.
Co-Authored-By: Claude <noreply@anthropic.com>
The game thread hands its sound commands to the audio thread in lists: 16, of which 4 are always held, so at most 12
wait in the command ring. The game thread submits at most one per update (1.2.1 main+0x9bd144), the audio thread
takes one per 5 ms audio frame (after a list, main+0x883780 goes on past the ring's check). Above about 200 updates a
second the ring stays full. The game's guard (main+0x9bcdc4) counts the updates that find the ring of free lists
empty and exactly 12 lists in the command ring (0x9bce1c cmp w9, #0xc); the count returns to 0 only when a free list
is there. At every multiple of 300 (10 s at 30 fps, 1.25 s at 240) it clears the sound command switch
(main+0x2268bfc) and stops every active voice (main+0x226f29c). Only the switch's constructor sets it to 1
(main+0xf31ce8, from the engine's init main+0xf31530), so the game is silent until it is restarted.
Measured on 1.2.1 (Linux, RX 6750 XT), same save and scripted input, mix dumped without a device: with fps_limit 60,
144, 180, 200 and 201 the mix has sound; with 205, 210, 220, 230, 239 and 240 it goes silent after the boot logo and
stays silent, also at the 130-148 fps of the scene that follows. The guard is read from the code; the switch going
to 0 has not been observed in a run.
The set audiodrain (TOTK_AUDIO_DRAIN_FIX, audio_drain_fix, on by default) sends the audio thread back to the ring's
check after each list, so it takes every queued list in the pass: one site per version (1.2.1 main+0x883780, 1.4.3
main+0x149244), each going to a target the game's own code already branches to in the same way (1.2.1 main+0x883c18,
1.4.3 main+0x149700). The setting is in runtime/cfg.c, totk.ini.example and docs/settings.md.
At fps_limit 240, 120 s runs of one build per game version with the set switched, seconds with sound in the mix: on
1.2.1 5 of 118 with the set off and 108 of 118 with it on; on 1.4.3 2 of 118 off and 110 of 119 on. Not run:
Windows. Not covered: 1.1.0, whose main we do not have, so its table has no site and it keeps the game's code.
Co-Authored-By: Claude <noreply@anthropic.com>
After the design in #845 by itaskaev2. New patch lines carry an exlaunch plugin whose init runs at every
start: `plugin` lifts the module from its image after the init (the hook stubs and trampolines the file
has as zeros) and names the hash of that .text, `expect` lists the words the init writes into the game,
`stub` lifts an inline-hook stub's branch to its trampoline as a return, `seed` adds the callbacks, impls
and targets, and `orig` lists an unpatched copy of a hooked main function (fo_<address>) at the replace
hook's trampoline address in the plugin's function table, so the plugin's call of the original does not
reach the hook again and rt_dispatch stays as it is.
A replacement word @call:<module>+<offset> calls the stub without writing x30, with every register in
the Cpu before it and read back after it; the site's own instruction runs after it in place. patches.h
gets RT_PLUGINS, RT_PLUGIN_WRITES and RT_PLUGIN_ROOTS for the runtime. Without plugin lines the output is
byte-identical to dev (generated C, patches.h and layout of 1.2.1 and 1.4.3).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
recomp/layout.py appends a mod's code modules (exlaunch plugins such as exefs/subsdk9) after sdk as plugin0..N in
mod load order, so the game modules keep their bases; layout.json names each plugin's NSO and its SHA-256, and without
plugins layout.json and layout.h stay byte-identical. gen.py --plugins lifts them with DT_INIT and the init_array
entries as extra seeds, and Module.eh_frame_functions accepts a MOD0 with an empty .eh_frame_hdr range. build_game.py
takes the plugin rows from layout.json into modules.c instead of asking the ExeFS hash table for them.
No-mod generated C is byte-identical to dev; with MSFix in the layout main, subsdk0 and sdk are too.
After the design in #845 by itaskaev2.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The cascade set loads the four constructor defaults of the depth shadow parameters (main+0x6fabb8, 0x6fac40,
0x6facc8, 0x6fad4c) from page +64..+76. In Hyrule Field that does not move the sun's cascades: frame dumps of the
0.4.1 release at shadow_range 100 and 300 show the same draws per layer and the same cascade transforms, though the
log names the new distances. As on 1.2.1, the shadow controller sets bit 1 of the scene's depth shadow flags when it
starts (main+0xb74494), the per-view update skips its copy of the parameters while the bit is set (main+0x567f6c), and
main+0x68318c writes the boundaries every frame.
Two more sites scale d[1..n] where the controller stores them (main+0x6836ec, main+0x683740) by page +64 over 20,
i.e. shadow_range / 100; d[0], the first cascade's start, stays. The four constructor sites stay for the path where
bit 1 is clear. Off at shadow_range = 100.
Co-Authored-By: Claude <noreply@anthropic.com>
On 1.2.1 the constructor values of depth_shadow_near_0_0..3 (main+0x114c2f8..) are only defaults: the shadow
controller sets bit 1 of the scene's depth shadow flags when it starts (main+0xc7b0e8), the per-view update skips its
copy of those parameters while the bit is set (main+0xa2cff4), and main+0xcebdf4 writes the cascade boundaries itself
every frame. The cascade set scales d[1..n] where they are stored (main+0xcec314, main+0xcec36c) by page +64 over 20,
i.e. shadow_range / 100; d[0], the first cascade's start, stays. Off at shadow_range = 100.
Co-Authored-By: Claude <noreply@anthropic.com>
The menu exposed dynamic_res on 1.1.0, but its patch table had no fixres
set, so disabling it left the engine's 80/90/100 percent tiers active.
Patch the scale returned by the controller's common epilogue, matching
the existing 1.2.1 and 1.4.3 implementation. The configured render scale
remains the maximum size, and enabling dynamic resolution restores the
original controller live.
Extend the 1.1.0 differential patch tests across dynamic tiers and both
switch states, checking register, SIMD and flag preservation. All 51
sites and 889 spin back-edges match local ExeFS; 720 native/Unicorn cases
pass. All five runtime probes pass. Live off/on/off testing shows native
3440x1440, lower tiers when enabled, and 3440x1440 again when disabled.
A patch set marked `ordered` (recomp/patches.py) belongs to something the player orders; tools/exefs_patches.py marks
the mods' ExeFS patch sets so. A site two or more ordered sets patch is contested: its ordered alternatives test one
byte, rt_patch_pick[<site>], instead of each set's switch, and patches.h lists the contested sites with their sets for
the runtime. Other alternatives keep their place and switch, so a cheat before the mods' sets still wins while it is
on. Sites with at most one ordered set, and tables without contested sites, are emitted as before, patches.h
included. The pick goes into the lift cache key.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Playtests showed no visible difference from lod_range, and the emulator mod scene dropped the same change as a placebo.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The pick patched before (main+0x1ee8424) is reached through its vtable only when the method is overridden; the culling
passes run about 20 inlined copies of it, so the switch changed almost nothing. The lodrange set patches the two places
per version that compute the level depth B at model setup (the setter and its inlined copy); the slope of the coarser
levels follows from B there, and max takes B = 1e30. The menu row sits under Grass range, with Steady detail under load
after it.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diagnostic only. The lifted MSR FPCR (recomp/lifter.py) now also tests the stored RMode bits (cpu.h RT_FPCR_NOTE); the
first nonzero one is logged once by main.c rt_fpcr_rmode with the caller of the writing function. The write itself
behaves as before. Whether the line ever shows decides if the directed-rounding slow paths of runtime/simd.h are dead
in the game. 10 MSR FPCR sites on 1.4.3; nothing on the other paths.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
FN_ENTER (runtime/cpu.h) opened all 282,702 lifted functions of 1.4.3 with a load of g_fnprof and a branch, for one
reader: runtime/resolution.c res_fn_hit, which waits for main+0x585bd0 (SET_RENDER_SIZE). A `hook` line of the patch
table (recomp/patches.py) now names the functions that keep it; patches-v143.txt hooks main+0x585bd0, and gen.py stops
on a hook that is no function start. Tables without hook lines (1.2.1, 1.1.0) keep FN_ENTER in every function, and
gen.py --fn-enter-all puts it everywhere for a whole-game function-entry profile. The hooked addresses of a chunk are
in its lift cache key (tests/lift_cache_test.py test_hooks_are_in_the_key).
On 1.4.3 the generated C is otherwise byte-identical to dev's (282,701 FN_ENTER lines fewer, nothing else differs).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The weapon's hit-record pool holds 10 records, and one charged swing above 60 fps fills it: the
insert fails, and the list of hits made this frame stays empty. main+0x2906de0 then reads the empty
list's slot, which holds a stale stack value, and passes it to the hit handler before the game's own
count == 0 check would return; the stale value here pointed at the temp hit map and the read at
main+0x870158 faulted reading 0x100000000a.
Both count == 0 branches now go to main+0x2906df0, the game's check, under the realtime set. A
non-empty list is unchanged, and below 60 fps the pool never fills.
Verified on 1.4.3: a charged spear attack on an enemy at 120 and 144 fps no longer faults, and the
damage at 60 and 120 fps matches the build without this patch.
The conflict in recomp/gen.py was the Usage line and the options next to --v-locals and --v-trust; both are kept, and
v_locals and v_trust are in the Emitter options the cache key holds.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
K = 8 cut guest time 3.9-6.2% in the town on a 7900X against K = 0. func.py tests the same default; --v-locals 0
gives the previous output.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
recomp/vlocals.py rewrites each emitted function: c->v forms become the RT_VLOCALS accessors of runtime/simd.h, the
K registers the function names most get bits in VMASK, they are loaded at entry, stored where the dirty mask may hold
them before calls and exits, and reloaded after calls; --v-trust skips the reload of V8-V15. A function with a form the
rewrite does not know keeps every register in the Cpu. K = 0, the default, emits the same C as before. The manifest
counts the rewritten functions and syncs. tests/diff/func.py takes --v-locals, --v-trust and --work (one work
directory per concurrent run).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The ability guard (runtime/ov_ability.c) checks the holder, the actor, its component and the reference word the game
writes, so it catches every bad target seen in the reports: -1, 0x80, an empty bounding box (FLT_MAX) and a vtable in
main's data. The optref site at main+0x1bd01c8 (1.2.1: 0x1622bf4) is dropped: set ability patches the same address and
must win there.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The holder of the PlayerVirtualKey request can be freed while the request still points at it; its first word then reads
as a small number and the game dereferences it as the target actor. No guest object lives below 2^32, so such a target
now takes the game's own branch for a null target. Same TOTK_OPTREF_GUARD switch as the existing optref site.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The game links an actor whose link record is null without complaint, so UltraTears' live-actor test could drop
targets the game handles. A target is now dropped only when the holder, the actor or its component is unreadable, or
the word the game's reference takes (+0x90, an atomic read-modify-write) is unreadable or in a module's code or
read-only data. The live-actor test logs the targets it would reject and changes nothing.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Set ability (1.4.3 main+0x1bd01c4, 1.2.1 main+0x1622bf0): the target actor load becomes a host call that reads the
holder safely and drops an actor failing the live-actor test (link record points back and carries its id), as
UltraTears found; the game's own cbz skips it for that frame. The answer comes back in x9, since the lifted code keeps
x21 in a C local across calls. Set report (1.4.3 only): the model scene report loop sends a negative handle or a row
index from 0x8000 to the game's handle reset, the class Weeping of the Empire met (#52, #73). Both on by default,
TOTK_ABILITY_GUARD=0 / TOTK_REPORT_GUARD=0 turn them off.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The game checks the reference only for null, and players' crash dumps show it holding 0xffffffffffffffff after minutes to hours of play. MacNativeGames met the same field holding 0xffff0000ffffffff during a save load. Set optref (TOTK_OPTREF_GUARD, on by default) turns the cbz into a test for null or negative; valid holders are heap addresses below 2^63.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The game grows grass blades only inside its near grass map, a 62.5 m square around the camera drawn into 256x256 and
128x128 textures, so on open meadows the grass appears a short way in front of the player. grass_range (percent, 50
to 400, default 100) scales the map's extent, step and both textures together through a new grass patch set (1.2.1
and 1.4.3) that loads them from patch page +128..+144, and grows the HeapDef grass heap and the application pool for
the larger textures. At 100 the set stays off and nothing changes. A row in the Display menu, text in all four menu
languages, and totk.ini.example describe it.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
gen.py lifted every chunk on each run and only skipped rewriting the ones whose text came out the same, so a rebuild
after one changed code cheat still spent the whole lift (102 s on 12 cores, 178 s with 4 workers) to recompile two
chunks. A chunk's text depends only on the generator's sources and options, the module and the function starts
discovered from it, the chunk's number and functions, and the patch sites and spin waits inside its address range, so
the SHA-256 of these is now its key. <mod>/lift_cache.json records each chunk's key with the SHA-256, size and mtime of
its file and the statistics and folded ranges the manifest and folded.txt need, under a digest of the entry. A chunk
whose entry is intact, whose key matches and whose file is unchanged is reused without a worker; no pool starts when
nothing is left to lift. The cache is written after the manifest, and a failed write only warns. --no-cache, or
TOTK_LIFT_CACHE=0 for the installer's lift, lifts everything.
On 1.4.3 with the installed mods' cheats, a run with unchanged inputs takes 4 s and one with a changed cheat word lifts
one chunk in 7 s. Its output equals a --no-cache lift into an empty folder and the previous gen.py's output byte for
byte. tests/lift_cache_test.py checks reuse and invalidation on a module it makes itself.
The climb velocity step (1.4.3 main+0x1f49754, 1.2.1 main+0x1918220) multiplies the requested velocity by Nintendo's
factor for a movement loss that grows with the frame rate. 1.4.3 fits it at 30 and 60 fps and caps it at 2 from about
77 fps (63% climb speed at 120, 34% at 240); 1.2.1 has no 60 fps branch (78% at 60). Below a 1/60 s step the set climb
continues the factor with a curve fitted to a replayed ladder climb, taking the patch page's frame ratio without the
time scale, so 30 and 60 fps keep the shipping factor bit for bit, slow motion included. Only the player's climb
modules reach this code. Its own setting, climb_fix under [frame rate], with a menu toggle; off without the real-time
step. Ladder replay, 1.4.3: 1.665 / 1.663 / 1.669 / 1.681 m/s at 30 / 60 / 120 / 240 (shipping 120 1.046, 240 0.563).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ActorCheckRotateModule's update compared the angle a gear turned since the last update with one 30 Hz frame's worth,
so above 30 fps gears and water wheels read as stopped and the Riogok, Turakamik and Wind Temple doors stayed shut.
The new set gears keeps the update context's +8 (frames elapsed in 30 Hz units, the value 1.4.3 divides by) and
multiplies the threshold by it. Measured: the context is 0.25 at 120 fps with the real-time step and 0.5 at 60 fps
without it.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The game picks a scene tier of 100, 90 or 80 % mostly from a fixed cost model made for the Switch that grows with the
scene width squared, so on a wide output it drops to 80 % on any GPU: at 5120x1440 every frame drew 80 % of the scene.
Patch set fixres replaces the one instruction that moves the tier's scale into the controller's result (1.2.1
main+0xcc2c00, 1.4.3 main+0x5848a8 as MacNativeGames patches it) with 1.0. The new setting dynamic_res (menu toggle,
live) brings the game's stepping back and is on by default in the Steam Deck profile.
The scene cap goes from 4096 to 8192 a side, so render_scale above 80 works on a 32:9 output, and the scene also stays
within a DynamicTextureAllocatorMem under 2 GiB; the log says when it was made smaller. The memory selftest now maps
past the real pool size instead of a fixed 4 GiB, which a larger scene grows past.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
An IPS, IPS32 or pchtxt file for main that writes main's .rodata, .data or .bss was refused as a whole. Such writes
need no lifting: tools/exefs_patches.py now puts them in build-cache/exefs.data, and runtime/mods.c stores them into
the loaded main before any game code runs, as emulators and Atmosphere apply a patch file to the module before its
dynamic linker runs. A DT_RELR word gets main's base added; bytes over words an explicit-addend relocation fills change
nothing and are dropped; a write into the dynamic linker's tables, a lazily bound function pointer or outside main's
image keeps the file unsupported. A mod whose data lines do not all fit the build keeps its code patches off too.
The mods are applied from the bottom one up (mods_exefs_apply), so where two mods write the same bytes the higher one
wins, as it does for files. --probe-mods checks it with two mods writing one byte.
The lifted code reads some of main's bytes at lift time (the jump tables). recomp/gen.py lists those ranges in
<gen>/main/folded.txt, and the setup checks the data writes against them after the lift: a file that writes them
becomes unsupported, since the change would not reach the generated code. Generated C without mods is unchanged.
This is the data part of #790 (ericdallo's ExeFS work), split out on its own; the plugin part follows separately.
Co-Authored-By: itaskaev2 <165683571+itaskaev2@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The 72 mouse_direct sites of patches-v143.txt mapped to the 1.2.1 main by enclosing function, each original word
checked: the camera input update, free orbit, Ultrahand and the 16 player camera modes. 1.2.1 keeps some values in
other registers and stack slots (camera input x in s11, orbit angles at sp+0x3c/0x40, Ultrahand x in s9), so the
hooks read a per-version MouseLayout; the 1.4.3 values and behaviour are unchanged.
Where 1.2.1 adds a turn in a shared helper, the degrees go to the store of the helper's result (Aiming's pitch
target, new ROLE_BASE_STORE) or to the turn it is given (Horse yaw). Wakeboard, ShieldSurfing and Tail read the stick
twice (REPEAT on the first read), the dialogue cameras' angle loads are pre-indexed (mov -> add, as ClimbObj).
The player state (ability, bow in hand) is not known on 1.2.1 and reads as not found.
tests/mouse_direct_check.py runs the hooks with both layouts and checks each load-site table against its patch file.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The ClimbObj pitch hook replaced the pre-indexed load ldr s1, [x22, #0x88]! and wrote the write-back to x22 from the
host call. The lifter keeps X19-X29 in locals across a call and does not reload them, so the write-back was lost and
the following str s0, [x22] wrote the pitch over the camera object's vtable pointer; the next virtual call crashed
(seen climbing a Stone Talus). The mov x22, x19 before the load is now patched to add x22, x19, #0x88, the hook
performs a plain ldr s1, [x22], and load hooks no longer support write-back loads at all.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Only the free camera took the mouse as degrees. The other camera modes took it as stick input, which their own speeds,
frame time, slow motion and curves reshaped, with the on-foot camera's square-root pitch shaping on top: bow aiming was
far too sensitive vertically on slow movements, abilities and the Purah Pad camera eased their pitch, lock-on turned
27% slower, and climbing, shield surfing and the rest each turned at their own rate.
Each camera mode's update now loads the gamepad's part of the stick where it computes its turn and adds the mouse's
degrees where it adds that turn to its angle (runtime/mouse_direct.c camera_load, the load sites of
recomp/patches-v143.txt): aiming, scope, abilities (and Recall's cursor), horse, Purah Pad camera, lock-on, bow
lock-on, wall and object climbing, the waterfall's turn, shield surfing, wakeboard and the dialogue cameras. Recall's
cursor moves so that its aim turns as many degrees a count. The waterfall's height and the horse's empty lock-on are
not angles and stay stick input, now linear. A step whose mouse motion no hook took is logged with the camera's name.
Holding L to soothe the horse gave the mouse to the ability wheel's virtual cursor, a held stick for the camera: the
mouse goes to the wheel and the D-pad strips only while their screen has the focus (menu_cursor.c
menu_cursor_shortcut). A mouse shake no longer plays a 0.8 s swing after it: the right stick follows the mouse's own
swings and lets go when it rests, and the camera does not turn by that swing.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The level picker is the same function in 1.4.3 (main+0x1ee8424) with the same first words and an early return straight
to its ret, so the lod site takes the 1.2.1 words as they are. The graphics settings setup (main+0x5868c4) inlines the
getters that 1.2.1 calls, and their slow paths come back before the compare, so the steady site is the compare itself:
w10 is set to 9 there and the list walk is skipped to the epilogue, which does not read w10. The menu texts, README and
totk.ini.example now name both versions.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The map cursor, the vertical Ultrahand aim and the vertical gyro aim moved a fixed step per frame, so above 30 fps they ran faster with the frame rate (#44, #394). The new set cursor multiplies each step by the game's own 30 Hz ratio, ported from MacNativeGames 363a6eb and switched by TOTK_HIGHFPS_FIX.
Map pan with the same stick input on 1.2.1: 398 px/s at 30 fps, 1150 px/s at about 105 fps before, 402 px/s after. The Ultrahand and gyro sites were not exercised in game. 1.1.0 is not covered: its module is not available here to check the sites.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>