490 Commits
Author SHA1 Message Date
Valiantsin DzerakhandClaude Opus 5.5 d27ba2eb9f Merge task/overlap: sync_ahead = 1 also works without shadow storage on a discrete GPU, as Savage Wind's overlap: the GPU reads the game's memory in place behind guards (staged mirror syncs, word-merged write-backs, CPU deswizzle of rewritten textures, invalidates that wait for their writer, one-off small targets), and TOTK_SYNC_AHEAD=check measures what a late wait would race; off by default. On machine B the frame is 1.0 ms (fort) to 2.3 ms (islands) shorter with the 1% lows within noise (#1129, #1192)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 15:07:57 +03:00
Valiantsin DzerakhandClaude Opus 5.5 9422939cb7 totk.ini.example: sync_ahead no longer needs shadow storage on a discrete GPU; without it the GPU reads the game's memory in place behind guards, and only memory = import still refuses the switch
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 14:48:26 +03:00
Valiantsin DzerakhandClaude Opus 5.5 54b4e092cd The in-place frame ahead merges every mirror write-back by words, is refused with import memory, and the probe checks its pending-write list
Without shadow storage a plain GPU copy back into a mirrored range lands after the game, told the value is done a
frame early, may have written other words of that range for the next frame; with TOTK_SYNC_AHEAD_WBMERGE (1 by
default) the copies' and updates' write-backs go through the word merge as a shader's do. With memory = import the
GPU reads vertex, index and storage data in place, and a check run on the islands saw the game rewrite about 10 KiB of
them a frame after the wait, so the switch is refused there unless shadow storage is on. --probe-vkmem checks the
pending-write list (newest writer below a bound, pruning, joining when full). The one-off readback rule copied from
Savage Wind gets its THIRD_PARTY_NOTICES.md row.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 14:43:45 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c5fba2f2bc Merge pull request #1330: a perf trace can run without its dirty census (perf_census = 0), which costs a traced Steam Deck frame about 3 %; the census runs only in the import memory mode (klikso, #946)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 14:12:14 +03:00
Valiantsin DzerakhandClaude Opus 5.5 ce47fdda3f perf_census: the settings row says the census runs only in the import memory mode, since a mirror prints its own mem lines (#946)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 14:10:35 +03:00
Valiantsin Dzerakh a4c761c98c Merge pull request #1330: switch to turn off the perf trace's dirty census (klikso) (#946) 2026-11-21 14:04:42 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b558317a7a TOTK_SYNC_AHEAD=1 works without shadow storage: the frame wait is answered one frame late with the GPU reading the game's memory in place, as Savage Wind does
With shadow off the back end turns on guards, each with its own switch: the mirror syncs copy the synced pages into staging on the CPU at submit and wait for an earlier write-back into the same range first (TOTK_SYNC_AHEAD_MSYNC), a texture the CPU rewrote takes the CPU deswizzle (TOTK_SYNC_AHEAD_DESWZ), an invalidate of a range not read lately waits for the pending GPU write into it, from a bounded list pruned at completion (TOTK_SYNC_AHEAD_READS), and the frame wait waits up to the value of a one-off small target (Savage Wind's 16-frame, 64-entry rule, TOTK_SYNC_AHEAD_ONESHOT) or, off by default, of a samples-passed report (TOTK_SYNC_AHEAD_QUERIES). TOTK_SYNC_AHEAD_CHECK=1 runs the check-mode detector with the late wait itself. The shadow form and the default are unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 10:42:03 +03:00
Valiantsin DzerakhandClaude Opus 5.5 df10f20fe4 The sync-ahead check's offender table counts a frame once per pool and class
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 10:19:26 +03:00
Valiantsin DzerakhandClaude Opus 5.5 eec2314584 The sync-ahead check skips repeated notes without the lock and looks up memory state once per range
A binding the replay resolves again in the same submission hits a per-thread table of the last notes, and the byte
compare walks the memory state once per union range instead of once per written page: the check's game-thread cost on
the islands bench went from 5-9 to about 3 ms a frame. The log line gives the notes taken and the time of each step.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 09:47:44 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f5fbe9df15 The sync-ahead check counts every frame as if the GPU were behind, and compares bytes as well as written pages
Whether the game writes what the GPU still reads does not depend on this machine's timing, so check mode now takes the
late wait's value at every frame wait (the frames where the GPU really was behind are counted apart). The set's bytes
are copied at the snap: a written page counts its changed bytes too, and the mirror sync copies are narrowed to the
bytes the frame binds from the mirror (class bound), since a page written only outside them races nothing it reads.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 09:42:18 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1ab3856fdd TOTK_SYNC_AHEAD=check measures what a one-frame-late frame wait without shadow storage would race, with the wait left exact
The replay notes each GPU-timeline access of guest memory with its submission's value (in-place bindings of imported
pools without a mirror, mirror sync copies, GPU deswizzle sources, mirror write-backs); at the frame wait the notes of
the frame the late wait would leave running form its read set, snapped with the write watch and checked again at the
next frame-wait entry. Invalidates and small-target write-backs of GPU results from that frame count as stale
readbacks. One summary line per second and a run summary with the largest offenders by pool (runtime/vk_ahead.c).
--probe-vkmem checks the detector with a synthetic write after the wait; tests/sync_ahead_check.py checks that check
mode keeps the wait exact.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 09:19:54 +03:00
kliksoandClaude Opus 5.5 14fa37a318 A switch to turn off the perf trace's dirty census, which slows a traced Steam Deck run by about 3% (#946)
TOTK_PERF_CENSUS=0 (perf_census in totk.ini) keeps TOTK_TRACE=perf and its frame lines but skips the write-watch
queries the census makes at every submit, so a perf trace on Linux measures the frame without them. On an LCD Steam
Deck at Lookout Landing (dev, three interleaved runs each) the census costs about 0.8 ms a frame: 38.0-38.3 fps with
it, 39.1-39.4 fps without, 1% low 30.5-31.5 against 32.1-33.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:00:13 +00:00
Valiantsin DzerakhandClaude Opus 5.5 e0aa6f15dc Merge task/fsr31: AMD FSR 3.1 upscales the 3D scene on the FidelityFX SDK 1.1.4 sources on any GPU (scene_upscaler = fsr3, off by default) with its own sharpening and AMD's mip bias, and the per-object motion vectors shared by DLSS, FSR 3.1 and frame generation cost about 0.65 ms less render-thread time in the town (#537, #1158)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 20:25:17 +03:00
Valiantsin DzerakhandClaude Opus 5.5 7a768aa343 Merge task/fg: frame generation with AMD FSR 3 on the FidelityFX SDK 1.1.4 sources (frame_gen = fsr3, off by default, a row on the Game tab), with the per-object motion vectors and contexts kept across dynamic resolution changes (#460)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 20:25:08 +03:00
Valiantsin DzerakhandClaude Opus 5.5 22794ab332 Merge task/fg into task/fsr31: frame generation's per-object motion vectors and its contexts kept across dynamic resolution, on one motion gate with FSR 3.1
vk_objmv_wanted is FSR 3.1's latched upscaler half (DLSS with NGX up, or FSR 3.1 picked at start) or frame generation following the scene with its objects (vk_fg_objects_on), and vk_mvprev_frame turns the tables on for the running upscaler or for frame generation. vk_usnap.c keeps this branch's host regions: a region's host flag says whether this submission wrote its host copy, which covers frame generation going on and off live without fg's separate U.host pointer. The jitter fix in mv_pass stays a single copy.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 20:15:40 +03:00
Valiantsin DzerakhandClaude Opus 5.5 49e8e92fe9 Merge dev into task/fg: the jitter fix for the per-object motion vectors (#1126) and the setup window work
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 20:12:32 +03:00
Valiantsin DzerakhandClaude Opus 5.5 5e3475c583 With the per-object motion on, the uniform snapshot copies into host memory only the regions the CPU reads back (those holding a vertex-stage block of a bank the motion compares, or of the camera, c4) and writes the rest straight into the device copy, as with the motion off; before, the whole snapshot went through host memory, every byte copied twice. A host region is still copied into host memory first and from there into the device copy, so both hold the same bytes while the game writes guest memory. vk_usnap_bytes reads a host region's host copy and any other from the device copy (slow through the BAR, which only rare readers reach: the merged uniform updates and the test surveys), so every reader gets the bytes it got before. The last-frame copy (vk_usnap_prev) takes host regions only. The snapshot summary gives the bytes copied into host memory.
Field still view, 28 s, TOTK_MVPREV_CHECK=1: mv_check 0 of 60 checks with over 0.5 % object pixels fit better by a variant; mv_prev intact 100 % in c5, c6, c7, c14, c15 and c16; 0 of 214238 last-frame copies differ from the neighbour copies.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:53:34 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b8edbdd873 The per-object motion reads last frame's object and bone blocks from last frame's uniform snapshot, kept one more frame, instead of having every snapshot copy both neighbours of each such block: the town's snapshot was 2836 KiB a submission with the neighbours and 1916 KiB without, and each byte is copied twice with the motion on (into host memory for the CPU's reads, then into the device copy). vk_mvprev_find still picks the address; the block's bytes and the motion draw's descriptor come from vk_usnap_prev. A block bound at the same address both frames keeps this frame's copy, as before.
Lifetime: a scene submission's arena (vk_usnap_scene, from the scene draws vk_mvprev notes) is kept at its vk_usnap_end as the last-frame copy instead of going to the free list at its fence. The next scene submission's end, or any end once the motion is off, hands the kept arena to the completion thread with that submission's fence, then keeps its own. The motion draws that bind the kept arena are listed and recorded within the next scene submission (vk_mvobj_execute drops a list of another fence), so the GPU has read it before that fence; the fences of one queue complete in order, so its own submission's reads are done too. One arena is held beyond those in flight, whatever the session length; vk_usnap_shutdown frees it with the others. A frame whose scene spans two submissions finds only the last one's blocks; the others keep the camera's motion.

TOTK_MVPREV_CHECK=1 still copies the neighbours and compares them with the kept copy. Field still view, 28 s: the mv_prev lines intact 100 % in c5, c6, c7, c14, c15 and c16; over whole blocks 87 of 218320 last-frame copies differ from the neighbour copy (the game changed the other copy after last frame's submit; the kept copy is what last frame drew); mv_check 0 of 60 checks with over 0.5 % object pixels fit better by a variant, object end-point error median 0.98 px against the camera's 1.27; the c7 lookups split as before (nearer to side 1.87, reference 1.83).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:49:47 +03:00
Valiantsin DzerakhandClaude Opus 5.5 68fdda05c1 Merge task/setupui: the setup window has a cleaner form (sections, More details, the share notice next to Start) in the Windows 11 look of the Sun Valley theme and speaks seven more languages, German, French, Spanish, Italian, Dutch, Japanese and Korean, from the setup part of pull request #497 (itaskaev2, #497, #815)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:46:06 +03:00
itaskaev2andClaude Opus 5.5 8427d8e006 The setup speaks German, French, Spanish, Italian, Dutch, Japanese and Korean, picked from the Windows display language, with every Chinese Windows on the Simplified Chinese setup and the game language starting as the window's where the game has it (the setup part of pull request #497; its in-game menu part stays out, as it covers about two thirds of today's menu)
Taken from #497: the seven catalogs, the language choice in installer/guilogic.py and the launcher, the launcher header and bundle check in the release scripts, the tests. Added here: the ids dev and this branch gained since (kit, PC prompts and display shapes steps, the locked exe and skipped plugins messages, the form sections and More details), and new translations of the ids whose English changed after #497 was translated (NSZ and XCZ input, the missing shared fonts warning, the PlayStation prompts). README gains a Languages table that shows the menu in four languages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:45:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 82a1f526a9 The per-object motion keeps last frame's blocks only for the banks its listing looks up (c5, c6, c7, c14, c15 and c16 in the town and the field) instead of every bank a variant reads (c5 to c16 but c12): the scene draws stop probing the c8, c9, c10, c11 and c13 blocks into the table and the snapshot stops copying their neighbours, none of which a lookup ever read (c9 and c11 stay at this frame's block, the others belong to shaders that are not drawn again). The table entries of the banks looked up are the same as before, so the vectors are too. The listing's per-shader memo now comes before the shader's resource list and also keeps the filters' verdict, so a scene draw that is no candidate costs one memo probe.
Noting only the candidates' blocks was tried and dropped: the table then misses the other draws' blocks, a sixth of the c7 "nearer" picks became "side" ones, the copies mo_similar refuses doubled and the field still check got 5 of 60 checks with over 0.5 % object pixels fit better by a variant (0 before).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:44:10 +03:00
Valiantsin DzerakhandClaude Opus 5.5 7b1d240331 A value picked in the setup window's language boxes no longer stays highlighted as selected text
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:38:43 +03:00
Valiantsin DzerakhandClaude Opus 5.5 95aac58d45 The setup window draws in the light Sun Valley ttk theme (sv-ttk 2.6.1, MIT, vendored unmodified in installer/vendor/sv_ttk), the Windows 11 look; its fonts follow the display scale, its palette no longer overrides our label colours, and the platform theme stays when it does not load
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:34:35 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bf96d7d6c8 The setup form groups its fields into Game files and Install sections with short labels, keeps the explanations under a More details link, moves the share notice next to Start in quiet text, and sizes the window to the shown screen so no screen carries the empty band of a taller one
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:30:43 +03:00
Valiantsin DzerakhandClaude Opus 5.5 9c0dc49dc5 On 1.4.3 the per-object motion vectors no longer carry the camera jitter: the motion draws run with the jittered scene camera again, so DLSS stops moving the history of characters by up to a pixel each frame (shaking, softness) (#1126)
Since the jitter went into the game's camera (#1284), cam_unjitter writes the scene camera's snapshot back without it from the scene's end, before the DLSS point where vk_mvobj_execute redraws the moving objects through that snapshot. The draws rasterised unjittered and their fragment shader took the jitter off a second time. TOTK_MV_CHECK on a still Link (FSR 3.1 path, task/fsr31) measured the object part equal to the frame's jitter in every check; with the jittered rows written back around the motion draws and taken off after them, object pixels on a still Link fell from 1.2-2.1 % to about 0, and the object vectors beat the camera's (median end-point error 0.68 px against 0.88, before 0.93 against 0.82).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:22:38 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d95257204b Merge task/mvjit: on 1.4.3 the per-object motion vectors are drawn with the jittered scene camera again, so DLSS no longer shakes and softens Link and other characters after the camera jitter move (#1126)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:22:33 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8dc1fe1bf4 On 1.4.3 the per-object motion vectors no longer carry the camera jitter: the motion draws run with the jittered scene camera again, so DLSS stops moving the history of characters by up to a pixel each frame (shaking, softness) (#1126)
Since the jitter went into the game's camera (#1284), cam_unjitter writes the scene camera's snapshot back without it from the scene's end, before the DLSS point where vk_mvobj_execute redraws the moving objects through that snapshot. The draws rasterised unjittered and their fragment shader took the jitter off a second time. TOTK_MV_CHECK on a still Link (FSR 3.1 path, task/fsr31) measured the object part equal to the frame's jitter in every check; with the jittered rows written back around the motion draws and taken off after them, object pixels on a still Link fell from 1.2-2.1 % to about 0, and the object vectors beat the camera's (median end-point error 0.68 px against 0.88, before 0.93 against 0.82).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 19:22:11 +03:00
Valiantsin DzerakhandClaude Opus 5.5 28f3fcc8d5 With FSR 3.1 upscaling, the scene's material textures take AMD's mip bias, log2(scene / output) - 1 (-1.58 at quality, -1 in place), where DLSS keeps NVIDIA's log2(scene / output); the bias follows the mode and the upscaler going on or off. Field still view at quality, 1080p, mean absolute Laplacian of luma on the far cliff: 2.31 -> 2.82 against 4.09 with FSR off; grass near Link unchanged (5.53 -> 5.56, its blades are flat-coloured geometry). FSR's auto exposure was tried with it and left out: grass softer (5.53 -> 4.96) with no visible gain.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 16:21:02 +03:00
fef31d9f7c FSR 3.1 sharpens its own picture at a new setting, fsr_sharpness (default 80, 0 off, live, a slider under the upscaler on the menu), as the game's sharpening sits in the FXAA draw FSR replaces; while FSR 3.1 runs the game's dynamic resolution stays at 100 %, and in place it skips the game's FXAA and its copy of the scene onto itself. The fix follows codexx-dev's pull request #1245. Town still view, 1080p, mean absolute Laplacian of luma: quality 5.2 -> 7.9 against 9.4 with FSR off.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: codexx-dev <221918751+codexx-dev@users.noreply.github.com>
2026-11-20 16:10:46 +03:00
14ccef9a80 AMD FSR 3.1 upscales the 3D scene on the FidelityFX SDK 1.1.4 sources behind scene_upscaler = fsr3, off by default
scene_upscaler (off | dlss | fsr3, read at start) replaces the dlaa toggle on the Screen tab; without the key dlaa = 1
still means DLSS, so nobody gets FSR 3.1 without picking it. The DLSS mode row is the upscaling mode of both engines,
the DLSS model, characters' mask, fixed exposure and effects-after rows show only with DLSS, and the performance
overlay names the upscaler that ran and its mode. resolution.c sizes the scene for the engine picked at start.

runtime/vk_fsr3.cpp drives the SDK's upscaler context on its Vulkan backend directly, as Savage Wind's fsr3.cpp does:
one context per output size with the output as its largest render size (the modes and the dynamic resolution need
no new context), HDR input (the light target before the bloom, where DLSS reads it), render-size motion vectors with
the per-object pass, the camera jitter, the camera's planes and field of view from the scene block (vk_fg_camera; a
cut starts a new history), FSR's sharpening off. vk_dlaa.c calls it at the DLSS point after the recorder's drain;
the NGX path is left as it was. The backend's per-frame rings hold four dispatches: a dispatch waits for the one three
back should it still be in flight. Frame generation stays off while FSR 3.1 runs (logged once).

The SDK subset gains the upscaler component, its shader headers, FSR 1's (its RCAS) and its GLSL, from Savage Wind's
copy unchanged; tools/ffx_shaders.py --effects fu builds its blobs (HDR, 32- and 16-bit floats) into
spirv/ffx_fsr3upscaler_vk.h, and vk_fg.cpp's blob lookup hands those out through vk_fsr3_blob. The luma history's
storage image is declared rgba16f, its images' format (rgba8 in the SDK; the validation layer reported it).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Revivedx <82332536+Revivedx@users.noreply.github.com>
2026-11-20 14:39:57 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0a299a41ec Frame generation keeps its contexts when the game's dynamic resolution changes the scene size, instead of making them again after a device idle each time
In the town the scene moved between 1600x896, 1432x808 and 1280x720 under a 1080p output; vk_fg_prepare compared the
scene size with the contexts' and made the contexts again each time, 58 times in 222 s of a user's session, each after
vkDeviceWaitIdle (89 ms measured). The contexts are now made for scenes up to the output's size (or a larger scene's,
once one comes) as the SDK's maxRenderSize, and each frame passes its own size as renderSize to the prepare and the
interpolation: the SDK sizes its images by maxRenderSize, dispatches over renderSize and divides the motion vector scale
by it. A frame at another size than the last starts the interpolation over (its dilated depth and vectors from last
frame are of the other size); the summary line counts those.

Checked: 60 s in the town with two scene size changes, no remake and the replay thread's FG time at most 6.4 ms; a run
at render_scale = 50 (960x536 scene, 1920x1080 contexts) generates Link running without a double image.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 14:30:51 +03:00
Valiantsin DzerakhandClaude Opus 5.5 380e6ff30e Frame generation gets the per-object motion vectors DLSS uses, so Link running no longer shows a soft second outline and a trail in the generated pictures
The motion image FG read held the camera's motion alone (fg_motion called mv_pass without its object pass). The camera
follows Link, so his pixels carried the world's motion and the interpolation drew him twice, with a smeared strip where
he had been; NPCs and enemies did the same. fg_motion now runs mv_pass with the object pass (vk_mvobj_execute), and its
gates follow vk_objmv_wanted: DLSS once NGX came up (vk_dlaa_available, as before) or FG following the scene with its
objects (vk_fg_objects_on). vk_mvprev_frame keeps last frame's block tables for either, vk_usnap_begin makes the host
copy for either and vk_usnap_bytes reads the copy that submission wrote (FG turns on and off live), and
vk_dlaa_prev_camera answers whenever the scene is followed. FG is off with DLSS, so every DLSS gate evaluates as before.
fg_objects = 0 keeps the camera's motion alone for comparisons.

Measured on A (RX 9070, 7900X on 4 cores, 1080p, field, 60 s): 85.6 drawn with fg_objects = 0, 80.0 with 1 (about
0.8 ms a drawn frame on the replay thread, half of it the snapshot's host copy), object pass 0.035 ms GPU. Still grass
gets no false motion (SDK debug view: the game vector field stays within 0.2 px), and grass does not break up while the
camera turns. Validation: 0 errors.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 14:30:51 +03:00
efee9bcf16 Frame generation gets a row on the Game tab under the frame limit (Off or AMD FSR 3) that applies at once, and the fps overlay reads "N fps drawn, M shown" while it runs
The row and its description (for displays of 120 Hz and more, the game at half the limit, about half a frame more input delay, not with DLSS or HDR) are in the menu's catalog for English, Russian, Portuguese (Brazil) and Simplified Chinese. frame_gen is live: vk_fg.cpp vk_fg_engine reads it again after a settings change, the contexts are made at the first frame after it is turned on (a hitch of about 0.1 s once), turned off they stay unused until exit, and gfx_present.c builds the swapchain again when the extra image for the pair comes or goes. The full overlay gets a Shown row. totk.ini.example describes frame_gen.

The shown-frames counter and the overlay lines follow PR #1089 by xellow78-lgtm.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: xellow78-lgtm <336264245+xellow78-lgtm@users.noreply.github.com>
2026-11-20 13:48:10 +03:00
451813aa17 Frame generation shows its pictures: each drawn frame goes out as a pair, the generated picture once the GPU has drawn the frame and the game's half the smoothed interval later, and the game draws at half the frame limit while it does
vk_backend.c present_pair: both blits are submitted at once (gfx_present.c vk_present_blit_pair, the flip queue of two), the generated picture is presented after a timeline wait on the frame's last submission and not before the pacer's display time, the game's frame after a wait on the value after both blits and half the smoothed interval between generated pictures (factor 0.1) after it, as AMD's frame interpolation swapchain and Savage Wind's present_wait_turn do: spaced by the CPU clock alone both pictures went on screen together under FIFO and G-SYNC. The swapchain gets one image more while frame_gen names a generator, for the two images held at once; the present slots stay at two (each blit waits on the fence of the blit two before, the previous frame's same picture, already shown). The generated picture's blit lays the menu and overlay out, the game's draws them again; colour and FSR 1 run per blit; the flight recorder keeps the game's frames; the generated present carries no present ID. frame_rate.c frame_step_cap_ns halves the limit, 30 drawn at least, while the last frame went out with a generated picture, so menus and fades keep the whole limit; the real-time step follows the game's presents and stays the drawn interval. With frame_gen = off the present path is unchanged. "fg present" log lines give shown and drawn fps and the present intervals (mean, sd, p99, each half of the pair) in the world.

Measured on the RX 9070 and the 7900X on 4 cores, field save, camera turning, 1080p output: limit 120 immediate 117 shown and 60 drawn, intervals 8.34 ms sd 0.16 from generated to game's, 8.38 sd 1.71 back; FIFO at 144 Hz the same at 120, and 141 shown and 72 drawn without a limit; immediate without a limit 169 shown and 86 drawn against 94 drawn with frame_gen = off. Replay-thread cost 0.59-0.65 ms a drawn frame.

The flip queue, the pair blit, the halving rule and the present without an ID follow PR #1089 by xellow78-lgtm.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: xellow78-lgtm <336264245+xellow78-lgtm@users.noreply.github.com>
2026-11-20 10:38:58 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a7275e6644 frame_gen names the frame generator, off or fsr3 (default off), instead of 0 or 1, so later generators (FSR 4 through AMD's DLL, DLSS) become values of the same setting
vk_fg.cpp vk_fg_engine is the one place that reads the string and maps it to VkFgEngine; an unknown value is off and logged once. The setting was never released, so 0 and 1 are not kept as aliases.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 10:20:18 +03:00
1ea8838da9 Frame generation inputs and dispatch with DLSS off: the replay follows the scene for it, records the camera motion vectors and the SDK's prepare at the scene's end, copies the picture before the HUD sRGB-encoded as the window texture holds it, and runs the optical flow and the interpolation after the frame's window texture, nothing shown yet
vk_dlaa.c follows the scene while frame_gen is live and DLSS is off (track: the arming and end of the DLSS path, without jitter, reactive mask or per-object motion), fg_motion runs mv_pass on the camera alone and vk_fg_prepare, vk_dlaa_hud takes the picture before the HUD by PR #1089's rule once the bloom chain began, vk_dlaa_sub_end runs the interpolation at the end of the submission that drew the window texture. vk_fg.cpp reads the camera's planes and depth convention from the scene block's projection (standard depth, near 0.1 m, far 25 km in TotK 1.4.3), makes the contexts again when sizes or the convention change, resets the history on a cut (10 m or 35 degrees, as Savage Wind), a frame without camera motion and after any frame without a generated picture, and stays off with DLSS, replay workers, sync_ahead, HDR and while a menu background or a fade is open. fg_test, fg_debug, fg_shot and fg_times are the checks; GPU timestamps and the replay thread's recording time go to the log.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Revivedx <82332536+Revivedx@users.noreply.github.com>
Co-Authored-By: xellow78-lgtm <336264245+xellow78-lgtm@users.noreply.github.com>
2026-11-20 10:09:58 +03:00
4e48669c86 FidelityFX SDK 1.1.4 frame interpolation and optical flow built into totk.exe behind frame_gen, contexts created and destroyed only, no frame-path change
The SDK subset, its compat header and the SPIR-V shader header come from Savage Wind (MIT); tools/ffx_shaders.py regenerates the header with glslangValidator, build_game.py compiles the SDK sources with ffx_compat.h force-included, and runtime/vk_fg.cpp makes the backend, optical flow and frame interpolation contexts after the device exists when frame_gen = 1 (default 0, read at start).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Revivedx <82332536+Revivedx@users.noreply.github.com>
2026-11-20 09:40:26 +03:00
Valiantsin DzerakhandClaude Opus 5.5 25a53e5ef2 Merge pull request #1213: a free camera on 1.4.3 that detaches the view from Link and flies it with the gamepad or the keyboard and mouse, off by default behind its own switch on the Controls tab (lebomis, #1199)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 08:27:39 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8c3831a1f3 The free camera is off by default behind its own switch, Free camera on the Controls tab (freecam_patch, read at start), so the camera update runs the game's code as shipped for players who never use it; the combo and key rows stay greyed until the switch is on and the game restarted, and the freecam set sits at the end of the 1.4.3 table so the sets before it keep their numbers (#1199)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 08:16:57 +03:00
Valiantsin DzerakhandClaude Opus 5.5 53f9e9bb5f Merge pull request #1213 into task/pr1213
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 08:13:57 +03:00
Valiantsin DzerakhandClaude Opus 5.5 aa60148df1 Merge pull request #1299: with pcss on, soft shadows keep their width on the ground from one sun cascade to the next instead of turning 3.5 to 5 times softer at each step (itaskaev2, #1291)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 08:05:10 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f0011b89dd Merge task/cjkfont: the shared fonts reach the game decoded as on the console, so Chinese and Korean text no longer draws with the wrong font's metrics and the ellipsis sits on the line (#591)
Same fix as MacNativeGames pull request #2145 by lostars, pointed out by rcyggdra.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 22:05:23 +03:00
Valiantsin DzerakhandClaude Opus 5.5 dba68c903d The shared font comment in ov_system.c wraps at 120 columns (#591)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 22:05:22 +03:00
Valiantsin DzerakhandClaude Opus 5.5 41eb234db4 The nn::pl shared fonts reach the game decoded to plain sfnt after the BFTTF header, as the pl shared memory holds them, so the font loader no longer hands the encoded payload to Decode and Chinese text keeps its ellipsis on the line (#591)
The firmware files keep the font XOR-encoded. The game's font loader reads the data at GetSharedFontAddress as a font only when it starts with an sfnt tag; otherwise it calls nn::fontll::ScalableFontEngineHelper::Decode, which returns NULL for the encoded payload, and the face is left without a name. font_data now decodes the payload in place after ov_bfttf_size accepts the file and checks for an sfnt tag. The services probe checks the unchanged header at Address - 8 and plain sfnt at Address. Same fix as MacNativeGames pull request #2145 (shared_font.c load).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 22:04:54 +03:00
Valiantsin DzerakhandClaude Opus 5.5 424a66bba3 Merge pull request #1295: the Tenbez Shrine launchers throw the ball into the other launcher's seat above 30 fps on 1.4.3, with its own switch shutter_fix (shinodanpen, #1215)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 22:02:44 +03:00
Valiantsin DzerakhandClaude Opus 5.5 02220fc879 The Tenbez Shrine launcher set has its own switch, shutter_fix, and sits at the end of the 1.4.3 table, so the sets after it keep their numbers and a lift changes one chunk; the comment names the second AI file that uses the node (#1215)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 22:02:34 +03:00
Valiantsin Dzerakh 1bcb8acfed Merge branch 'pr1295-head' into task/pr1295 2026-11-19 21:15:54 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8eec0eeedf Merge pull request #1155: game 1.1.0 gets the climbing speed and gear rotation fixes above 60 fps, and the patch tools write their files as UTF-8 (shenjackyuanjie, #35, #276, #1001, #330, #984)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 21:08:26 +03:00
Valiantsin DzerakhandClaude Opus 5.5 aec59b033b The 1.1.0 patch doc lists climb and gears with the other sets and describes their sites, register contract and tests in one short section
The section the pull request added named the set count wrong (RT_PATCH_COUNT 12 to 14; the table goes from 14 to 16
sets), quoted branch hashes as baselines, and carried the author's audit history and WSL toolchain notes, which do
not describe the current state.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 21:07:35 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a7f24442b6 The cheat, ExeFS patch and plugin tools read and write their patch files as UTF-8, the encoding recomp/patches.py load now reads them in
Without Python's UTF-8 mode these tools used the locale code page, so a plugin image path with non-ASCII characters
(tools/exefs_plugins.py plugin_lines) would reach the generator in a code page it no longer reads.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 21:07:01 +03:00
Valiantsin DzerakhandClaude Opus 5.5 e90732bca1 Merge pull request #1219: contact shadows darken only the pixels the game's lighting puts in the sun, so caves and shade keep their light (itaskaev2, carries #439 by Specht2010)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 21:04:48 +03:00
Valiantsin DzerakhandClaude Opus 5.5 43bd965e69 A chunked replay's contact shadow march takes the lighting target's image at the time it records, as it does the scene colour and the linear depth, not the entry the scan saw
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 21:00:43 +03:00
Valiantsin Dzerakh f780b3d216 Merge pull request #1155 into task/pr1155 2026-11-19 21:00:35 +03:00
Valiantsin DzerakhandClaude Opus 5.5 06ebf18f5d Merge pull request #1301: the mouse turns Autobuild's placement camera and other cameras without a direct hook as the right stick (itaskaev2, #1300)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 20:53:20 +03:00
Valiantsin DzerakhandClaude Opus 5.5 91aa744907 TOTK_TEST_PAD_RUMBLE_MS is read with cfg_get like TOTK_TEST_PAD, so a test gamepad without it no longer stops the game at start: cfg_int stops on a name with no row in the settings table (#329)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 20:53:19 +03:00
Valiantsin DzerakhandClaude Opus 5.5 939eeed175 The mouse shake's right-stick side is cleared when the camera input leaves the direct path, so a camera without a direct hook never keeps the stick at full tilt (#1300)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 20:52:25 +03:00
Valiantsin Dzerakh d87d43a4eb Merge commit 'refs/pull/1219/head' of https://github.com/valentderah/totk-pc-recomp into task/pr1219 2026-11-19 20:38:08 +03:00
Valiantsin Dzerakh 5278e137ff Merge commit 'refs/pull/1301/head' of https://github.com/valentderah/totk-pc-recomp into task/pr1301 2026-11-19 20:37:54 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0c5ef2d355 Merge pull request #1288: the audio_drain_fix texts say when the game's guard fires, evenly paced audio frames, not any run above 200 fps (shinodanpen, #337)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 20:36:16 +03:00
itaskaev2andClaude Opus 5.5 300f88e95f The mouse turns cameras that run no direct mouse hook, such as Autobuild's placement camera, as the right stick (#1300)
With mouse_mode = direct the mouse reached only the cameras the direct hooks cover. Autobuild's placement camera runs
none of them on games 1.4.3 and 1.2.1 and turns by the right stick, so the mouse moved nothing there. mouse_direct.c
now notes each camera step that runs a hook; after two steps without one the mouse acts as the right stick
(input.c mouse_camera), as with mouse_mode = stick, until a hook runs again. A script's MOUSE lines move that stick
too, also under TOTK_INPUT=none, so the path can be tested with scripted input.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 17:54:58 +01:00
itaskaev2andClaude Opus 5.5 715070e267 The DLSS scaling draw is found again after translator patch 0017 (#1291)
Patch 0017 adds two support buffer fields, which every translated shader declares, so the SPIR-V hash of the game's FXAA shader changed (0x5c43ae18948d52cb to 0xde20aef90fea4ce6, with zero_locals 0xaad42238801d31d8 to 0x755964e8dce7f34d). vk_dlaa_skip_draw then no longer skipped the scaling draw DLSS replaces, and on 1.4.3 that draw, sampling DLSS's output-sized picture in place of the scene, stretched the picture's top left over the whole screen in every DLSS mode but dlaa. FXAA_FS gets the two new hashes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 13:42:45 +01:00
itaskaev2andClaude Opus 5.5 4edf63a6dd Soft shadows keep their width on the ground across the sun cascades
The pcss radii and penumbra factor were in UV of whichever cascade map a pixel read, the same in every cascade. Each cascade's map spans 3.5 to 5 times the ground of the one before (measured on 1.4.3: the cascades end at about 4, 27, 120 and 450 m), so a soft shadow turned that much softer at every cascade step, a step that moves with the camera (issue #1291).

The runtime now measures each cascade from the camera block the lighting shaders read (c4 rows 42 to 57, a projective matrix per cascade, and row 58, the cascade ends): the UV and depth per metre where the cascade begins and ends. It passes two factors per cascade in two new support buffer fields, pcss_depth and pcss_scale, and translator patch 0017 applies them in the PCSS lookup. The values keep their meaning in the second cascade, which holds most shadows on screen, so the look at a given pcss value stays where most players see it. The narrowest radius stays in texels. The HDR field moves from byte 1440 to 1472. With pcss = 0 nothing changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 11:41:00 +01:00
Valiantsin DzerakhandClaude Opus 5.5 db7d6603a6 Merge task/cmdmem: command memory grows by nothing on CallCommands and by the hardware size on CopyCommands, as on the console, and a call takes control memory; the game sizes renderer memory from these numbers (MacNativeGames 6909dbb7)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 09:16:24 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d547d27939 Merge dev into task/cmdmem
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 09:14:48 +03:00
Valiantsin DzerakhandClaude Opus 5.5 7795c0a5a9 nvnCommandBufferCallCommands adds 24 bytes of control memory per called handle, so a buffer that only called recordings no longer reads as empty
A call adds no command memory since the previous commit. Control memory grew only at EndRecording, so a buffer queried
after calls and before its first EndRecording reported 0 command and 0 control bytes, which the game treats as an empty
buffer. The game's inline copy of the driver's call (1.4.3 main+0x2d33a4) writes one 24-byte control entry per segment
of the called handle; each called handle now adds that much. The NVN probe checks that a call-only buffer reports 0
command and some control memory.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 09:14:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 054390ef1d nvnCommandBufferGetCommandMemoryUsed no longer grows on CallCommands and grows by the copied recording's hardware size on CopyCommands
The real driver puts a call in control memory, so a call adds no command memory; a copy adds what the copied commands
take on hardware. We added our record bytes of the inlined recording for both. On 1.4.3 the game queries recordings
that hold calls every frame (field save, 20 s: 15,700 such queries from six call sites, up to 14,604 bytes reported
where the driver rule gives 3,204); copies were not seen. Each recording now keeps its hardware size from EndRecording
(copy_prefix.hw), and memory added while recording keeps that size whole. Same accounting as MacNativeGames 6909dbb7,
which measured 40 bytes on the original driver where their port reported 88 and traced a renderer heap crash near
Zora's Domain to the larger sizes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 09:02:22 +03:00
Valiantsin DzerakhandClaude Opus 5.5 629ca89b16 Merge task/rumble: rumble writes go to a worker thread, so a controller whose rumble write blocks no longer holds up the game thread that sends vibration or the input lock (#329)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 08:40:08 +03:00
Valiantsin DzerakhandClaude Opus 5.5 693019c440 Rumble writes go to a worker thread, so a slow Bluetooth HID write no longer blocks the thread that sends vibration or the input lock
input_rumble used to call SDL_RumbleGamepad under the input lock; on a Bluetooth pad the write can take tens of milliseconds and stalled SendVibrationValue and every other user of the lock. It now stores the newest request and wakes a rumble worker, which sends only the latest one. The worker takes its own handle on the open pad (SDL_OpenGamepad of its id) under the lock and writes without it, so closing the pad meanwhile cannot free it under the write. A pad going away drops the pending request, and exit sends a zero request. TOTK_TEST_PAD_RUMBLE_MS makes the test gamepad rumble with a slow write. Idea from Savage Wind Recomp commit a8ad674 (issue #730).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 08:38:50 +03:00
lebomisandClaude Opus 5.5 9ab4192bcc The free camera key is set on the Controls tab by pressing it, as quick save's keys are
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 14:28:13 +11:00
lebomisandClaude Opus 5.5 5fdacca237 The free camera steps through move, lock and off: locked, the view stays and Link walks where the left stick points on screen
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 14:28:13 +11:00
lebomisandClaude Opus 5.5 58930c152c The free camera combo counts the gamepad and an input script, not the keys bound to its buttons.
The previous commit read the combo from the merged buttons, where a key bound to ZL is the same bit as the left
trigger: with freecam_pad = zl+zr, the right mouse button and F switched the free camera in play. The keyboard has
freecam_key for that, so the gamepad combo now counts the gamepad and the input script, which stands in for one.

runtime/input.c poll_merged: script_apply writes its buttons into script_seen, which is then merged into the buttons as
before. freecam_gate counts a position of the combo when pad_seen has it or script_seen has the Switch buttons it stands
for; Home stays gamepad only. docs/controls.md ("Free camera") says so.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 13:32:23 +11:00
lebomisandClaude Opus 5.5 8dfc3609c4 The free camera combo also switches from the keys bound to its buttons and from an input script.
freecam_gate read the combo from the physical gamepad only, so a tester's input script that pressed ZL+ZR+L3
sent it to the game instead (#1213). Each position of the combo now also counts when the Switch buttons it stands
for are down in the merged buttons, as the Minus+Plus menu combo already does; Home has no Switch button and stays
gamepad only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 13:32:23 +11:00
lebomisandClaude Opus 5.5 88f9a965af Change freecam default binds for keyboard and controller to none, configurable through totk.ini or the Controls tab.
freecam_key and freecam_pad were F6 and ZL+ZR+L3 for everyone, potentially causing unwanted toggles. F6 is also the
quick save key of #1188. Both are none now.

runtime/cfg.c: the FREECAM_PAD and FREECAM_KEY rows of the settings table default to none. runtime/input.c
freecam_pad_mask reads the combo with cfg_value instead of falling back to its own zl+zr+lstick, so an unset combo is
the table's none like the key. The comments in runtime/freecam.c, runtime/input.c and runtime/ui/menu.cpp
rows_freecam, docs/controls.md ("Free camera") and totk.ini.example say so and keep F6 and ZL+ZR+L3 as examples.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 13:32:23 +11:00
lebomisandClaude Opus 5.5 5fa6db3c70 The free camera works on the keyboard and mouse: freecam_key switches it, the bound keys fly it and the mouse turns it
input.c freecam_gate also switches the free camera on a press of TOTK_FREECAM_KEY (f6 by default, none for no key).
While it is on, ZL, ZR, L and R come from the merged Switch buttons, so the keys bound to them (Z, X, Q and R by
default) go down, up and change the speed like the gamepad's; the keys' sticks already flew and turned it. The mouse's
counts are taken in the poll and turn it at the game camera's rate (0.08 degrees a count times mouse_sens, through
freecam_mouse), and input_direct_mouse_sample gives the game's mouse camera none meanwhile; in the stick emulation mode
the mouse arrives in the right stick as before. The Controls tab gets a Free camera key row (off, F2 to F7, F9), with
text in all four menu languages; docs/controls.md lists the keyboard column.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 13:32:23 +11:00
lebomisandClaude Opus 5.5 34b6b380ac The Controls tab picks the free camera combo
A row under the walk rows offers the trigger pair or the shoulder pair with either stick click, or off, named as the
open pad labels its buttons (binds_page.cpp binds_pad_label, the Controls tab's labels). TOTK_FREECAM_PAD gets a live
row in the cfg table with its default zl+zr+lstick; totk.ini still takes any combo of button positions, shown as
written. On other game versions than 1.4.3 the row is off and says so. Text in all four menu languages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 13:32:23 +11:00
lebomisandClaude Opus 5.5 29eec07245 ZL+ZR+L3 detaches the view from Link on 1.4.3 and flies it with the gamepad (freecam_pad)
The camera component update (main+0x628460) copies each component's eye, target and up into its sead camera. The site
freecam (main+0x6286d4, the load every path to that copy runs first) calls runtime/freecam.c freecam_hook, which
writes the component's one-shot eye and target overrides (+0x180, +0x198) while the free camera is on; the update
takes them in place of the pose and clears them, so the game camera's own state is never changed and resumes the
frame the free camera ends. The up vector is levelled through the component's up offset (+0x200), which is kept and
put back. Of the three components a frame updates, the hook drives the two that share the player camera's eye, leaves
the one at the default pose and picks again after a load; with the free camera off it does only the displaced load.

input.c freecam_gate latches TOTK_FREECAM_PAD (zl+zr+lstick when unset, none for no combo) like Minus+Plus and, while
the free camera is on, gives it the sticks, the trigger axes and L and R presses and the game nothing. The left stick
flies along the view and sideways, the triggers straight up and down, the right stick turns, each L or R press halves
or doubles the speed (0.25 to 512 m/s, 8 at the start); the flight follows the wall clock. TOTK_FREECAM_PATCH=0
removes the hook.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 13:32:22 +11:00
lebomisandClaude Opus 5.5 94c33b1d85 The gamepad poll keeps its buttons by position, the Home button and the trigger axes, and input_pad_combo reads a combo setting
pad_read stores what pad_physical saw (pad_seen, by PAD_* position, with the Home / Guide button after the Switch
buttons as PAD_GUIDE) and the two trigger axes (trigger_seen), under the input lock, for gamepad combos that are no
Switch buttons and for analog trigger readers. input_pad_combo parses a setting of button positions joined with +
(the bind_ lines' pad: names plus guide or home) into a mask, logging a name that is no button. input_map.c exports
input_key_id and input_pad_id, and ui/binds_page.cpp binds_pad_label gives the label the open pad has on a button,
so menu rows can name buttons as the Controls tab does. No behaviour changes on its own.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 13:32:22 +11:00
shinodanpenandClaude c4928ff77f Scale the Tenbez Shrine launchers' speed by the frame on 1.4.3 so the ball lands above 30 fps (#1215)
The two launchers of Tenbez Shrine (DgnObj_BoxShutter_4x4x4, AI ShutterFence) throw the stone ball less far the
shorter the frame is: at 60 fps and above it lands on the rim of the receiving launcher and is juggled there or
knocked into the pit. The shrine's map raises their speed by 1 % for what looks like Nintendo's 60 fps Switch 2
build (SpeedForOunce and shouldUseOunceSpeed), which the Switch build of QueryBlackboardGetF32FromActorForOunce
ignores. The new set shutter (TOTK_HIGHFPS_FIX) multiplies the value that node returns by 1 + 0.065 * (1 - ratio)^2
when its shouldUseOunceKey input is true: the factor that keeps the flight of 30 fps at 45 to 144 fps, and 1 at a
ratio of 1 or more.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-11-19 00:23:33 +00:00
shinodanpenandClaude bb6523a080 The audio_drain_fix texts say when the game's guard fires: evenly paced audio frames, not any run above 200 fps (#337)
The texts that came with the audiodrain set (docs/settings.md, totk.ini.example, the comments in patches-v121.txt and
patches-v143.txt) said that above about 200 game updates a second the game switches its sound off. Every run behind
them had captured the mix with audio = none. With a device playing, on Linux with PipeWire, the game keeps its sound at
240 fps without the set.

The guard (1.2.1 main+0x9bcdc4) sets its count back to 0 whenever a free list is there (0x9bce00), which takes two
audio frames between two updates of the game. The mixer's timer renders one frame every 5 ms, so at 240 updates a
second that never happens and the count reaches 300. A device paces the render thread in bursts after each period
(audren.c, gap_ns: 4 ms apart on Linux; 0 on Windows, read from the code and not measured), so it happens several times
a second. Sampled on the render thread on Linux with PipeWire's 1024-frame periods: 200 frames a second either way, 76%
of them 4 ms after the one before with the device, 939 of 940 at 5 ms with the timer. The count and the switch have
not been read in a run.

The mixer also keeps time by its timer while a device takes nothing. Measured at fps_limit 240, same save and input
script, with the game's audio stream paused from outside (pw-cli on its PipeWire node, not a real device stalling)
while the game ran at 240 fps. On 1.2.1 with the set off a pause of 5 s (two runs) and of 2 s (two runs) left the game
silent to the end of the run, also after the device resumed, and a pause of 1 s (one run) did not; with the set on a
pause of 5 s (two runs) left only the gap. On 1.4.3, one run each: silent after a pause of 5 s and of 2 s with the set
off, sound after a pause of 5 s with it on, sound with a device and no pause with the set off.

The numbers without a device now come from runs that can be named: 1.2.1 6 of 119 and 111 of 119, 1.4.3 3 of 119 and
113 of 120 (set off and on). They replace 5 of 118 / 108 of 118 and 2 of 118 / 110 of 119, which I cannot match to a
run any more.

Text only: no code, no site and no default changes. Not measured: Windows, a device with periods of 240 frames or
less, a real device stalling, 1.4.3 with a device and the set on.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-11-18 18:18:43 +00:00
Valiantsin DzerakhandClaude Opus 5.5 ebce67b367 Merge task/psp: PlayStation button prompts from #741 (fabiomode2), and the game makes a missing layout or prompts folder itself after a resolution or prompts change (#180, #378)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 19:14:27 +03:00
Valiantsin Dzerakh 6c48e7a364 Merge dev into task/psp 2026-11-18 19:12:50 +03:00
Valiantsin DzerakhandClaude Opus 5.5 74c1cde876 The Controls tab names a PlayStation pad's shoulder, stick and menu buttons L1, R1, L2, R2, L3, R3, Options and Share (#180)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 19:12:42 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4c4f3b150f Merge pull request #1275: with sync_ahead the game waits for a GPU result it reads once and takes depth queries one frame older, so Link no longer gets gloom on clean ground and shrine reflections no longer go out (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:59:15 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a9abffdba6 tests/sync_ahead_check.py checks that a refused sync_ahead switches the qstamp set off on 1.4.3
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:57:50 +03:00
Valiantsin DzerakhandClaude Opus 5.5 234a10f413 With sync_ahead an exit line gives the run total of the waits at a pool invalidate, as the shadow log lines stop at frame 1800 without TOTK_TRACE=perf
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:55:13 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bc579c62e8 The qstamp patch set is switched off when sync_ahead is refused, so TOTK_SYNC_AHEAD=1 without shadow storage leaves the game's depth query check as it was
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:55:12 +03:00
Valiantsin DzerakhandClaude Opus 5.5 ee6d5a6183 Merge dev into task/pr1275
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:54:52 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b9f104ef6b Merge pull request #1276: dlss_fixed_exposure creates DLSS without auto exposure, so distant fogged blocks in the Depths no longer change brightness for a frame (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:47:52 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4a59088f04 Without an output_res the game makes the missing folders for the display's shape, so a prompts change on a wide display brings that shape back at the next start (#180)
The default output_res keeps the display's shape only while that shape has the
prompts' folder (cfg.c shape_keeps_prompts). After a switch to PlayStation
prompts on a 21:9 display the default was 1920x1080, so the start and the menu
asked only for the 16:9 folder and the game stayed 16:9. cfg_screen_size gives
the display's size while the player set no output_res.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:46:52 +03:00
Valiantsin Dzerakh 792d5398ab Merge branch 'pr1276-head' into task/pr1276
# Conflicts:
#	docs/agents/symptoms.md
#	runtime/cfg.c
2026-11-18 18:46:16 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6f03ccd30d The build and controls docs show the romfs-patches folder paths again, which held a carriage return in place of the backslash before romfs
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:44:22 +03:00
Valiantsin DzerakhandClaude Opus 5.5 00b04df8b2 The game makes a missing layout or prompts folder in the background, at start and when a setting asks for it (#180, #378)
When the game resolution, the HUD width, the button prompts or the pad layout need a folder the install lacks (an
older setup, a failed setup step, a new display), totk.exe starts the setup's generator for it in the background
with the tools build-cache/rebuild.txt names, once per folder and process: at start for the settings in effect
(the resolution output_res asks for, also when the missing layout made this start 16:9), and from the settings
menu once a changed choice has stayed for 1.5 seconds or the menu closes. A missing 16:9 prompts folder is made too,
the PC prompts from totk.ini's bindings. The notes under Game resolution and Button prompts say the files are being
made and are used at the next start; when the tools did not start they say so and Try again starts them again.
The Prepare button is gone. Source builds without rebuild.txt and TOTK_ROMFS_PATCHES keep the old behaviour.

romfs_shape_missing and romfs_shape_prepare become romfs_folders_missing (a mask of the missing folders) and
romfs_folders_prepare; --probe-cfg and tests/romfs_shapes_check.py check the new decisions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:34:50 +03:00
Valiantsin DzerakhandClaude Opus 5.5 77dce74028 The RomFS patch generator renames a finished folder into place, so a folder is never half written (#180, #378)
tools/make_romfs_patches.py writes into <out>.part-<pid> and renames it to <out> once every file and the manifest
are there. With --background (for runs the game starts) it runs at below-normal priority, does nothing when <out>
already has a manifest, and drops its own result when another run finished <out> first, so two runs for one folder
do not mix their files and a folder a running game loaded is never written into. Without the flag <out> is replaced
whole, as the setup and source builds expect. A .part folder left by a stopped run goes once it is an hour old: the
next run for that folder or the setup's clean-up removes it. build_game.py copy_romfs_patches skips .part folders.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:34:41 +03:00
Valiantsin DzerakhandClaude Opus 5.5 65e6dc50d3 Merge pull request #1284: on 1.4.3 DLAA's jitter goes into the game's camera instead of the viewport, so water seen at a low angle stops flickering (ipavlin98, #1126)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:34:05 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c145f2bd5d The camera jitter checks where each copy puts its matrix in the block: f_70000e31d4 takes the offsets from the shader's layout (x8), so only a projection at 0x70 and a view-projection at 0x30 take the offset, a projection whose view-projection lies elsewhere gets its centre terms back, and a block counts as given only once both matrices carry it (#1126)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:29:28 +03:00
Valiantsin DzerakhandClaude Opus 5.5 902d91a94e Merge pull request #1275 head into task/pr1275
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:27:57 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0ae38dd34a Merge pull request #1278: a VRAM mirror copies from the shadow only after the shadow sync, so loads with sync_ahead and replay_workers no longer leave stretched slabs (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:26:25 +03:00
Valiantsin Dzerakh c1449b2a9b Merge commit 'refs/pull/1284/head' of https://github.com/valentderah/totk-pc-recomp into task/pr1284
# Conflicts:
#	docs/agents/symptoms.md
2026-11-18 18:22:56 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6ed99acddb Merge pull request #1283: water volume mask draws get a depth bias toward the viewer, so puddles stop flickering (ipavlin98, #1126)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:20:25 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0350d91b72 The water volume mask bias is decided once per state change and only for LEQUAL and GEQUAL draws (#1126)
prepare_draw sets ex->volume_bias where the draw's dynamic state changes, so record_fixed reads a flag instead of
checking the pipeline state on every draw. A census of the matching draws in the field, the town and rain found two more
states with the same blend and depth signature, both tested GREATER: the volume's back faces into the same channel and
another shader's front faces into red. GREATER's equal case fails, and the bias toward passing turned the game's tie
the other way for them; they are now left as the game sets them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:18:22 +03:00
fabiomode2andClaude Opus 5.5 bae687a10d Add PlayStation button prompts (#180)
prompts = playstation shows the face buttons as circle, cross, triangle and square, L1 R1 L2 R2, Options and Share.
The setup writes romfs-patches-playstation (pad_layout = nintendo) and romfs-patches-playstation-xbox (xbox, auto) on
every install, next to the Xbox folders, and the Shapes step and the settings menu make their shaped folders like the
other styles. playstation-xbox lays the action prompt's diamond out as xbox-label does, cross at the bottom.

Rebased onto dev from pull request #741 by fabiomode2: the shaped folders, hud_width, the Xbox diamond and the
keyboard prompts' text glyphs of dev are kept, and cfg.c's shape default uses input_prompts_folder.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:10:32 +03:00
Valiantsin DzerakhandClaude Opus 5.5 593eeeb8ed The lock order comments name the new edge: mirror_sync and mirror_create take shadow_lock under mirror_lock
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:08:44 +03:00
Valiantsin DzerakhandClaude Opus 5.5 402d1fe8b0 Merge pull request #1278 head into task/pr1278
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:07:48 +03:00
Valiantsin Dzerakh a111ca77b3 Merge commit 'refs/pull/1283/head' of https://github.com/valentderah/totk-pc-recomp into task/pr1283 2026-11-18 18:06:22 +03:00
Valiantsin DzerakhandClaude Opus 5.5 13ff0d7b52 Merge task/verfix: the setup recompiles when the release changes, so the menu shows the installed version (#1078)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 13:33:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d26b12b70c Merge task/bgpad: gamepad input keeps working while the game window has no focus on Linux (#971)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 13:33:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 cedc0a63ad The setup's compile step runs again when the release string changes, so totk.exe carries the version of the release that built it (#1078)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 13:32:47 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a6ad6af274 Gamepad input keeps working while the game window has no focus: SDL's background joystick events hint is set before SDL starts (#971)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 13:30:52 +03:00
ipavlin98 85888bc9ba Symptoms: the world behind the inventory streaked with DLAA, from the camera jitter's read-back taking the inventory camera's off-centre projection for a jitter 2026-11-18 10:50:58 +03:00
ipavlin98 04146289ac The camera jitter's read-back takes a block's centre terms as an offset only when this code gave that block that offset: the inventory's camera has an off-centre projection of its own, which read as a jitter of 1152 pixels, so DLSS smeared the world behind the inventory into horizontal streaks 2026-11-18 10:42:23 +03:00
Valiantsin DzerakhandClaude Opus 5.5 44450a15a0 Merge task/gyro: the gyro drift learning switch on the Controls tab (#292, #1267)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 09:17:28 +03:00
Valiantsin DzerakhandClaude Opus 5.5 18482e0af0 Gyro drift learning at rest gets its switch on the Controls tab, below the gyro calibration row
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 09:17:28 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c3ec7fce0e Merge task/gyro: gyro through Steam Input, levelled from the first reading, optional drift learning at rest (#1282, #292, #1267)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 09:12:06 +03:00
Valiantsin DzerakhandClaude Opus 5.5 9f2a9d3e59 Gyro drift learning at rest is off by default: subtracting a learned bias made aiming feel worse in play before, so it stays a switch for players with a drifting controller
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 09:12:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 96a809044d Steam Input motion: buttons move to Steam's virtual gamepad once it is up, a controller Steam hid keeps its own bias as the pad, and a sensor SDL could not turn on is logged with SDL's error (#1282)
1. scan_pads took a controller Steam hid when the virtual pad was not up yet and kept it for the session, so Steam's
   remapping was lost. While the open pad is a hidden one, pad_physical looks again every RESCAN_MS and scan_pads
   moves the buttons to the virtual pad; the hidden controller stays open as motion_extra, so motion goes on with
   the same bias and orientation.
2. pad_identity marked " (under Steam)" only on motion_extra; a hidden controller that became the pad lost the mark
   and could take the bias calibrated with Steam closed. The mark now follows steam_hidden_id.
3. After pull request #1024: sensors_ready logs SDL_GetError when the pad has both sensors but enabling them failed,
   instead of "has no gyro and accelerometer".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 09:08:52 +03:00
2dbdcf9a37 Read the gyro from the controller behind Steam Input's virtual gamepad when the game is started from Steam, from the patch in issue #1282
A game Steam starts gets SDL_GAMECONTROLLER_IGNORE_DEVICES with the controllers Steam reads itself and sees Steam's
virtual gamepad, which has no motion sensors. input.c steam_reveal keeps that list and clears the hint before
SDL_Init (only with motion on); scan_pads still takes the virtual pad for buttons and sticks, so Steam's remapping
holds, and motion_source opens the hidden controller for its gyro and accelerometer only. A bias belongs to the pad
as Steam presents it: " (Steam Input)" or " (under Steam)" in gyro_bias_pad. docs/controls.md, "Steam Input and
motion", says the Steam layout must bind the gyro to something or Steam zeroes it on the Steam Controller.

The patch as posted against 6151ac4, with sensors_ready merged with #1274's restart. Tested by the author on Linux
(Steam Controller) and the Steam Deck; not on Windows.

Co-authored-by: St5sz2Jk <St5sz2Jk@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 09:08:13 +03:00
45a0cd1f6c Learn the gyro drift left after calibration while the controller lies still and subtract it, so the aim stops sliding on a table, from pull request #380 (#292, #1267)
The calibration removes the bias measured once; a bias that moves as the controller warms up, or a controller never
calibrated, still turns the aim slowly. motion_fusion.c drift_track learns it from 256 ms windows in which the gyro
stays within 0.04 rad/s and the acceleration within 0.03 G peak to peak, after half a second of rest, with a time
constant of 0.25 s until the estimate settles and 30 s after. The estimate sits on top of the calibrated bias and is
cleared with a new controller, a new or loaded calibration and a change of gyro_calibration. New setting
gyro_auto_bias (live, default 1).

Taken from #380: the rest window by peak to peak, the two time constants, the per-axis limit. Left out: the
0.006 rad/s dead zone, which ate slow aiming; the one global state shared by every fusion instance; the reset at
every StartSixAxisSensor; the 0.5 G acceleration gate, which let a controller in motion count as still. The first
estimate is limited to 0.1 rad/s from zero instead of 0.15; a larger bias is the calibration's job.

Also: a sample without a reading at a restart (#1274) no longer returns before the calibration's log and save.

--probe-services checks the drift with the switch off and on, after a calibration whose bias then moved, a slow
aim in the hand, and the levelling of #1274 with a bias on every axis.

Co-authored-by: airquark <97342227+airquark@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 09:06:30 +03:00
ipavlin98 d5d62ab406 The camera jitter is described as dlaa_cam_jitter, and the game's matrix copies skip it at once while DLSS is not running 2026-11-18 09:01:16 +03:00
ipavlin98 77cb787de7 The water volume mask's depth bias can be turned off with volume_mask_bias = 0 (or TOTK_VOLUME_MASK_BIAS), a test setting to compare against 2026-11-18 09:01:00 +03:00
ipavlin98 706144d673 Use the zero rate vector for the zero reading in the fusion start probe 2026-11-18 09:00:12 +03:00
ipavlin98 b155be1881 Level the six-axis orientation from the first real accelerometer reading and pull it toward gravity at 4/s while the controller is held still, so a bow aimed right after the game starts or after a load no longer turns sideways when the controller is tilted up or down 2026-11-18 09:00:12 +03:00
ipavlin98 0eab458030 Symptoms: water at a low angle flickering with DLAA from the viewport jitter the game's camera did not share; cfg knows DLAA_CAM_JITTER 2026-11-18 08:50:22 +03:00
ipavlin98 b5936a6aa9 The camera jitter moves on with the game's presents instead of at a camera block written again: the game fills two sets of blocks in turn, so each phase went to two frames, and each view-projection takes the offset its own block's projection took 2026-11-18 08:36:50 +03:00
ipavlin98 121b4fdf33 On 1.4.3 DLAA's jitter goes into the game's camera instead of the viewport: the projection's centre terms and the view-projection of each perspective camera with the scene's aspect take the offset where the game copies them into their uniform blocks, so the game's full-screen passes rebuild positions with the camera the scene was drawn with, and screen-space reflections on water seen at a low angle no longer flip between hit and miss with the jitter's phase 2026-11-18 08:13:26 +03:00
ipavlin98 cc84958cee Give TotK's water volume mask draws a depth bias toward the viewer, so a puddle's surface, on which the volume's top face lies, counts as inside the volume in every frame instead of by rounding and the camera's sub-millimetre motion, which turned the puddle's reflection on and off in patches from frame to frame, more with DLAA 2026-11-18 05:41:05 +03:00
ipavlin98 07f9760971 Symptoms: stretched slabs over the ground in the Depths from a VRAM mirror copied from the shadow too early 2026-11-18 02:23:21 +03:00
ipavlin98 0f2cc1071a A mirror's copies from the shadow wait for the shadow sync: the prologue seals the mirror queues before it syncs the shadow and copies only those, and a mirror sync touches its shadow pool, so with replay_workers and shadow_defer a recording thread no longer queues a copy that reads the shadow before the CPU's write reached it, which left terrain in the Depths as stretched slabs over the ground for the rest of the session 2026-11-18 02:03:53 +03:00
ipavlin98 efb896235a DLSS without auto exposure is a setting, dlss_fixed_exposure, next to the other DLSS settings, off by default: 0 creates DLSS with AutoExposure as before, 1 without it, and a change recreates the features at once 2026-11-18 00:58:32 +03:00
ipavlin98 ae5fff3d46 With sync_ahead the game takes its depth query results when their frame number is one frame older than it expects, so in shrines the reflections of the lamps on the floor no longer go out on the frames where the GPU runs behind, which flickered at some camera angles 2026-11-18 00:57:06 +03:00
ipavlin98 68078948f5 With sync_ahead an invalidate of pool storage waits for the GPU write of a value the game was told is done when the range holds no older result, so the pixels TotK reads back once through a buffer per request are no longer zeros or an answer from the ring's last round, which in the Depths put Link in gloom on clean ground; buffers the game reads every frame still get the result of the frame before without a wait 2026-11-18 00:21:46 +03:00
ipavlin98 fd08b5cee3 DLSS is created without auto exposure, so large distant blocks behind the fog in the Depths no longer turn darker or lighter for a frame while the camera moves 2026-11-18 00:21:25 +03:00
shenjack 90bf2f25aa Test and document the 1.1.0 climbing and gear patch contracts
Add native and Unicorn numeric comparisons, switch gating, register and stack preservation checks, and optional local ExeFS anchor validation. Document supported sites and acceptance boundaries.
2026-11-18 01:39:06 +08:00
shenjack b870a9f860 Add high-frame-rate climbing and gear rotation fixes for 1.1.0
Port the climbing compensation and frame-delta-scaled gear checks to verified 1.1.0 sites, preserving full-width scratch registers and local stack state. Read patch tables explicitly as UTF-8.
2026-11-18 01:33:09 +08:00
Valiantsin DzerakhandClaude Opus 5.5 6b0974f08d Merge pull request #1188: opt-in quick save and quick load on rebindable keys with no menu on the screen, game 1.4.3 (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:17:57 +03:00
Valiantsin DzerakhandClaude Opus 5.5 52d913c7e0 Quick save takes its request back with an atomic and, and the no-quick-save note names the key by its role, as it can be rebound (#1188)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:17:57 +03:00
Valiantsin DzerakhandClaude Opus 5.5 358b7916d8 Merge task/hud: hud_width keeps the HUD within the middle 21:9 or 16:9 of a wide screen, from pull request #1262 (Marjaperse, ProSep, #643)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:15:16 +03:00
Valiantsin DzerakhandClaude Opus 5.5 7e2712e87e Quick save logs once that it is 1.4.3 only on other game versions, and a quick load under way goes on while the settings menu opens, so the held picture always ends (#1188)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:15:04 +03:00
Valiantsin DzerakhandClaude Opus 5.5 96afa531c9 Merge pull request #1131: with frame-ahead on, fence write-backs no longer wait for the GPU about every ninth frame (ProSep)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:13:01 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6efa75f3dd romfs_shapes_check.py links its harness with lld, which MSYS2 UCRT64 Clang needs for LTO objects
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:12:56 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c781238d6d The Shapes step keeps its old key when it writes no capped HUD folder, so an install with hud_width full does not prepare its shaped folders again (#643)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:12:56 +03:00
Valiantsin DzerakhandClaude Opus 5.5 64e965078c wb_eager moves to the diagnostics settings and out of totk.ini.example, as part of sync_ahead
It acts only with sync_ahead in effect and is on by default there, so a player who turns on sync_ahead gets it; 0 and check stay for comparing. docs/settings.md keeps the row.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:12:19 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8232ac4505 The exit log counts the fence write-backs that waited for the GPU and their time with frame-ahead on
The new line is written for wb_eager 0, 1 and check alike, so the stall wb_eager removes can be compared between the settings. It costs a clock read only on the blocking path.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:12:18 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f801169e1c Merge pull request #1188: opt-in quick save and quick load with no menu on the screen (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:07:20 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1974b671be Merge pull request #1263: with DLAA, fog and particles can be drawn over the smoothed picture, so dust in shrine fog no longer vanishes; off by default until checked on NVIDIA (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:07:08 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a702c33f91 dlaa_effects_after is off by default until the inventory preview, the scope and water edges are checked on NVIDIA
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:06:49 +03:00
Valiantsin Dzerakh 006c186928 Merge pull request #1262 into task/hud: hud_width keeps the HUD narrower than a wide screen on the Shapes step (Marjaperse, ProSep) 2026-11-17 20:06:17 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c76a38852e The DLAA effects switch sits with the other DLSS settings and is read only while DLSS runs
dlaa_effects_after moves to the Screen tab under the DLSS rows, to [display] in totk.ini and totk.ini.example next
to dlss_char_mask, and vk_dlaa_frame reads it after the dl_active check, so a game without DLSS does no new work
per frame.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:05:44 +03:00
ProSepandClaude Sonnet 5.5 3b2bd1f6ba Stop fence write-backs from stalling the game behind the GPU with frame-ahead on
With sync_ahead on, the fence write-back of small GPU-drawn targets that the game reads back still blocked the game thread behind the running frame, about every ninth frame. wb_eager copies those targets into staging at the end of the submission that rendered them, so the write-back at the fence wait needs no GPU wait.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-17 20:05:15 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a36e7917da Merge task/cascade: shadow_range moves the sun cascades on 1.2.1 and 1.4.3, from pull requests #1258 and #1254 (shinodanpen, #606)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:03:05 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f53b86c61d Merge pull request #1253: sync_ahead works on game 1.1.0, and game-time scripts find the player there (Marjaperse)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:01:26 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1ccefb46f2 Merge pull request #1252: the dynamic resolution switch holds the full scene size on game 1.1.0 (Marjaperse)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:01:25 +03:00
Valiantsin DzerakhandClaude Opus 5.5 e031ac596a Merge dev into task/pr1263
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:59:52 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4613d9b458 res_shadow_range's comment names both cascade tables and the controller's boundaries they scale (#606)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:58:02 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1cc47c7768 Merge pull request #1255: the field-of-view setting works on game 1.2.1 (shinodanpen)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:57:54 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bd8c5d637f Merge task/objreuse: a private build compiles only the generated chunks that differ from the main build, so a private lift of a patch builds in seconds
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:38:43 +03:00
Valiantsin DzerakhandClaude Opus 5.5 2b95408642 A private build reuses each main build object whose compile is provably the same, also for a private lift in another generated dir
build_game.py used to reuse build/<ver>'s generated objects only as a whole and only for generated/<ver>, so a private
lift of a patch change (gen.py --out generated/<ver>-prN, build_game.py --gen) compiled all 421 chunks, about 5 min on
12 jobs, for one changed chunk. main_objects now decides per object: same compiler, flags and rule in the main
build.ninja (with the main runtime/ and generated dir in place of ours), main build up to date, and every file the main
compile read according to its Ninja deps log byte-identical on our side and unchanged since the object was written
(NTFS ChangeTime, st_ctime elsewhere), the compiler binaries too. A file new on our side whose name those compiles
included or probed blocks the reuse. Anything unknown compiles. The build prints "reused N of M generated objects",
--verbose lists the rest with the reason; obj/reused.txt lets a later build delete a copied object before compiling it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:37:43 +03:00
shinodanpenandClaude 13819ab6d8 Add the field-of-view setting for 1.2.1
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>
2026-11-17 19:29:43 +03:00
Valiantsin Dzerakh 5b99256cd3 Merge pull request #1254: shadow_range moves the sun cascades on 1.2.1 (shinodanpen, #606) 2026-11-17 19:27:41 +03:00
Valiantsin Dzerakh 8125431676 Merge pull request #1258: shadow_range moves the sun cascades on 1.4.3 (shinodanpen, #606) 2026-11-17 19:27:40 +03:00
Valiantsin DzerakhandClaude Opus 5.5 3afebbfdae Merge pull request #1256: the audio thread takes every queued sound command list, so the sound stays on above 200 fps (shinodanpen, #337)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:26:10 +03:00
shinodanpenandClaude 037a39d303 The sound engine's audio thread takes every queued command list, so the game keeps its sound above 200 fps (#337)
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>
2026-11-17 18:56:55 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a5c3e0f9f5 A game with a mod plugin no longer stops at start: plugin_trace has its row in the settings table (#845)
plugin_init.c reads TOTK_PLUGIN_TRACE through cfg_bool, which stops the game when the key is unset and metas[] has no
row. Every test run set the key, so only a plain start hit it. tests/settings_doc_check.py now fails on any
cfg_value/cfg_int/cfg_double/cfg_bool reading without a metas[] row that is not guarded by cfg_get of the same key.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 12:49:27 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4957dc78e3 Merge task/buildkit: the setup installs a build kit into the game folder, so code mods rebuild without the setup folder and after a move (#845)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 12:04:35 +03:00
Valiantsin DzerakhandClaude Opus 5.5 e7c901b864 The setup's builds name every path relative to the build kit, so a moved game folder rebuilds incrementally (#845)
tools/build_game.py --portable writes build.ninja paths on the tools' drive relative to the kit, also through '..'
(the generated C and objects in build-cache/work), names the compiler, windres and ar the same way (backslashes:
CreateProcess does not find a relative program with forward slashes), and passes clang -resource-dir and --sysroot
relative to the kit, because clang names its own headers by its absolute folder whatever argv[0] says. The Ninja deps
log then holds no absolute path. installer/steps.py build_args passes --portable for the build kit.

Measured on an install moved after a portable build: the rebuild compiled modules.c only, 3.5 s; before, the move cost
a full compile of 430 objects (335 s on 12 cores). Without --portable build.ninja is byte-identical to before.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 11:57:12 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8c9c18a6d2 A kit whose replacement fails is put back, so the game keeps a build kit; docs rewrapped to 120 columns (#845)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 11:06:32 +03:00
Valiantsin DzerakhandClaude Opus 5.5 501f0d3e6f The setup installs a build kit into the game folder, and the game's rebuild for code mods runs from it (#845)
The rebuild for ExeFS patches, code cheats and mod plugins ran the setup window from the setup folder, whose absolute
path build-cache/rebuild.txt held, with the generated C and objects in that folder's temp/. A moved or deleted setup
folder left code mods without a rebuild.

- A new Kit step after the check copies the release folder without TotK-Setup.exe into <game>/build-kit
  (installer/layout.py KIT_ITEMS), and every later step runs its tools from there. A newer setup replaces the kit,
  the kit's own rebuild keeps it.
- The release's temp folder is <game>/build-cache/work, so the lift cache and the objects stay with the game.
- rebuild.txt names the kit relative to the game folder; runtime/cheats.c and runtime/romfs.c resolve relative
  entries against the exe's folder.
- runtime_key drops the lines of clang --version that name its folder, so a rebuild from the kit or a moved game
  folder keeps the compile and prepare steps the setup recorded.
- An update over an install of an older setup moves that setup's temp folder into build-cache/work when both are on
  one disk.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 10:54:17 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d33d8d2e2f Merge task/plugins2: each mod plugin is built or refused on its own, and the release builds plugins in on a player's install (#845)
Per-plugin service runs (a refused, crashed or hung plugin costs only itself) and four fixes the real setup path
needed: plugin_init.c compiled per install, the service run's DLLs beside its exe, module tables sized for plugins in
the runtime library, and a failed plugin stage rerun after a fixed release. Checked with a release install: The
Second Quest built in and played with 7 hooks on, and removed again.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 10:37:03 +03:00
Valiantsin DzerakhandClaude Opus 5.5 791e077c54 docs/mods.md: removing a plugin mod starts the rebuild without it (#845)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 10:36:10 +03:00
Valiantsin DzerakhandClaude Opus 5.5 aa184f9fd2 A mod plugin the build has whose file is gone starts the rebuild, which goes back to a build without it (#845)
Removing a plugin mod left its module in the layout: the loader skipped the missing file and the game ran, but the
rebuild that drops the plugin never came. The loader counts layout plugins whose file no longer exists
(ldr_plugins_gone) and rebuild_if_needed treats them like files waiting for the rebuild. A changed file was already
pending through its mod's status line. On the 1.4.3 install: The Second Quest removed, the start asked for the
rebuild, the setup lifted and compiled the no-plugin build in 30.5 s, the game reached gameplay.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 10:35:49 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c477b67a09 The runtime library's module tables hold 32 modules, not the release's MOD_COUNT: an install's plugins fit (#845)
loader.c and memory.c sized their tables by MOD_COUNT of the layout.h make_release.py built libtotkrt.a against (3:
main, subsdk0, sdk). An install whose rebuild adds a plugin has 4, and its service run stopped at once with "loader: 4
modules in the layout"; dev builds compile those files against their own layout and never saw it. RT_MAX_MODULES
(host.h) is the bound now; the loader still refuses a layout above it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 10:35:49 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c97ceb6451 A plugin stage that failed runs again once a release changes the installer: steps.py is in the lift key with plugins (#845)
After warn.plugins_skipped the lift key still matched its inputs, so the next setup run (with the fixed release) found
lift and compile current and never built the plugin. installer/steps.py runs that stage, so it joins the key when the
mods hold a plugin.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 10:35:32 +03:00
Valiantsin DzerakhandClaude Opus 5.5 81c004094d The installer's plugin service run finds its DLLs: they go beside the totk.exe it builds in temp (#845)
On the release path the service run's totk.exe in <temp>/build stopped before main with 0xc0000135 (SDL3.dll not
found): the DLLs are copied next to totk.exe in the install folder only by the compile step, after the lift. Every
plugin was skipped with warn.plugins_skipped. The fake-tool tests did not see it; installer_test now checks the copy.
exefs_plugins_test covers run()'s hang and crash reasons.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 09:52:37 +03:00
ipavlin98 40c0071dd2 With DLAA, DLSS runs before the fog and the particles, which are drawn over its picture without jitter, so the dust in shrine fog no longer vanishes
DLSS ran at the bloom, after the volumetric fog composite and the particle pass. Neither has motion vectors or jitter
of its own, and DLSS wiped out the smallest motes. In DLAA mode DLSS now runs right after the deferred lighting: the
light target is the G-buffer's scene colour target, the lighting is the first pass into it after the G-buffer, with
a D16 depth, and the first pass into it with any other depth (the scene's, none, or the D16 of an ability's highlight)
is an effect. The order of the effects changes from frame to frame (the yard's half-size effects pass is in some
frames only; with Ultrahand or Ascend open the highlight comes before or after the fog layer), and rules that waited
for one of them, or took any D16 pass for the lighting, flickered. As a safety net the point is used only after it
held for 60 frames with nothing of the scene drawn after it; otherwise DLSS stays at the bloom.

dlaa_effects_after (Advanced tab, Render fixes, default 1, live) turns it off. The upscaling DLSS modes are unchanged.
2026-11-17 09:41:08 +03:00
Valiantsin DzerakhandClaude Opus 5.5 77f34a05f5 A plugin build whose plugins all stay off gives the game its own QueryMemory back (#845)
plugins_start returned before clearing mem_query_hook and rt_process_memory when no plugin's set was on (the mod off,
removed, or its file changed), so the game ran with the service run's view of memory: host ranges Inaccessible, the
rtld stand-in below main.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 09:33:49 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b9b8f3dce1 Each mod plugin is built or refused on its own: one that is refused, crashes or hangs costs only itself (#845)
tools/exefs_plugins.py ran every plugin's init in one service run and refused them all when one was refused. Now a run
without inits lists the plugin modules, then each plugin runs in service runs of its own (TOTK_PLUGIN_ONLY, the others
stay loaded): a refused svc, a crash (the FATAL line is the reason), a timeout or a failed check refuses that plugin
alone, with its reason in plugins.status; the rest are built in. 4 plugins take 2.3 s.

At start, plugins_start compares each plugin right after its own init and takes its branches out of main's .text before
the next one, so each init sees the game's bytes, as in its service run. Only that init's aliases are flushed: the
start stays at 113 ms for Full Inventory Expansion + Quick Weapon Durability (107 ms before).

The installer's second lift keeps every plugin of the service runs in the layout when one is built: the records hold
that layout's addresses. A refused plugin stays loaded and never starts. A mod with a built plugin and a refused one,
used without its code, runs the built one (mods.c; --probe-mods case T).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 09:25:24 +03:00
Valiantsin DzerakhandClaude Opus 5.5 152b00494b The release compiles plugin_init.c per install: it reads the install's plugin records from patches.h (#845)
make_release.py stopped at the runtime library: plugin_init.c includes patches.h, a per-version header, so the library
build refused it. Built per install like patches.c, it sees the RT_PLUGINS and RT_PLUGIN_WRITES of the install's own
rebuild.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 09:25:15 +03:00
Valiantsin DzerakhandClaude Opus 5.5 aea4c0c5b3 Merge task/plugins: mod code plugins (exlaunch) run in the game, their hooks ranked by the Mods tab order (#845, #790, #1249)
After the design in #845 by itaskaev2, with the plugin's init run natively on our kernel instead of under Unicorn:
the rebuild runs it in a service run and generates its hook sites (inline, replace, call-site), and every start
runs it again and turns its hooks on when it writes what the build recorded. Checked in game with The Second Quest
(MSFix, 1.4.3), Full Inventory Expansion and Quick Weapon Durability (1.2.1). Without plugins the generated C, the
layout and the boot order are byte-identical to dev.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 09:02:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8cee1afe5d The rebuild builds mod plugins in: service run, checks, patch sets and status lines (#845)
After the design in #845 by itaskaev2. tools/exefs_plugins.py writes an accepted plugin's patch set
(recomp/patches.py plugin lines and hook sites, one ordered set mod_<hash> per plugin, several plugins
in one record told apart by their hooks) and a line per plugin of build-cache/plugins.status: built, or
refused with the first reason. It also checks the code the hooks reach (direct branches and calls from
the stubs, impls, callbacks and targets): no svc but OutputDebugString, imports only from a reviewed
list. The init's imports may now include malloc, free, memcpy, memmove and memset, because the init runs
again at every start and its heap blocks exist while the game runs.

The setup's lift step runs the plugin stage when a mod has exefs/subsdk*: a lift with the plugins, a
totk.exe of it in the compile step's folder, the service run, then the lift with the hook sites; a failed
stage warns (warn.plugins_skipped) and installs without the plugins. docs/mods.md describes what works,
what is refused and why, and the rebuild.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 08:48:31 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d865000929 A mod plugin's init runs at every start and its hooks go on when it writes what the build recorded (#845)
After the design in #845 by itaskaev2, with one change: no image taken after a build-time run. When a
plugin's patch set is on, sdk's DT_INIT runs first, then the plugin's, in the environment of the service
run (rtld image below main, the QueryMemory view, the alias pool, process-memory aliases), then the game's
constructors. That is rtld's order on the Switch (oss-rtld, librtld/source/ld.cpp __rtld_modules_init
runs the modules from the last loaded to the first). sdk's first DT_INIT only registers it with its musl
and main's DT_INIT finishes it, so its flag stays 1 and it is not called a second time. The plugin keeps
its heap blocks, GOT and alias addresses.

The words the init wrote into the game modules and the plugin's .text after it are compared with
patches.h: equal, the set stays on; different, it goes off for this run, the reason is logged, the Mods
tab row says so and build-cache/plugins.stale has the next start run the rebuild. The branches written
into main's .text are taken back. mods.c reads build-cache/plugins.status: a built plugin's set joins its
mod's sets and the Mods tab order, a refused one keeps its mod off with the reason (the catalog texts in
en, ru, pt-BR, zh-Hans), a plugin without a line waits for the rebuild. A plugin file changed after the
build is left out by the loader. TOTK_PLUGIN_TRACE=1 logs the first call of each hook entry.

Without a plugin in the build nothing of this runs. --probe-mods covers a plugin set against another mod's
patch on one site, a refused plugin, one the build lacks and one whose start differs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 08:48:23 +03:00
Valiantsin DzerakhandClaude Opus 5.5 db6d548ba2 The generator lifts a mod plugin's hook sites: a call into its stub, its replace target and its call-site rewrite (#845)
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>
2026-11-17 08:48:14 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b2b85c05fa tools/exefs_plugins.py runs a plugin's init twice and checks the record (#845)
Two service runs with other GetSystemTick values, the words that differ between them listed with what they point
into, and a check that refuses a plugin with a reason per broken rule: a refused run, svcs, GetInfo ids or imports
outside the reviewed lists, writes outside main's .text, and writes that are none of exlaunch's inline hooks
(b to a stur/bl impl/ldur/b/.quad stub whose trampoline is the original relocated plus b site+4), call-site rewrites
(bl to a function start of the plugin's lift) or replace hooks (b from a main function start, Orig trampoline found).
tests/exefs_plugins_test.py covers the layout with and without plugins and one bad record per rule.

After the design in #845 by itaskaev2.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 08:05:19 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b488d9e41d totk.exe --plugin-init runs a mod plugin's init on our kernel and records what it did (#845)
The plugin service run loads the modules as boot does, runs sdk's DT_INIT and then each plugin's from nn::init::Start's
module-init callback (rtld initialises the last loaded module first), writes the record and exits before any game
constructor, graphics or audio. The record holds every word the init wrote into a game module, the plugin's image
before and after its init, the process-memory maps, and the svcs and imports it called.

exlaunch's init needs a Switch-like address space: QueryMemory shows the game's own rtld image below main and the
host's ranges as Inaccessible (it takes Code RX runs for modules), and a 64 GiB free pool for its random alias picks.
New svcs: GetSystemTick, GetInfo 65001 (current process handle), and Map/UnmapProcessMemory, which only the service
run serves: an alias is a copy whose changed words go back into the source when it is unmapped. Any other svc, such
as the CreateSession fallback, ends the run with a reason. nn::oe::GetDisplayVersion is answered with the build's game
version. The game calls none of these svcs; the SVC trace test is still one mask test per SVC.

After the design in #845 by itaskaev2, with the init run natively instead of under Unicorn.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 08:05:19 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b94e8127af Mod plugins get their own modules after sdk in the layout and are lifted with the game (#845)
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>
2026-11-17 08:05:18 +03:00
Marjaperse 3a9e8ea50a Verify selective HUD shape preparation and fallback (#643) 2026-11-17 03:58:35 +02:00
ProSepandClaude Opus 5.5 bf6ebeafa5 Name make_romfs_patches.py's default output after the size, so an --aspect run no longer replaces the 16:9 romfs-patches
Without --out, --aspect wrote into build/<version>/romfs-patches, the folder the game loads at 16:9; the default is
now romfs-patches[-<prompts>]-<w>x<h>[-hud<a>x<b>], the name runtime/romfs.c overlay_init looks for. totk.ini.example
says which sizes get the 21:9 HUD layout.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 03:29:07 +02:00
ProSepandClaude Sonnet 5.5 757ee0b2bf Add hud_width to keep the HUD narrower than a wide screen
On a game resolution wider than 16:9, hud_width = 21:9 or 16:9 keeps the HUD within the middle 21:9 or 16:9 of the
screen instead of its left and right edges; full, the default, is the old behaviour. tools/ultrawide_layout.py takes
the HUD's aspect in place of the corner flag and moves the HUD panes out only as far as that area, and
make_romfs_patches.py --hud writes the layout as romfs-patches-<w>x<h>-hud21x9 or -hud16x9. The runtime loads that
folder when the setting asks for it (the plain shaped folder otherwise, with a log line naming the command that
makes the missing one), the settings menu offers the choices that fit the game resolution, and the installer builds
the folders for every size wider than 16:9 (and wider than 2.5 for 21:9).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-17 03:28:55 +02:00
shinodanpenandClaude 051ec978f9 Make shadow_range move the sun cascades on 1.4.3 by scaling the boundaries the shadow controller writes each frame (#606)
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>
2026-11-16 21:35:45 +00:00
shinodanpenandClaude 7ff62786c3 Make shadow_range move the sun cascades on 1.2.1 by scaling the boundaries the shadow controller writes each frame (#606)
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>
2026-11-16 20:46:11 +00:00
Marjaperse 59e4ed9e7d Follow the 1.1.0 scene singleton indirection for the world clock
The 1.1.0 scene slot is a GOT entry pointing to the singleton storage. Dereference it before walking the scene so game-time scripts, captures and benchmark windows can start. Add a memory-fixture regression for all supported versions and unloaded or invalid player state.
2026-11-16 22:39:45 +02:00
Marjaperse 8c147cf6dd Enable sync ahead for game version 1.1.0
Recognize the verified per-frame NVN wait site while retaining replay and shadow-memory guards. Document support and cover wait selection, polls, unrelated calls, fence completion, timeouts, and disabled modes with a deterministic backend.

Validated 1.6 million wait selections, runtime probes, and a two-minute gameplay smoke test in the v0.4.1 test build. The smoke test retained DLAA and display settings on a disposable profile copy; no FPS improvement is claimed.
2026-11-16 21:42:00 +02:00
Marjaperse 9d66735e73 Make the dynamic resolution toggle work on game version 1.1.0
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.
2026-11-16 21:07:02 +02:00
Valiantsin DzerakhandClaude Opus 5.5 f85058070e Merge pull request #790: the Mods tab order decides code sites too, conflicts show per mod, a mod can be used without its code (Eric Dallo, itaskaev2)
The mods_without_code part of #790 (Eric Dallo's commit, co-authored by itaskaev2), generalised: a per-mod switch "use
without its code" for code modules and unsupported ExeFS patch files, a run-time pick per contested code site from the
Mods tab order, and one conflict table for files, data and code. Generated C without mods is byte-identical to dev.
Plugins (MSFix) wait for the plugin lift of #845.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 20:37:17 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f541d02ba5 MOD_PLUGIN's comment names the per-mod switch that uses such a mod without its code
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 20:35:35 +03:00
Valiantsin DzerakhandClaude Opus 5.5 873903d98f The Mods tab order decides code sites too, conflicts show per mod, and each mod can be used without its code
Load order: mods_exefs_apply ranks each mod's patch sets by its position (rt_patch_rank) and runtime/patches.c fills
the pick byte of every contested site from the sets that are on, lowest rank first; a tie (two files of one mod)
goes to the later file, as emulators apply a mod's files in name order. Reorder and restart, no rebuild. The pick is
redone when an ordered set is switched at run time. Nothing changes for sites one set patches.

Conflicts: one table (mods_conflict) of winner, loser, part (files, data bytes, code sites) and count. romfs.c fills
it for files, mods_exefs_apply for the data bytes two mods stored and for the contested code sites. The log has both
directions per entry and one line per contested code site; each row of the Mods tab lists what the mod overrides and
what overrides it.

Use without its code: a per-mod switch under the row of a mod with a code module or an ExeFS patch file the port
cannot apply (mods_no_code in totk.ini, off by default). On, that code is left out and the rest of the mod is used;
the row says what is left out and why. mods_without_code = 1 holds it on for every mod and now covers the
unsupported patch files too.

--probe-mods: order to winner at contested sites in both orders, the same-mod tie, a switched-off mod, a run-time
switch of the winner, the conflict table for data and code, the per-mod switch.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 20:11:43 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4d2e29aa79 The generator lets the run time pick which ordered patch set runs at a site several of them patch
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>
2026-11-16 20:11:27 +03:00
8e098e95a8 A mod with a code module the port cannot run can be used without it (mods_without_code)
Taken from PR #790, which carries Eric Dallo's work from his fork (ericdallo/totk-pc-recomp, 6241358f): only its
mods_without_code part, adapted to dev, which has the ExeFS data writes already (#835) and no plugin runner. A mod with
an exefs/subsdk* or a replaced exefs/main stays off as a whole; mods_without_code = 1 under [mods] uses the rest of it
(RomFS files, cheats, ExeFS patch files) without that code. ModInfo.code names the modules that do not load; the
scan logs it, the Mods tab says it on the mod's row and shows the switch once such a mod is there.

Co-Authored-By: itaskaev2 <165683571+itaskaev2@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 19:56:42 +03:00
Valiantsin DzerakhandClaude Opus 5.5 000d8f7feb barrier_merge's example sits under [performance] in totk.ini.example, the section cfg.c gives it
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 18:28:23 +03:00
Valiantsin DzerakhandClaude Opus 5.5 684ca3d9f3 Merge pull request #1237: barrier_merge, off by default, keeps a render pass open through the game's texture-invalidating barriers (ripps818)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 18:28:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4798a3bdcf Merge pull request #1233: falling rain draws with shadow storage, the shadow's pending GPU writes merge word by word (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 18:16:17 +03:00
Valiantsin DzerakhandClaude Opus 5.5 547350167b The shadow's word merge loads whole words and updates only the bases over the range
diff_run read each word with a memcpy of variable size, a library call per word, and base_set walked every pending
range (about a hundred) for each run of differing words. word_at loads 4 bytes directly and the bases over the merged
range are found once per merge. Rain at night, shadow = 1 and sync_ahead = 1: the fence write-back took 11-12 ms per
60 frames instead of 20-22 (the plain copy with TOTK_WB_MERGE=0: 7-8 ms). No change in what is merged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 18:12:35 +03:00
Valiantsin DzerakhandClaude Opus 5.5 005881da20 barrier_merge docs name the by-region limit instead of an unexplained edge difference
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 18:05:34 +03:00
Valiantsin DzerakhandClaude Opus 5.5 af1329440d barrier_merge costs nothing per draw while off and guards the reads a merged Barrier cannot order
The storage check in prepare_draw ran on every draw with the setting off; it now runs only when the context's cached
flag is on, and after bind_resources, which may restart the pass (ub_written) and clear the note of a storage writer.
A pass whose target is a 3D BC stand-in no longer merges: its texture gets the writes only at the pass end. After a
merged Barrier, a draw with a storage image or a vertex texture that is an attachment of the pass ends the pass and
begins the next behind the full barrier (merge_guard), since the in-pass by-region barrier orders only fragment shader
sampling. The per-bit Barrier counters count only under TOTK_TRACE=gfx.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 18:03:42 +03:00
Valiantsin Dzerakh 589e1cc03c Merge branch 'pr/1237' into task/pr1237 2026-11-16 17:50:44 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a16120452d Merge pull request #1233: falling rain draws with shadow storage (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 17:50:29 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a3cfb73ab0 Merge pull request #1239: Reflex holds frames to the pacer's frame limit, so fps_limit = display no longer caps it at 60 (itaskaev2, #1218)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 17:49:58 +03:00
Valiantsin Dzerakh c9f155b72f Merge branch 'pr/1239' into task/pr1239 2026-11-16 17:48:33 +03:00
itaskaev2andClaude Opus 5.5 7bd1c539bd Quick save and quick load with no menu on the screen
F6 asks the game for its own autosave, as the sequence node OneShotAutoSaveMgrRequestAutoSave does, after the game's
own check (its wait between autosaves skipped), from the pad read: the game itself makes that request from several
threads. The slot the commit wrote is copied to <profile>/quicksave; a request the game holds back for 5 s is taken
back. F7 holds the window on its last picture, runs the game's load list underneath and, from the confirmation until
the load is over, opens the quick save's files for every read of a slot folder. A toast at the top of the picture says
what happened. The two keys are set on the Controls tab by pressing them. Keyboard and mouse keys only, game 1.4.3.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 09:42:34 +01:00
itaskaev2andClaude Opus 5.5 0a92f9b186 Hold Reflex to the pacer's frame limit, so fps_limit = display no longer caps it at 60
reflex_apply_locked read TOTK_FPS_LIMIT with cfg_int, which turns "display" into the setting's default, 60: with
Reflex on, a 144 Hz monitor stayed at 60 fps. It now takes frame_step_limit_hz, the rate the pacer holds (the
setting, the monitor's rate for display, 60 without the real-time step), and checks it on every present, as the
window measures the monitor's rate after the swapchain is made.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 08:12:34 +01:00
ripps818andClaude Sonnet 5.5 61a407b0e1 Add barrier_merge: keep a render pass open through the game's texture-invalidating barriers
The runtime ended the Vulkan pass at every game Barrier. A Barrier that asks only for fragment ordering and texture
invalidation (ORDER_FRAGMENTS | INVALIDATE_TEXTURE) now leaves the pass open when none of the pass's draws can write a
storage buffer or image, and the next draw sees the writes through a by-region barrier in the feedback layout. Off by
default (barrier_merge = 0, TOTK_BARRIER_MERGE). TOTK_TRACE=gfx also prints how many passes ended by a change of targets
and by the game's Barrier, how many Barrier calls were merged and which NVN barrier bits they carry.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-15 22:00:38 -06:00
ipavlin98 f8e0a7b374 The shadow's word merge skips equal words 64 bytes at a time 2026-11-16 04:01:22 +03:00
ipavlin98 77a52e4577 TOTK_WB_MERGE=0 also turns off the shadow storage's word merge, so the two can be compared 2026-11-16 03:55:56 +03:00
ipavlin98 cabbfc5c86 Shadow storage merges pending GPU writes word by word in both directions, so falling rain draws with shadow = 1: the CPU copy into the shadow skipped every range a recorded GPU write covered, and the particle buffer the rain shaders update is always one, so new drops never reached the GPU, and the copy back at the fence put the shadow's whole range over them 2026-11-16 03:46:43 +03:00
Valiantsin DzerakhandClaude Opus 5.5 e38f3a2223 Merge task/addroff: the GPU address map for device faults is off by default (#1174)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:13:09 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c5b1cc7fac The GPU address map for device faults is off by default (#1174)
With VK_EXT_device_address_binding_report enabled, AMD's Windows driver (26.10.1) tracks every bound range in a
chained hash map that it searches on nearly every recorded command. The chains grow as textures stream in and out, so
after 5-10 minutes in a busy area recording a submission cost 3-4 times more and an RX 9070 XT fell from 60 to 20-30
fps. The map only serves the fault report after a device lost, so TOTK_ADDR_REPORT now defaults to 0 and =1 turns it
on for a run that chases a fault. ADDR_REPORT is a known key now, so the ini line no longer logs "unknown key".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:13:00 +03:00
581c1ecdef Darken only sunlit pixels with contact shadows
The half-resolution lighting pass the composite reads keeps the sun's visibility in its first target's alpha: 1 in
the sun, 0 in the shadow maps' shadow and everywhere underground. vk_contact.c finds that pass (eight targets at half
the scene size, the first RGBA8) and contact_shadow.comp scales its darkening by that alpha, so a contact shadow takes
away direct sunlight only and caves no longer turn flat. Without that pass in the frame the old behaviour stays.
TOTK_CONTACT_DEBUG=2 shows the visibility in grey.

Carried onto dev from #439: the march is now planned by the scan (vk_contact_plan) and recorded from a VkExecJob, so
the lighting target travels in the job's new sun field, and the factor multiplies the facing-the-sun factor of the
back-face fix.

Co-Authored-By: itaskaev2 <165683571+itaskaev2@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 17:34:42 +01:00
Valiantsin DzerakhandClaude Opus 5.5 6151ac4fbc Merge task/bindoff: TOTK_BIND_INC is off by default
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 19:11:50 +03:00
Valiantsin DzerakhandClaude Opus 5.5 ccf9837764 TOTK_BIND_INC is off by default
With it on, a GTX 1050 Ti lost the device at one place in the world, after the validation layer reported a descriptor
pool reset while a command buffer still used it and binds of that pool's sets. The cause is not found and the slower
diagnostic runs did not bring the loss back. bind_inc saves about 1% of the frame, so it waits until the cause is known;
bind_inc = 1 in totk.ini still turns it on.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 19:11:50 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c418dbef04 Merge task/pjournal: a device loss logs the last descriptor pool events, and a pool with two owners is logged at once
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 18:55:52 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d6715029e5 A device loss logs the last descriptor pool events, and a pool with two owners is logged at once
The replay keeps a ring of the last 1024 descriptor pool events (a CbRes made, a pool handed to a CbRes from the spare
list or new, a pool reset or destroyed), a few per submission and nothing per draw. vk_device_fault_report logs the
newest 256 after a device loss. Each pool's owner is checked under spare_lock as the pool is handed out and as it is
reset: a pool handed out while another CbRes holds it, or reset by a CbRes that does not hold it, is logged at once
with the 64 events before it. On a GTX 1050 Ti with TOTK_BIND_INC on, the validation layer reported a descriptor pool
reset while a command buffer used it, then binds of its sets, before a device lost that slower diagnostic runs did
not bring back; the next one names the pool's owners.

--probe-vkexec gains a set batch part (60 submissions of batched sets with splits and empty submissions beside them),
a pool owner part (one pool handed to two CbRes, then reset by the one that no longer holds it: two conflicts) and
calls the device loss report on the working device to check that it comes out and returns.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 18:55:39 +03:00
Valiantsin DzerakhandClaude Opus 5.5 434533aa11 Merge pull request #1207: the memory probe's test textures carry their pool flags, so --probe-vkmem passes again (shenjackyuanjie)
Only the fix commit is taken; the PR branch carries 88 unrelated fork merges. On top: the slot redirect check follows
the format rule of 1c5c6fdb, which the pool-flags failure had hidden.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 11:12:47 +03:00
Valiantsin DzerakhandClaude Opus 5.5 810cf2c2bb The memory probe's slot redirect check follows a texture of the slot's own format
Since 1c5c6fdb a finalized slot follows only a live entry of its texel format at its storage; the check still put an
RGBA8 texture over a BC1 slot and expected the slot to follow it. The live texture is now BC1 of another size, and a
second check puts an RGBA8 texture at the same storage and expects the slot to stay.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 11:12:40 +03:00
Valiantsin Dzerakh fad20c0fcd Up version 0.4.1 2026-11-15 11:08:49 +03:00
shenjack 74bb01d2af Preserve pool flags in the Vulkan memory probe texture fixture 2026-11-15 11:07:25 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c26c3a04bc Merge pull request #1203: on AMD's Windows drivers objects against clouds and fog lose the light blocky fringe round their silhouettes; a discard demotes the fragment as on the Switch (codexx-dev, #164)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 10:38:24 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f5e560d176 Merge pull request #1200: with contact shadows on, rock faces turned away from the sun no longer go dark and smoky, and fewer dark strokes cross the grass (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 10:08:44 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6ff98e2d61 Contact shadows take the in-image neighbour on the screen border when they find the surface normal
On the border the clamped neighbour is the pixel itself, so the nearer-in-depth pick took a zero difference and
normalize() returned NaN; `lit <= 0.0` is false for NaN, so whether those pixels were marched and what they wrote
depended on how the driver clamps NaN. The border now uses the side inside the image, and a NaN gate skips the march.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 10:05:54 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f76a24a7cf Merge pull request #1200 into task/pr1200: with contact shadows on, rock faces turned away from the sun no longer go dark and smoky in haze and fog (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 09:34:39 +03:00
Valiantsin DzerakhandClaude Opus 5.5 33bfd29ebb Merge pull request #1197: a Calibrate gyro button on the Controls tab removes the aim drift of a controller with a gyro bias; each controller keeps its own, and a calibration where the pad moved is rejected (palxex)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 09:32:40 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0efa904d90 A new controller no longer inherits the previous one's gyro bias, and a calibration where the pad moved is rejected
The bias reset in sensors_ready only ran when sensor_pad was nonzero, but scan_pads zeroes it on every disconnect,
so a pad connected after another one kept the old pad's bias, and an attempt still collecting finished on the new
pad under the old pad's name. The bias was also loaded only once, at the first StartSixAxisSensor.

- input.c pad_bias_select runs for every pad the sensor code sees: it drops the old bias and attempt, then loads the
  saved bias when gyro_bias_pad names this pad. scan_pads drops them on disconnect. The bias loads with
  gyro_calibration off too, so turning the switch on mid-run applies it.
- The pad identity is the name plus an FNV-1a hash of SDL's serial when the pad reports one, so two pads of one
  model no longer share a bias; the hash keeps the Bluetooth address out of totk.ini and the log.
- An attempt skips 0.5 s of samples (the button press shakes the pad), then averages 1 s. It is rejected when the
  largest per-axis standard deviation exceeds 0.04 rad/s; a steady bias of any size passes. The row then says the
  controller moved (new UI_MENU_GYRO_CALIBRATE_MOVED in all four catalogs) and the bias in effect stays.
- The timeout counts 5 s without a sample, not 5 s from the start.
- Calibrate gyro starts the sensor thread when the game has not yet (title screen) instead of doing nothing.
- Row states are an enum (MOTION_CALIB_*); motion_calibrate_start takes the clock, and only the gamepad's fusion
  instance writes totk.ini, so --probe-services now checks a measured bias, a rejected attempt and the timeout.
- The duplicate copy_name in motion_fusion.c is gone.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 09:32:05 +03:00
Valiantsin Dzerakh 0a792f22c1 Merge pull request #1197 into task/pr1197: a Calibrate gyro row on the Controls tab removes the aim drift of a controller with a large gyro bias (palxex) 2026-11-15 09:21:40 +03:00
Valiantsin DzerakhandClaude Opus 5.5 7b5265d1fd Discard as demote runs only where shaderDemoteToHelperInvocation is enabled, and the log says whether it is on (#164)
vk_device.c create_device records the feature from the Vulkan 1.3 chain it passes to vkCreateDevice. spirv_demote
leaves the module as the translator wrote it without the feature, also under TOTK_DEMOTE=1, since the
DemoteToHelperInvocation capability needs it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 09:19:24 +03:00
Valiantsin DzerakhandClaude Opus 5.5 db26ab1abb Merge pull request #1194: a charged attack that hits no longer crashes above 60 fps when the weapon's hit record map is full (project-snail)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 09:12:55 +03:00
Valiantsin DzerakhandClaude Opus 5.5 fda4e62405 Merge pull request #1203 into task/pr1203: objects against clouds and fog lose the light blocky fringe on AMD's Windows drivers (codexx-dev)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 09:08:13 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c8a6b91c61 The empty hit list sites' comment names the functions, the stale slot and the registers the skipped path reads
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 09:04:34 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8fde60d854 Merge pull request #1194 into task/pr1194: a charged spear attack that hits no longer crashes above 60 fps (project-snail)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 09:04:24 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b642c849ef Merge task/fpslim: the FP fast paths of the game's code are smaller with the same results, 8% fewer instructions in the hottest functions (#381)
The directed-RMode test folds into the result compare through a per-thread threshold, vector slow paths take
their operands through the Cpu instead of stack copies (___chkstk_ms leaves the large lifted functions), the
static FP helpers use preserve_most, and the slow paths rerun only the failing lanes. Bit-identical to the old
headers: 14.85M edge cases under every FPCR mode on v3 and v2, and 13.4G FP ops compared in a check-mode build in
the town and fight2.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 08:54:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 2ab5329909 The NVN probe's Cpu gets the FP result check threshold too
Its static Cpu ran guest code with a zeroed threshold, which lets +-smallest normal pass the check unexamined.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 08:54:22 +03:00
codexx-dev fc87618233 Demote instead of OpKill on AMD's drivers so a discard keeps the quad's derivatives defined (#164) 2026-11-14 21:25:22 -03:00
itaskaev2andClaude Opus 5.5 a3fee27cfe Leave surfaces turned away from the sun out of the contact shadows
The contact shadow march darkened the whole lit colour of every pixel whose ray toward the sun passed behind
geometry. On a face turned away from the sun the ray runs into that face at once, so every such face within 80 m
was darkened by the full strength, although it gets no direct sunlight to lose: what was darkened was its ambient
light and the fog the composite had already added. In hazy scenes (the Gerudo sandstorm) the shaded rock faces and
the undersides of overhangs showed as dark smoky silhouettes in the haze, and objects such as a wagon lost their
fogged look. The shader now takes the surface normal from the linear depth and scales the shadow by how far the
surface faces the sun: none for faces turned away, a growing share from a grazing angle on.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 23:35:24 +01:00
Valiantsin DzerakhandClaude Opus 5.5 5c48f62fca The FP fast paths of the lifted code check FPCR.RMode inside the result compare and pass vector slow-path operands through the Cpu
The result check of every scalar and vector FP op compares |r| against a per-thread threshold in the Cpu (fp_th_s,
fp_th_d): the smallest normal in round-to-nearest, NaN under a directed RMode, so a directed mode sends every result
to the redo path and the separate load and test of c->fpcr per op goes. rt_fpcr_threshold sets it; rt_fpcr_sync
calls it on every host, and the Cpu inits and the fiber switch's fpcr copy call it too.

The vector slow path FN(vredo) takes its operands from c->fp_arg instead of three stack copies per call site, which
takes ___chkstk_ms out of the large lifted functions (275 call sites in main to 5). It reruns only the lanes that
failed the check. A NaN result in round-to-nearest goes from redo straight to fix with the FZ-flushed operands. The
static FP helpers use preserve_most, so their cold call sites do not spill the caller-saved registers.

Results are bit-identical to the old headers (equivalence harness of build/v143-genko/static2, 200M cases).
On the 42 hottest 1.4.3 functions: instructions -8.2%, bytes -8.8%, hot-path instructions -4.3%.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 00:31:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 94eb3d4628 Merge pull request #322: Steady detail under load, a switch that stops the game lowering model and texture detail when the frame rate drops (ProSep)
The PR's level-of-detail distance part is left out: it made no visible difference in play, and the emulator mod it came from was dropped there as a placebo.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 23:07:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 5f1d74023b Remove the lod_range setting and the lodrange patch set; lod_steady stays
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>
2026-11-14 23:07:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 9d05ccd920 Merge task/padaudio: the DualSense touchpad click is a bindable button, and the audio output device can be chosen in the menu and switches while the game runs (#482, #1014)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 22:54:36 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6347b8262a The audio output device can be chosen on the Sound tab and in totk.ini (audio_device), and a change moves the sound to it while the game runs (#1014)
TOTK_AUDIO_DEVICE names the device as SDL lists it; unset, empty or default keeps the system default and the same open
as before. audio_mixer.c output_open opens the named device, or the default with one log line when it is not
connected. Once a device is chosen, an output worker thread (output_worker) owns the SDL stream: on a cfg change and
once a second it resolves the name again and output_switch opens the new device with the same spec, destroys the old
stream (which waits for its callback), restarts the prefill and resumes. The render thread only wakes or starts the
worker (output_watch), so the game's audio never waits for a device open. A chosen device that disappears falls back
to the system default and comes back within a second of being plugged in again. TOTK_AUDIO_CHANNELS=auto reads the
channels of the device chosen at start.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 22:28:42 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0ce53aa7c7 The DualSense and DualShock 4 touchpad click is a bindable gamepad input named touchpad, shown and captured on the Controls tab (#482)
PAD_TOUCHPAD follows the paddles in input_map.h and reads SDL_GAMEPAD_BUTTON_TOUCHPAD in input.c pad_physical, so
input_capture sees the click when a Controls cell waits for a press (#852 had no pad id to report it). It is unbound by
default; pads without a touchpad never report it held.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 22:19:51 +03:00
Valiantsin DzerakhandClaude Opus 5.5 cf3acd0a2f Model detail range replaces the distant detail switch: lod_range scales the depth at which models leave their detailed level (1x, 1.5x, 2x, 3x or max) (#949)
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>
2026-11-14 21:58:48 +03:00
palxex dc13b194ce Add gyro bias calibration for the six-axis sensor
The yaw axis has no gravity reference, so it drifts with the gyro's
manufacturing bias. Two controllers of the same model can drift in
opposite directions, and the sensor fusion had no way to estimate or
remove the offset: aiming with motion turned slowly on its own and
needed constant correction.

A Calibrate gyro row on the Controls tab collects 250 gyro samples
(about a second) while the controller is held still, averages them per
axis into a bias, subtracts that bias from every sample before the
fusion integrates it, and restarts the angle so the estimate starts
clean. Collection has no motion threshold: a controller whose bias
exceeds any absolute threshold would otherwise never finish, which is
how the first version of this stalled with no way out. Five seconds
without the expected samples ends the attempt, from the sample path and
from the menu alike, so a sensor thread that stops feeding it is
reported instead of leaving the row on "calibrating". The first raw
sample and the final bias are logged, so a report carries the numbers
that were measured.

The row's value says where the controller stands: calibrating,
"<controller>, calibrated" once it is done or when the bias was loaded
from totk.ini at start, and "calibration failed" when an attempt timed
out with no bias in effect. A controller change cancels a calibration
that is in progress and clears the bias and the label, so neither is
carried over to the new controller.

The behaviour sits behind gyro_calibration (the Controls tab's "Gyro
bias calibration", default on, live): off, the fusion takes the raw
gyro, an attempt in progress is dropped, and nothing is loaded at
start, while the saved keys stay in totk.ini so turning it back on
restores the last calibration.

The bias and the controller's name go to totk.ini when calibration
completes, outside the fusion's lock, and are loaded at the next start
only when the connected controller has the same name.

Tested with a Switch Pro Controller on the 1.4.3 build: the log shows a
z-axis bias of 0.139 rad/s (8 degrees per second), calibration finishes
in about a second, the yaw drift is gone, and the row reports each state.
2026-11-15 02:26:30 +08:00
Valiantsin DzerakhandClaude Opus 5.5 517a161457 Merge pull request #322: distant model detail settings, brought up to date with dev (ProSep)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 21:16:19 +03:00
Valiantsin DzerakhandClaude Opus 5.5 3858ad4b51 Merge task/pack: lifted functions skip the function-entry check except where the runtime watches them, and host calls are no longer counted outside probes and traces (#381)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 20:03:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f1a771e493 Merge task/bindinc: a draw rebuilds only the bindings, shaders and pipeline state whose inputs changed since the draw before, about 3% less render-thread time on the CPU (#381)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 20:03:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 2f32f21f5c The incremental draw preparation is on by default, and bind_inc and memx are listed in totk.ini.example (#381)
TOTK_BIND_INC had no settings row, so unset meant off. It now has one with default 1, like TOTK_MEMX: 0 or off turns
it off, check keeps the comparison mode. The check mode found 0 differences on 13 scenes (town, fight2, Kakariko,
Great Sky Island, Depths lit and dark, a shrine, rain, a cave, evening, a field, the menus, entering a building).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 20:03:24 +03:00
Valiantsin DzerakhandClaude Opus 5.5 99878f3c55 Log the first guest write of a directed FPCR rounding mode, with its caller
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>
2026-11-14 19:05:19 +03:00
Valiantsin DzerakhandClaude Opus 5.5 2d5879f9e2 Host-function calls are counted only by the probes and under TOTK_TRACE=host
hostfn_entry bumped a per-thread call counter on every host-function call (a TLS load, two branches, a load and a
store) for readers that only the probes and the boot checkpoint line have. The count now sits beside the first-call
trace in a cold hostfn_watch, behind the same single test of rt_trace: RT_TRACE_HOSTCOUNT, switched by hostfn_count,
which --probe-kernel (test_lifted_ticks reads the count) and --probe-ipc turn on. The boot checkpoint line leaves the
host-call count out when nothing counted.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 19:05:18 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6a23628771 Lifted functions check the function-entry hook only where the runtime watches them, on 1.4.3 only the render size setup
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>
2026-11-14 19:05:08 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d52c16e651 Merge dev into task/bindinc: the incremental binding keeps its logic and takes dev's inline compares and copies (TOTK_MEMX)
The ten conflicts in runtime/vk_exec_draw.c were dev's memcmp/memcpy -> MX_EQ/MX_NE/MX_CPY swap on lines task/bindinc
had rewritten. Each keeps the task/bindinc code with the swap applied to its hot-path compares and copies (push and set
signature compares, the shader memo's pipe compare, the pipeline memo and recorded-state compares, the vertex
attribute and stream lists). The check-mode compares that call bi_mismatch keep memcmp as the reference.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 18:47:31 +03:00
project-snail f3efc5806c Send an empty charged-attack hit list to the game's own count == 0 check
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.
2026-11-14 21:00:38 +08:00
Valiantsin DzerakhandClaude Opus 5.5 97d12240f4 Merge task/cheatsrebuild: on the Linux AppImage "Rebuild the game now" starts the setup AppImage itself, so code cheats get built in, and a rebuild that does not start is tried again (#560, #403)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 15:13:04 +03:00
Valiantsin DzerakhandClaude Opus 5.5 35c590bacd Start the Linux rebuild through the AppImage file, not its vanished mount
The setup wrote the path of its Python inside the AppImage mount into
build-cache/rebuild.txt. The mount is gone once the setup exits, so the
game could not start the rebuild for code cheats and ExeFS patches, kept
its old code, and rebuild.skip then stopped every later attempt. The
command now starts $APPIMAGE --rebuild <install folder>, and a rebuild
that does not start leaves no rebuild.skip (#560, #403)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 15:12:35 +03:00
Valiantsin DzerakhandClaude Opus 5.5 04ccb9cd36 Merge task/pr996: pull request #996, the lift redoes only the chunks whose inputs changed, so a cheat or mod change lifts in seconds instead of a minute or more (Wesley-CR)
On 1.4.3 the cached lift and a --no-cache lift give byte-identical C, tables and folded.txt; a run with unchanged
inputs reuses all 418 chunks in 2.8 s (92 s cold), and one patch site removed lifts one chunk in 3.7 s with the same
output as a full lift. tests/lift_cache_test.py passes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 14:16:30 +03:00
Valiantsin DzerakhandClaude Opus 5.5 3fc643cb65 Merge pull request #996 into task/pr996: lift again only the chunks whose inputs changed
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>
2026-11-14 14:16:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b2355be341 Merge task/memx: the replay compares and copies its per-draw state inline instead of calling the C library, about 5% less render-thread time on the CPU (#381)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 11:35:49 +03:00
Valiantsin DzerakhandClaude Opus 5.5 354887a2a3 The replay's per-draw compares and copies run inline instead of calling ucrtbase memcmp and memcpy (TOTK_MEMX)
runtime/memx.h: MX_EQ and MX_CPY compare and copy with 32-byte loads in the caller; a constant size unrolls, a variable
one loops without a call. Used for the pipeline memo state and the recorded dynamic state (prepare_draw), the shader
answers (shader_for, which also compares the stored hash first), descriptor signatures and push sets (bind_resources),
c0 and support buffers, the uniform update copies, the vertex attribute and stream binds, pipe_find, the dynamic state
delta, nvn_hm_get and the recorder's tail_copy. TOTK_MEMX=1 (default) takes the inline forms, 0 keeps memcmp/memcpy,
check runs memcmp and logs any compare the inline form answers differently.

Machine A, 4 cores, 1080p, bindinc on both sides: Lookout Landing replay 9.64 -> 9.16 ms over 4+4 runs (each ABBA block
-0.40 and -0.55 ms), Kakariko 9.04 -> 8.38 ms over 2+2. Check mode on dev: Lookout Landing pan, 0 mismatches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 11:35:29 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1ada4a7586 Wake the recorder through the fenced check on every publish (#1174)
pub_now stored head and read Q.sleeping with no fence between them, while rec_main sets Q.sleeping and then reads head.
x86 may read Q.sleeping before the head store is visible, so both sides could miss each other and the recorder slept
out its 2 ms timeout with packets waiting. Since rec_submit returns without a drain (TOTK_REC_ASYNC=1), its publish is
the last of a submission, and the present, uploads and readbacks waited for that timeout in rec_queue_wait: a #1174 log
on an RX 9070 XT shows 1.6 to 3.4 ms a wait late in the session against 0.04 ms at its start. pub_now now wakes through
wake(), which has the fence. Cost: one locked instruction per publish, about 2300 a frame in that scene.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 11:15:01 +03:00
Valiantsin DzerakhandClaude Opus 5.5 42b36b0e0b Merge task/prfix: pull requests #1184 (with #1161), #1162, #1163, #1164 and #1165; with DLSS/DLAA the picture no longer flickers, the mist no longer flashes, the inventory icon is no longer stretched over the menu and the quick weapon menu no longer closes on a dark frame; the chunked replay no longer leaves a black strip by the quick menu; shadow is a known totk.ini key (ipavlin98, itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 08:42:55 +03:00
Valiantsin DzerakhandClaude Opus 5.5 e654aa288f Merge pull request #1165 into task/prfix: SHADOW is a known totk.ini key (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 08:34:52 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4e3464767e Merge pull request #1164 into task/prfix: A chunk of the chunked replay records a new pool-bound image's first transition and clear in its own command buffer, which removes the black strip by the quick menu (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 08:34:52 +03:00
Valiantsin DzerakhandClaude Opus 5.5 06088863bc Merge pull request #1163 into task/prfix: DLSS arms only on a light target more than half the scene size, so the frame no longer goes dark when the quick weapon menu closes (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 08:34:52 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b8800bac86 Merge pull request #1162 into task/prfix: DLSS arms only on a light target of the scene's shape, so the inventory icon no longer stretches over the menu (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 08:34:51 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d77a637053 Merge pull request #1184 into task/prfix: DLAA ends the scene only at a bloom pass of the scene's shape without depth, so distant mist no longer flashes (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 08:34:48 +03:00
Valiantsin DzerakhandClaude Opus 5.5 e7dbe74f44 Graphics descriptor sets are no longer shared within a submission, and the per-draw keep tests are made once per pipeline (TOTK_BIND_INC)
The set table probe cost about 54 ns a draw on Lookout Landing (a cache miss on the 4096-entry table plus two hashes of
every set) and shared 6.7% of the allocated sets. Batched allocation stays. bi_plan's walk over every binding is
replaced by per-binding tests (bi_tests, kept in the pipeline's RsList) that bind_resources evaluates in its own loop,
with the volatile flag kept per binding. A kept binding after a build rereads only the generation group it depends on.
Check mode: 0 mismatches in town, Kakariko, fight2, island and Depths, 60 s each.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 07:58:16 +03:00
ipavlin98 c18f3d6c5c End the DLAA scene only at a bloom pass of the scene's shape without depth, so the sky lookups and the quarter-size particles that follow transparents drawn early no longer end it before the mist, which DLSS then missed on runs of frames and the distant mist flashed between them 2026-11-14 05:37:10 +03:00
ipavlin98 a02413d2f6 Keep DLSS on frames where the game draws a half-size mip chain of the scene before the light target: the bloom chain's start now needs level 0, as the chain's level 1 ended the scene before anything was armed, DLAA skipped those frames and the picture flickered between anti-aliased and plain ones 2026-11-14 05:37:10 +03:00
Valiantsin DzerakhandClaude Opus 5.5 ecd0f004cc A kept descriptor is built again when a build earlier in the same draw moved the generations it depends on (TOTK_BIND_INC)
Check mode on the island save caught one kept texture descriptor whose view differed from the full build: a lookup
of an earlier binding of the same draw made a texture entry (vk_texture_slots_gen moved during the build), and the
full build resolved the later slot under the new generation. bi_plan now records per kept binding whether it depends
on G_tex or G_buf; after a binding is built, the loop reads both again and builds every later binding that depends
on one that moved. Island and Lookout Landing check, 60 s each: 0 mismatches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 00:18:52 +03:00
Valiantsin DzerakhandClaude Opus 5.5 dba054110b Graphics descriptor sets are shared within a submission and allocated in batches (TOTK_BIND_INC)
Adapted from Savage Wind Recomp's set_finish and vk_alloc_set (MIT, row in THIRD_PARTY_NOTICES.md). A graphics set
that would be allocated and written is first looked up in a per-context table keyed by two independent 64-bit hashes
of its layout and packed descriptors and stamped with the submission's fence: an equal set of the same submission is
bound instead. New sets come from the submission's last pool in batches of one layout that grow 1, 2, 4, 8, 16 while
the layout repeats, one vkAllocateDescriptorSets per batch instead of per set. check stores each set's contents,
compares every hit with them and allocates as before. Lookout Landing: about 2,000 allocated graphics sets a frame,
6.7% shared; check 0 mismatches; on ran 60 s without errors.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 23:52:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c26ed9ba7b A graphics draw with the previous draw's pipeline rebuilds only the descriptors whose inputs changed (TOTK_BIND_INC)
With TOTK_BIND_INC the graphics build writes into VkExecDraw.BI, which keeps the packed descriptors of the last build
and, per descriptor, what it counted for the traffic census and whether it copied guest bytes. bi_plan names the
bindings to build again: support always; c0 when a storage slot of the stage or the base instance changed; the
compiler constants when the program, its serial or G_buf changed; uniform and storage slots when marked or when G_buf
(pools and mirrors, snapshots, overlays, the submission) moved; textures and images when a handle was marked or G_tex
(slot registrations, samplers, the storage epoch, the feedback layout, DLSS's swap) moved; storage addresses held in
a uniform block, and any descriptor whose build copied guest bytes, every time. A pipeline with a written storage
binding is built in full. Kept descriptors count their census again; a set none of whose descriptors changed and that
is still pushed or bound records nothing, without the psig or sig compare. check builds everything as before and
compares each kept descriptor and its census with the build. Lookout Landing check, 60 s: about 17,000 kept bindings
compared a frame, 0 mismatches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 23:49:21 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c86feefadc A draw skips the vertex stream loop while none of the streams it reads changed (TOTK_BIND_INC)
bind_vertex_buffers resolves and compares the 17 streams the vertex input reads on every draw. When the last
prepared draw bound the same set of streams in this command buffer, no op changed one of their ranges, vk_mem_gen
stayed, and with static vertex input the strides did (pipe_gen), every stream would resolve to what is bound: the
loop is skipped. check runs the loop and counts a stream it would bind again. Lookout Landing check, 60 s: 62% of
draws skip it, 0 mismatches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 23:47:24 +03:00
Valiantsin DzerakhandClaude Opus 5.5 772d9dea66 The feedback scan keeps its answer across texture binds that leave the fragment shader's slots alone (TOTK_BIND_INC)
feedback_scan's memo is keyed by tex_serial, which every texture or image bind of either stage moves. When the memo
holds the last prepared draw's scan (BiLast.fb_ok) of the same fragment shader in the same pass, no slot was
registered since, and no marked fragment texture slot is one the shader reads (BiMask.ftex, buffer textures
included), the answer stands. check scans and compares. Lookout Landing check, 60 s: kept on 68% of draws (the memo
alone 60%), 0 mismatches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 23:45:44 +03:00
Valiantsin DzerakhandClaude Opus 5.5 dcd5dc3cf4 A draw keeps the previous draw's shaders while no texture or image slot their translation reads changed (TOTK_BIND_INC)
The shader memo already keeps them while the program, the bound state and the first 32 handles of both stages are
equal. With the marks it also keeps them when other slots were rebound: no program or serial change, the same
pipe_gen and slot generation, and no marked texture or image slot inside the program's slot mask (slot_mask_of,
~0u while unknown), which are all answers_for reads. BiLast.sm_ok says the memo holds the last prepared draw's
shaders, so a mark cleared by a later draw never hides a change. check looks the shaders up and compares. Lookout
Landing check, 60 s: shaders kept on 65% of draws (the memo alone 55%), 0 mismatches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 23:44:01 +03:00
Valiantsin DzerakhandClaude Opus 5.5 ff3a95d0f1 A draw whose pipeline state no op changed takes the previous draw's pipeline and state without building and comparing them (TOTK_BIND_INC)
From task/fastrep 18eab597 (TOTK_PIPE_GEN), now under TOTK_BIND_INC: the pipeline memo keeps the pipe_gen its state
was built under; a draw with that generation and the same shaders, primitive, restart, feedback flags and depth mode
takes the memo's state and pipeline and skips the three 360-byte compares (memo, cache entry, recorded state). The
shader memo skips its compare of pipe the same way. check builds and compares as before and counts a state the
generation called unchanged that differs (bi_mismatch logs the first of each kind with its marks and generations).
The census runs only in check mode. Lookout Landing check, 60 s: 67% of draws keep the state, 0 mismatches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 23:42:11 +03:00
Valiantsin DzerakhandClaude Opus 5.5 2abfa23a67 Bind ops mark the slots whose bytes they changed and a per-draw census counts what the next draw could keep (TOTK_BIND_INC)
vk_exec_bind compares before it writes: VkExec.dirt gets a bit per program, uniform, storage, texture, image and
vertex buffer slot that changed, pipe_gen moves with every change of the pipeline state (also depth clamp, raster
discard and the target formats), fbl_serial with the feedback-layout images, OV.gen with the uniform overlays.
vk_exec_draw_new_cb, copy_state and state_reset mark everything. With TOTK_BIND_INC=on or check, bi_census sorts each
prepared draw by what changed since the draw before (nothing, uniform slots only, other slots, another pipeline) and
counts the descriptors to rebuild, the generation moves and the shader, pipeline, vertex buffer and feedback keeps;
a bind_inc line every 300 frames. No draw is prepared differently yet.

Lookout Landing, 4500 draws a frame: nothing changed 8.7%, uniforms only 55.5%, other slots 22.9%, another pipeline
12.8%; 3.4 of 11.2 descriptors a draw to rebuild; uniform overlays move on 2.3% of draws, snapshots 0.1%.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 23:40:01 +03:00
Valiantsin DzerakhandClaude Opus 5.5 673229727d Merge task/vloc: lifted functions keep their 8 most used V registers in host registers, 4-6% less guest time in a town
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 20:42:31 +03:00
Valiantsin Dzerakh 1a1f21ebe0 Merge branch 'dev' into task/vloc 2026-11-13 20:11:40 +03:00
Valiantsin DzerakhandClaude Opus 5.5 44bc5887f0 gen.py keeps 8 V registers per function in locals by default
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>
2026-11-13 20:11:39 +03:00
Valiantsin DzerakhandClaude Opus 5.5 eb8c7ea888 gen.py --v-locals K keeps the K most used V registers of each function in C locals
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>
2026-11-13 19:40:05 +03:00
Valiantsin DzerakhandClaude Opus 5.5 520e80eb18 simd.h reaches V registers through macros that a chunk built with RT_VLOCALS maps to function locals
Work in progress: the generator side (gen.py --v-locals) is not written yet, so no chunk defines RT_VLOCALS and the
default build is unchanged. build_game.py gains --gen-o2 for A/B builds at the PGO optimisation level without a profile.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 19:05:12 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a5b3fcdc92 Merge task/patchside: ov_ability.c is compiled per install, so a release starts on 1.4.3 again, and the library build stops on any source with a per-version header (#1005)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 18:07:47 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bdba6ba83f Compile ov_ability.c per install, so 1.4.3 starts from a release again
The ability target guard registers its host function on the game version's patch page (patches.h), but it was left
out of INSTALL_SIDE and went into libtotkrt.a, which make_release builds once from 1.2.1's generated headers. On a
1.4.3 install that address lies inside sdk and dispatch stops at start ("host function at 0x700472bf60 lies inside
module sdk"). The library build now also stops when a library source includes a per-version header. (#1005)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 18:06:37 +03:00
ipavlin98 1a3b2936d6 Arm DLSS only on a light target more than half the scene's size, so the half-size effects target that armed on frames around the quick weapon menu, where the half-size G-buffer came first, is no longer scaled to the output in place of the scene 2026-11-13 08:46:42 +03:00
ipavlin98 6ef1eafca7 Arm DLSS only on a light target of the scene's shape, so the square targets the inventory renders item icons into are no longer scaled to the output and drawn over the menu 2026-11-13 08:46:41 +03:00
Valiantsin DzerakhandClaude Opus 5.5 00baa18d14 Merge task/pr1146: pull request #1146, separate Music, SFX and Voice volume settings in the Sound menu; sounds are classified by their RomFS names, BARS entries and ADPCM coefficient tables, only while one of the three is below 100 (#722, RxEmam)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 08:38:24 +03:00
ipavlin98 cefc618f70 Record a new pool-bound image's first transition and depth clear inside the chunk that makes it, at its op, so the clear no longer runs after the chunks already on the GPU and blanks a strip of what they rendered into the shared storage, seen for a frame right of the quick weapon menu while its icons are drawn 2026-11-13 08:38:20 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f83fdbbd0b The music, effects and voice volumes classify nothing at their defaults, look a voice up once per wave buffer, and count unmatched sounds as effects (#722)
At 100/100/100 the RomFS, zstd and Opus hooks and the mixer lookup are skipped (audio_cat_active); the
RomFS handle still keeps its category, so a stream opened earlier is classified by its later reads once a
setting moves. The mixer keeps each voice's category until it moves to another wave buffer or coefficient
table, instead of up to six scans of a 32768-entry ring per voice per frame; the ring is 4096 entries and
lookups take its lock. zstd decodes check the BARS magic before any lookup. The guesses from BWAV headers
(Opus means voice, stereo ADPCM means music) are gone: Opus streams are the DmT cutscene beds and stereo
ADPCM is common among effects. Unknown Opus output counts as effects. A once-a-minute log line counts the
categories while a setting is below 100.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 08:38:08 +03:00
Valiantsin DzerakhandClaude Opus 5.5 25f42aa84e Merge pull request #1146 into task/pr1146: separate Music, SFX and Voice volume sliders
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 08:26:13 +03:00
itaskaev2andClaude Opus 5.5 5c57d94098 List shadow among the known settings and document it as a totk.ini key
The runtime reads TOTK_SHADOW through cfg_get, so `shadow = 1` in totk.ini already turns shadow storage on, but the
key was missing from cfg.c known[]: every such totk.ini logged "unknown key 'SHADOW'", which reads as if the line did
nothing. The docs only named the environment variable.

known[] now has SHADOW, totk.ini.example describes `shadow` next to sync_ahead (which needs it), and the sync_ahead
text, its log line, docs/building.md and docs/architecture.md name the totk.ini key next to TOTK_SHADOW. Behaviour is
unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 23:41:44 +01:00
Valiantsin DzerakhandClaude Opus 5.5 49e990fedf Merge task/pr552: pull request #552, the HDR tonemap rebuilds bright colours from the game's SDR picture with RenoDX's MacLeod-Boynton hue and purity transfer, Neutwo peak mapping and gamma 2.2 correction, replacing #442's highlight blend; hdr_hue now scales it (Zenrap0518)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 23:21:59 +03:00
Valiantsin DzerakhandClaude Opus 5.5 97dd94eb99 The HDR hue setting drives the RenoDX colour reconstruction, its matrix chains fold at compile time, and the notices name the adapted code
hdr_hue (TOTK_HDR_HUE) scales the MacLeod-Boynton hue and purity transfer that replaced #442's blend: the default
moves from 80 to 70, where the transfer is RenoDX's default 70% hue shift and 65% SDR blowout, and 0 turns it off
as the menu text says. The shader's two-step colour space conversions become one constant matrix each and the D65
white point a constant, which halves its matrix-vector products. THIRD_PARTY_NOTICES.md and vk_hdr.c now say the
reconstruction is adapted from RenoDX at 43c067b, MIT.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 23:21:04 +03:00
Valiantsin DzerakhandClaude Opus 5.5 9902e01aae Merge pull request #552 into task/pr552: RenoDX's colour reconstruction for the HDR tonemap
The shader conflict with #442's highlight hue correction is resolved in favour of #552's shader, which replaces that
blend; its SPIR-V header is regenerated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 23:20:36 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c89b0f3ee3 Merge task/abilguard2: the Recall / Ultrahand target check also drops a target whose link record points into unreadable memory (#1005, #1137, #1145)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 20:31:46 +03:00
Valiantsin DzerakhandClaude Opus 5.5 47e6d908f7 The ability target check also drops a target whose link record the game would follow into unreadable memory (#1005, #1137, #1145)
main+0x155ec (1.2.1: main+0x809ecc) stores the actor's link record [actor+0x1a8] in the owner and updates its +0x50
atomically unless the actor's state word is 7..11. A freed actor can carry a stale pointer there that the old check
let through.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 20:31:40 +03:00
Valiantsin DzerakhandClaude Opus 5.5 e6839387fc Merge task/abilityguard: a stale Recall / Ultrahand target is dropped only where the game would fault on it, replacing the 4 GiB target check, and the model scene report loop gets a bound (#1005, #1137, #1145)
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>
2026-11-12 19:57:07 +03:00
Valiantsin DzerakhandClaude Opus 5.5 ad54ab4910 Merge task/promptgen: the setup writes the shaped RomFS folders only for the player's screen shapes and prompt style, one folder per shape instead of per size, and the settings menu can prepare a missing one
Before, the setup wrote every prompt style for all 15 sizes: 64 folders, about 6.5 min and 370 MB of Common layout
archives. Now the four 16:9 folders stay, PcPrompts writes only the 16:9 keyboard prompts from the bind_ lines, and
the new Shapes step writes the layout and the selected style's prompts for the shapes of the connected displays and
the configured output_res. The game maps a resolution to its shape's folder, an exact-size folder from an older
install still wins, and the game-resolution row offers to start the generator for a missing shape.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 19:03:26 +03:00
Valiantsin DzerakhandClaude Opus 5.5 fa524128ce The settings menu starts each shape's generator once per game start and draws the keyboard prompts from the bindings
romfs.c romfs_shape_prepare remembers the folders it started a generator for, so a second click, or the same game
resolution chosen again while one runs, starts no second generator writing into the same folder. The shaped keyboard
and mouse prompts get totk.ini as --binds, as the setup's PcPrompts and Shapes steps draw them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 19:02:31 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bc578148ab Write RomFS layout folders only for the screen shapes and prompts this player uses
The setup wrote 64 patch folders: every prompts style for all 15 shaped game resolutions. The new shapes step
(installer/screens.py) writes romfs-patches-<w>x<h> only for the shapes of the connected displays, the output_res the
game defaults to on each and the totk.ini output_res, and the prompts' shaped folder only for the style totk.ini
selects. One folder per shape: the runtime maps the game resolution to its shape's size (cfg.c cfg_shape_size, the
closest ratio within 1%), and an exact-size folder from an older install still wins. The settings menu marks a game
resolution whose shape has no folder and can start the generator for it in the background, for the next start.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 19:02:31 +03:00
Valiantsin DzerakhandClaude Opus 5.5 df3e90dc4c Merge task/pr1136: opt-in gameplay tweaks for keyboard and mouse, the wheel turns and moves an Ultrahand object, switches weapons, steps the D-pad strips and zooms the map smoothly (RxEmam)
Pull request #1136 with three fixes: the Russian and Portuguese rows name Ultrahand as the catalogs do, smooth map
zoom takes the wheel only on the map menu_cursor.c finds, and the weapon bar opens only where the camera hooks saw
free roam, a lock-on or a mount. Off by default (gameplay_tweaks_enabled = 0).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 18:29:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 887ce32343 Open the wheel's weapon bar only where the camera hooks saw free roam, a lock-on or a mount
An unclassified camera is also a paused menu, a 1.2.1 menu or any screen menu_cursor.c does not read; opening the bar
there held D-pad right and moved the right stick inside that menu.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 18:29:24 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a9de583d79 Merge pull request #1002: game 1.1.0 gets the core frame and camera patch sets of 1.2.1 and 1.4.3, so the frame rate, cursor, field of view and aspect ratio options work on it (shenjackyuanjie)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 18:29:21 +03:00
Valiantsin DzerakhandClaude Opus 5.5 2e494481d3 Smooth map zoom takes the wheel only on the map menu_cursor.c finds
With menu_cursor = 0 map_zoom_allowed answered yes everywhere outside aiming, scope, Ultrahand and lock-on, so the
wheel in free roam pushed the right stick's Y and tilted the camera, and the weapon wheel never got the wheel.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 18:25:40 +03:00
0xEmz 1f224dc0f9 Add separate Music, SFX, and Voice volume sliders (#722)
Add volume_music, volume_sfx, and volume_voice sliders under the Sound tab
in the F1 settings menu and in totk.ini to control background music, sound
effects, and character voices independently.

Classifies audio streams by file path in RomFS, parses BARS and BWAV headers
for ADPCM coefficient tables and stream formats, tags decompressed Opus streams
from nn::codec, and applies per-category gain factors in the audio mixer
during voice rendering.

Localized across English, Russian, Brazilian Portuguese, and Simplified Chinese.
Documented in totk.ini.example.
2026-11-12 17:25:33 +02:00
Valiantsin DzerakhandClaude Opus 5.5 8ef46a245a Name Ultrahand as the game does in the Russian and Portuguese gameplay tweak texts
The Russian rows called it Автоколесо, the catalog and the game say Ультрарука; the Portuguese rows kept the English
name where the catalog says Ultramão.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 18:25:14 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d14e2a8f62 Merge pull request #1136 into task/pr1136
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 18:21:53 +03:00
Valiantsin DzerakhandClaude Opus 5.5 24be739310 Merge pull request #1142: the setup names an antivirus or a running game when it cannot write totk.exe, instead of the bare compile failure (itaskaev2) (#1122)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 18:19:47 +03:00
itaskaev2andClaude Opus 5.5 f854d67e6f Name the other program that holds totk.exe when the setup cannot link it
When ld.lld cannot write the totk.exe it links in the setup's temp build folder (Permission denied), the setup
showed only "Compiling totk.exe failed". In #1122 the holder was an antivirus that flagged the new exe, not a
running game. The compile step now recognises that failure in the build log and says what to do: close the game,
exclude the setup's and the install folder from the antivirus, restart Windows and run the setup again. Texts in
en, ru, pt-BR and zh-Hans; build_game.py's own line names the antivirus too.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 11:17:51 +01:00
Valiantsin DzerakhandClaude Opus 5.5 b6c5d37fb7 Merge pull request #1115: on Linux the menu asks fontconfig for its CJK font before the five fixed paths (jcleng)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 07:57:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 608f915156 Merge pull request #1118: the game window's own pointer image returns as pointer_image, off by default (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 07:57:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 357d148066 Merge pull request #1128: the chunked replay no longer freezes or crashes in chunk_record with replay_workers above 0, the target history's oldest-way search stays in its set (ipavlin98) (#1104)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 07:57:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 7692aabdc5 Merge task/vkey: a freed holder behind the optional reference at object +0x6b0 no longer crashes the game in main+0x1bd0138 / 0x1622bec, its target counts as absent (#1005)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 07:47:39 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b80a568df5 Treat a target below 4 GiB behind the optional reference at object +0x6b0 as absent, so the freed-holder crash in main+0x1bd0138 stops on 1.4.3 and 1.2.1 (#1005)
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>
2026-11-12 07:47:32 +03:00
0xEmz 312e59a9f7 Add optional mouse wheel and keyboard gameplay tweaks (gameplay_tweaks_enabled, off by default). 2026-11-12 03:29:24 +02:00
ipavlin98 3a8f93c64b Pick the oldest way of a target history set by index from the set's start, so a new target no longer overwrites the chunked replay's state (#1104)
tfr_note moved its pointer inside the search loop, so each later way was counted from the way it had picked and the
search could step up to 20 entries past the set. From the last set it wrote the new entry into RP, which follows the
table: the image handle into the take word, which left the submitting thread waiting in chunks_submit for a chunk no
recording thread took (a freeze with replay_workers above 0), and level and layer into the handle list, which crashed
chunk_record reading address 0x8. --probe-vkexec gets a part that stamps a set's ways so the old search left it.
2026-11-11 23:51:01 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0ded6164a0 Describe optref_guard, ability_guard and report_guard in docs/settings.md (#1005)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 17:19:05 +03:00
Valiantsin DzerakhandClaude Opus 5.5 42c458712d Crash guards switchable from totk.ini: optref_guard, ability_guard, report_guard (#1005)
The three patch sets read their switch through cfg, so the keys already worked from totk.ini but logged as unknown and
were undocumented. They are now known keys with defaults (on), in [performance] of totk.ini.example; the settings menu
does not show them. The settings table reached 128 rows, the size of the menu's reset list, so that list grows to 256
and logs if the table ever outgrows it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 17:16:10 +03:00
Valiantsin DzerakhandClaude Opus 5.5 5d8c2ceb30 Drop an ability target only where the game would fault on it, and keep the live-actor test as a log line (#1005)
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>
2026-11-11 16:59:35 +03:00
itaskaev2andClaude Opus 5.5 fc985e690e Bring back the game window's pointer image as pointer_image, off by default
#1092's pointer image (runtime/cursor_art.c: a gold arrowhead with a dark edge, a turquoise gem and a soft shadow,
drawn at the window's DPI) was left out of dev because it changed the pointer for every player with no way to keep
the system arrow. It now comes with pointer_image (input section, live, default 0): 0 leaves the window class's arrow
as dev has it, 1 shows the image while the cursor is not captured. Win32 reads the setting at WM_SETCURSOR (the
next mouse move after a change); SDL sets the image or its default cursor when the settings change (input_sdl_idle).
The setting has its row under the mouse rows of the Controls tab, its text in the four menu languages, and
totk.ini.example and docs/controls.md describe it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 14:48:24 +01:00
Valiantsin DzerakhandClaude Opus 5.5 dde624e603 Skip a stale Recall / Ultrahand target and an unbounded model scene report row instead of crashing (#1005)
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>
2026-11-11 16:41:29 +03:00
jcleng 00a0ffc197 Ask fontconfig for the menu's CJK font instead of hard-coding five paths
plat_font_path stats five absolute paths for NotoSansCJK-Regular.ttc and takes the first that exists. That covers
SteamOS and the usual distributions, but misses any system where the font lives elsewhere, and fails outright in a
sandbox: under Flatpak /usr is the runtime and ships no CJK font, the app may only write /app, and the host's fonts
appear at /run/host/fonts. All five paths miss, fonts_up merges 0 fonts, and every Chinese character in the settings
menu renders as '?' while English stays correct.

Asking fontconfig fixes all of these at once. It is the same database Tk/Xft and every other Linux toolkit reads; it
knows /app/share/fonts, the XDG data dirs, /run/host/fonts and the per-user directories, so installing the font where
the system looks is enough and no packaging can leave the menu stranded.

libfontconfig is dlopen'd, not linked: a host without it (headless, a bare container) still builds and runs and takes
the fallback, so this adds no build dependency, and the runtime already links -ldl for the NVIDIA libraries. The
result is checked against the character before it is used, because fontconfig returns the closest pattern even when
nothing covers a character -- without that a Latin-only system hands back DejaVu Sans and the menu believes it merged
glyphs when it did not. The pattern names zh-cn and zh-tw rather than zh-hans and zh-hant, which is how Noto CJK and
fontconfig tag the faces.

menu_font_fontconfig defaults to 1 and 0 goes back to the five fixed paths, for a player whose fontconfig resolves to
a font the menu's parser cannot read. TOTK_MENU_FONT names a file directly and wins over both. A system with the font
where the old paths expect it sees no change, and Windows, whose font names are fixed, is untouched.

Verified against the real fontconfig with the host having no CJK font, with fontconfig pointed at a directory holding
only NotoSansCJK-Regular.ttc (the Flatpak case, now resolved), with TOTK_MENU_FONT set and pointing at a missing file,
with menu_font_fontconfig=0, and with libfontconfig made unloadable (falls back quietly, no crash).
2026-11-11 13:15:39 +00:00
Valiantsin DzerakhandClaude Opus 5.5 d8a1d14104 Merge task/optref: an invalid optional reference no longer crashes the game in main+0x1bd0138 / 0x1622bec, it is treated as absent (#1005)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 15:43:08 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1a033a4ec8 Apply the optref guard to 1.2.1 too, the same game code at main+0x1622bec (#1005)
1.2.1 has the identical cbz-then-load sequence, so set optref now patches both versions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 15:43:03 +03:00
Valiantsin DzerakhandClaude Opus 5.5 507e27da91 Treat an invalid optional reference at object +0x6b0 as absent on 1.4.3, so the random crash in main+0x1bd0138 stops (#1005)
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>
2026-11-11 15:26:26 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0fef33ce30 Merge task/pr1112: DLSS upscaling on 1.2.1 shows the whole picture, the game's own scaling draw is skipped after DLSS (#1112 by itaskaev2, #1106)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 14:42:34 +03:00
Valiantsin Dzerakh 346f22bbd4 Merge pull request #1112 into task/pr1112 2026-11-11 14:41:21 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a143cc1e6e Merge task/pr1087: grass_range, how far around the camera grass grows, off by default (#1087, #1085 by itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 13:53:25 +03:00
itaskaev2andClaude Opus 5.5 be5f4db3bf Skip 1.2.1's own scaling draw after DLSS instead of feeding it DLSS's picture (#1106)
On 1.2.1 the light target is scaled to the output by an upscaler of the game's own (twelve texelFetch taps,
fragment shader e6f7ae35b8479ef3), not by the FXAA draw vk_dlaa_skip_draw knows. It addresses its source in the
scene's pixels, so DLSS's output-sized picture swapped in for the light target (tex_info) showed only its top-left
part, two thirds at DLSS quality, stretched over the screen: the "floating camera" of #1106. #660 (169d057) made the
swap reach that draw: before it, DLSS ran on another target and its picture never reached the screen on 1.2.1.

DLSS already writes its picture into the scaling pass's target, so on 1.2.1 a draw in a pass larger than the light
target, without depth, that samples the light target is now skipped (vk_exec_draw_samples). The HUD drawn later into
the same target samples other textures and stays. 1.4.3 keeps the swap, where a tonemap can be the scaling draw.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 11:53:25 +01:00
Valiantsin Dzerakh 873fc64b41 Merge pull request #1087 into task/pr1087 2026-11-11 13:20:43 +03:00
Valiantsin DzerakhandClaude Opus 5.5 11c3ce1319 Merge task/kbmwave: T in the PC text prompts, opt-in mouse clicks on the map and in dialogue, the mouse wheel in menus, strips and the camera (#1098, #1096, #1097, #1092, #356, #62, #147)
Pull requests by lwj10case (#1098, #1096, #1097) and itaskaev2 (#1092); #1092's pointer image left out.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 13:18:29 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6576272a15 Leave the pointer image of pull request #1092 out: it changes the pointer for every player without a switch
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 13:13:22 +03:00
Valiantsin Dzerakh deba1a9b82 Merge pull request #1092 into task/kbmwave
# Conflicts:
#	runtime/input.h
#	runtime/menu_cursor.c
2026-11-11 13:12:21 +03:00
Valiantsin Dzerakh fc1cf24c42 Merge pull request #1097 into task/kbmwave
# Conflicts:
#	docs/controls.md
#	runtime/cfg.c
#	runtime/input.c
#	runtime/menu_cursor.c
#	runtime/ui/menu.cpp
#	runtime/ui_text.c
#	runtime/ui_text.h
#	totk.ini.example
2026-11-11 13:11:10 +03:00
Valiantsin Dzerakh 24bcc546e9 Merge pull request #1096 into task/kbmwave 2026-11-11 13:10:00 +03:00
Valiantsin Dzerakh 6ec533524c Merge pull request #1098 into task/kbmwave 2026-11-11 13:10:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f23dc9ffb2 Merge pull request #1101: a mod's file named for another game version is served under its own name, so a sound mod that ships one plays (xellow78-lgtm)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 13:08:04 +03:00
Valiantsin Dzerakh 05003d517d Merge pull request #1101 into task/pr1101 2026-11-11 13:06:28 +03:00
Valiantsin DzerakhandClaude Opus 5.5 725c76b213 Merge pull request #1108: escape the pipes that split two docs tables and unlink the missing docs/milestones folder (viwe-monai)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 13:04:54 +03:00
itaskaev2andClaude Opus 5.5 9577d31f8b Zoom the Purah Pad's camera with the mouse wheel
In the camera (the ability wheel's camera) each notch of the wheel is a 100 ms press of the D-pad's up (in, for a
turn away from the player) or down, the zoom its button guide shows. The camera is found by its open screens: the
Purah Pad's frame and CameraPointer_00 without AppMap_00, which the Scope has (menu_cursor_camera). The Scope has no
zoom of its own, so the wheel stays unbound there.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 10:23:19 +01:00
itaskaev2andClaude Opus 5.5 722a9c972a Describe the menus' dead zone and the pointer image in docs/controls.md
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 10:11:28 +01:00
viwe-monai 3360eca908 docs: escape table-splitting pipes and unlink the missing docs/milestones dir 2026-11-11 16:48:11 +08:00
itaskaev2andClaude Opus 5.5 c0ca89fdda Keep the wheel's focus until the pointer leaves a dead zone, and draw a pointer of our own
After the scroll wheel, the keys or the pad move the focus in a menu, the pointer takes it back only once it has
moved 6 layout units from where it was then (menu_cursor_poll), so a hand resting on the mouse no longer undoes a
scroll. While the cursor is not captured, the game window shows a gold arrowhead drawn at the window's DPI
(cursor_art.c) instead of the Windows arrow.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 09:44:01 +01:00
Louis JusticeandClaude Opus 5.5 9f17d7899d Turn map_click off by default, so each key presses one controller button unless the player opts in.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 19:54:30 -05:00
Louis JusticeandClaude Opus 5.5 b477b489ff Turn dialogue_click off by default, so each key presses one controller button unless the player opts in.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 19:54:10 -05:00
Louis JusticeandClaude Opus 5.5 34ee6684a9 In dialogue the left mouse button presses B and the right one A instead of their bindings (dialogue_click, game 1.4.3).
By default the left button is Y, which opens the dialogue log in a dialogue box. While MessageDialog_00 is open the
left button now presses B, which advances the text and shows the rest of a scrolling line, and the right one A.
Dialogue choices keep the menu pointer, where a left click picks the choice under it, so clicking through a
conversation does not pick the choice the focus starts on. The setting is live and independent of menu_cursor.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 19:38:43 -05:00
itaskaev2andClaude Opus 5.5 a10c546a06 Scroll with the mouse wheel in the game's menus and along the D-pad strips
The wheel did nothing outside the map. Now each notch is one step of the stick a gamepad player would move: in a menu
with the game's focus box (the inventory, shops, Options, the save list) the focus moves up or down, and while a D-pad
strip (weapons, shields, bows, materials) is held open the choice moves left or right. The strip has no focus box
while it is held, so it is found by its open screen, ShortCut_00, as the map is. The wheel now also counts while the
cursor is released over the window, where the menus have the pointer. Input scripts take WHEEL lines and a recording
writes them, and a script's one-shot MOUSE or WHEEL line goes in at the first poll at or after its tick instead of
being lost when a poll skips that tick.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 00:23:48 +01:00
Louis JusticeandClaude Opus 5.5 c2716d2e7c The keyboard and mouse text prompts show Y as T, and the setup draws the PC prompts from totk.ini's bindings.
Y has two default keys: the left mouse button, which is a menu's A while the pointer is shown, and T, which presses Y
everywhere. The button font (menu guides, the dialogue log) now shows Y as its first bound key that is not a mouse
button; the button guide in play and the action prompt keep the left button. The PC prompts are a setup step of their
own, keyed by the bind_ lines of the install's totk.ini, so running the setup again after rebinding redraws them
without preparing the shaders again.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:11:38 -05:00
Louis JusticeandClaude Opus 5.5 1becabd8f6 The left mouse button presses A on the Purah Pad's map instead of its binding (map_click, game 1.4.3).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 16:27:03 -05:00
Valiantsin DzerakhandClaude Opus 5.5 cc2b77bc4f Merge task/pr913: NVIDIA Reflex low latency, off by default, NVIDIA only (#913, #638 by STS78721, carried by itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 23:28:39 +03:00
Valiantsin DzerakhandClaude Opus 5.5 7fa727bbc5 Skip the present lock for the Reflex frame ID when nothing reads it, and declare the front end's Reflex calls in gfx.h
vk_reflex_present_frame took g_pl on every present although only flip_locked's VkPresentIdKHR (Reflex) and
latency_note (TOTK_TRACE=perf) read g_blit_pid. nvn_api_obj.c and ov_input.c declared vk_reflex_marker,
vk_reflex_frame_begin, vk_reflex_frame and vk_reflex_sleep locally; they now come from gfx.h, the graphics layer's
interface, which gfx_present.c also sees through vk.h, so a changed signature fails to compile. vk.h stays out of
those two files: it brings in Vulkan, VMA and vk_rec.h's vkCmd* macros.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 23:24:11 +03:00
Valiantsin DzerakhandClaude Opus 5.5 52b099bacb Merge pull request #913: NVIDIA Reflex low latency, off by default (#638 by STS78721, carried by itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 23:21:50 +03:00
Valiantsin DzerakhandClaude Opus 5.5 9f062e1d27 Merge task/pr864: tests/run_all.py runs every test with its interpreter, from pull request #864 (#675 by zzs181, carried by itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 23:08:43 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bb339a614d Import at the top of tests/run_all.py and list cheats_vm_check
json, shutil and tomllib were imported inside the functions that use them. cheats_vm_check came into dev after the
table was written; it compiles runtime/cheats.c with clang like mouse_direct_check, so it takes the same cc need.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 23:08:43 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8fc4d0a2d2 Merge pull request #864: tests/run_all.py, one entry point for the tests (#675 by zzs181, carried by itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 23:04:41 +03:00
toadjiangandClaude Opus 5.5 5e6ebd8bbc Free all DLSS size slots when the preset changes
evaluate's preset_dirty loop stopped at slot 3 of the five D.sizes entries, so a preset change left the features in
slots 3 and 4 created with the old model: they kept running until the slot was evicted. The loop now covers the whole
array through DLSS_SIZES instead of a literal.

Taken from pull request #1057 (t04dJ14n9) alone; the PR's dlss_prewarm commits are not in this change.

(cherry picked from commit a76bdf5e08)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 23:02:05 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1cbe7bdb79 Merge pull request #990: the AppImage shadow test refuses a venv interpreter instead of passing without the user site (jay23606)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 22:59:10 +03:00
Valiantsin DzerakhandClaude Opus 5.5 dd91d60ba3 Merge pull request #1075: unpack a release archive again when its pin changes (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 22:57:47 +03:00
Valiantsin DzerakhandClaude Opus 5.5 89de7b6c6e Merge pull request #1071: describe climb_fix in totk.ini.example (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 22:57:46 +03:00
Claude 2cc0a4eaa6 Serve a mod's file named for another game version under its own name instead of leaving it out
A mod file whose name carries Product.<n> and which the RomFS lacks was counted as made for another game version and
never served. The game does ask for such names: on 1.4.3 with mods on, the file trace (trace = fs) shows it opening
Sound/Resource/Pack_MasterSword.Product.110.bars.zs, while its RomFS holds only the Product.140 and the unversioned
file. A sound mod that ships its pack under all those names was silent here and works on a console, where LayeredFS
shows the game every file of a mod. Such files are now added overlays like any other new file. Another version's
resource size table is still not served and still lends its entries; the files are still counted, and the Mods tab
and docs/mods.md now say they are read only when asked for by name.

tests/mods_romfs_check.py gets a case for it. Not run here: the test and --probe-fs need a build and the game's files.
runtime/romfs.c compiles with llvm-mingw.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TgQM2zwuVagwScByEJhT8V
2026-11-10 14:32:15 -05:00
itaskaev2andClaude Opus 5.5 9680b8e6ec Add grass_range: how far around the camera grass grows
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>
2026-11-10 20:13:59 +01:00
Wes 5f6fc13712 Lift again only the chunks whose inputs changed
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.
2026-11-10 13:03:38 -06:00
ipavlin98 5956d6dd46 Unpack a release archive again when its pin changes instead of reusing the old archive's files 2026-11-10 21:08:37 +03:00
itaskaev2andClaude Opus 5.5 95052a280e List the tests added since, and the differential tests, in tests/run_all.py
The table predates exefs_patches_test and leaves out settings_doc_check, mouse_direct_check and tests/diff. A name may now name a script below tests/ (diff/simd), and a need of a compiler (cc, which mouse_direct_check passes as --cc) runs without --all, as only game files, a build, the embeddable Python and a desktop wait for it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:21:14 +01:00
zzs181 5635dd5e3a Let a test need more than one thing, and find the romfs where it actually lives
mods_romfs_check needs both a built totk.exe and the extracted romfs, and the romfs was hard-coded to build/extracted/<version>/romfs in two places inside the test. Needs now compose with '+' (exe+romfs) and each gets its own placeholder, the romfs is found in the extracted tree, the work dir or the GUI builder's record (build/build_gui.json), and any build/v143-*/totk.exe counts as the built exe - so the test runs on the layouts people actually build in instead of failing on a path it assumed. The test takes --romfs; its default is the old path, so running it by hand is unchanged.
2026-11-10 18:21:14 +01:00
zzs181 88cd32fddf Add tests/run_all.py: one entry point for the tests, each with its interpreter and needs
Each test already says in its header how it wants to be run; this reads that intent into one table (.venv for the lifter, .venv-py314 for the extraction tools) and runs them all:

    python tests/run_all.py                 # the ones that need no game files
    python tests/run_all.py --all           # also the ones that read game files or a built totk.exe

A need that cannot be met here is SKIP with the reason, never a failure: a missing game dump is not a broken build. Exit is 0 when nothing failed, 1 when something did. Windows picks clang up from C:/msys64/ucrt64/bin for the tests that compile C; on any other host the PATH is left alone. No third-party imports, so this runs before any venv is trusted.
2026-11-10 18:21:14 +01:00
itaskaev2andClaude Opus 5.5 6d6b66461b Reflex: one present ID per frame from its start to its present; mode again on a new swapchain; presentId feature
The latency markers and the present carried different present IDs: g_reflex_present_id went up only in flip_locked, so
frame k's simulation, input and submits had ID k and its present k+1 (and with frame_queue or replay_async frames could
share one). Each frame now gets its ID once, when the game acquires its window texture (SIMULATION_START,
vk_reflex_frame_begin), and carries it: INPUT_SAMPLE and SIMULATION_END take the game's current frame, a submission
the frame of the thread that submits it (the game thread's, or the one the replay thread got with its ReplayItem, or
the present thread's from its PresentJob), and the present the frame of its blit (PresentJob.pid -> g_flip_pid). A
present without a frame ID takes the next value, as present IDs must grow on a swapchain.

From the review: a new swapchain sets the sleep mode again (it starts with low latency off), Reflex is off without the
presentId feature, REFLEX sorted in known[], and the ru and pt-BR descriptions name the Boost option as the menu does.

TOTK_TRACE=perf logs every 600 presents the frame start to present time, and with Reflex on how many of the driver's
reports (vkGetLatencyTimingsNV) came back with every marker and their simulation start to GPU render end.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:20:16 +01:00
itaskaev2andClaude Opus 5.5 41623cec85 Call vkLatencySleepNV under the present lock
The swapchain must be externally synchronised, and the acquire and the present use it under g_pl on the present
thread while the game thread calls vk_reflex_sleep. With reflex = boost and TOTK_VK_VALIDATION=1 the validation layer
reported 20 threading errors in 30 s (vkLatencySleepNV against vkAcquireNextImageKHR and vkQueuePresentKHR). The
earlier head of #638 (318acd8) took the lock here; the rebase onto dev lost it. The semaphore wait stays outside.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:20:16 +01:00
itaskaev2andClaude Opus 5.5 c811d0e06d Carry Reflex's present ID through the recorder's submission
vk_sync_submit chains a VkLatencySubmissionPresentIdNV when the device has VK_NV_low_latency2, and on dev the
recorder thread (on by default except on AMD) makes that submission. rec_submit stopped the process on any pNext,
so every NVIDIA GPU with the extension would have failed at its first recorded submission. The recorder now copies
the present ID into its packet and chains it again in submit_run.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:20:16 +01:00
Tears of the SteelTemple 3209ea4358 Implement Native NVIDIA Reflex Low Latency (VK_NV_low_latency2)
- Enable VK_NV_low_latency2 and VK_KHR_present_id with present ID features
- Add VkSwapchainLatencyCreateInfoNV to swapchain creation
- Link present and submission IDs with standard Vulkan latency types
- Insert latency markers: simulation start/end, input sample, render submit, and present
- Gate all extensions and latency chains on reflex != off (RESTART setting)
- Log graceful notice when Reflex is requested on unsupported hardware
- Add UI menu setting and translations for en, ru, pt-BR, zh-Hans
- Document reflex setting in totk.ini.example and docs/settings.md
2026-11-10 18:20:16 +01:00
itaskaev2andClaude Opus 5.5 2a564f648c Describe climb_fix in totk.ini.example
tests/settings_doc_check.py failed on v0.4.0: CLIMB_FIX is in known[] and described in neither file. It is a player
setting with a menu toggle under [frame rate], so it goes next to highfps_fix; frame_rate.c turns it off without the
real-time step.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:11:32 +01:00
Valiantsin DzerakhandClaude Opus 5.5 7a37fc3c34 Up version 0.4.0
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 19:25:38 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bb8b4b1797 Turn the recorder thread on by default on AMD GPUs too; vk_recorder = 0 turns it off where the device is lost
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 19:25:37 +03:00
Valiantsin DzerakhandClaude Opus 5.5 396c4ae621 Describe the profile-guided build in docs/pgo.md: where and how to train, free play, merge, measure
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 19:07:38 +03:00
Valiantsin DzerakhandClaude Opus 5.5 27a63dfb0f Merge pull request #1065: Xbox prompts at every game resolution the setup lays the UI out for (cdonatom, #378)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:59:22 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6f6704640a Merge pull request #1066: describe deswizzle, kspin_us, pcore, rec_async and rec_spin_us in docs/settings.md (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:55:58 +03:00
Valiantsin DzerakhandClaude Opus 5.5 574c1ecc49 Merge task/climb: Link climbs walls and ladders at full speed above 60 fps (#35, #276, #1001)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:46:30 +03:00
Valiantsin DzerakhandClaude Opus 5.5 06811330e7 Extend the climb controller's frame-rate factor above 60 fps, so Link climbs walls and ladders at full speed (#35, #276, #1001)
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>
2026-11-10 18:44:18 +03:00
itaskaev2andClaude Opus 5.5 e8fd6fd7a5 Describe deswizzle, kspin_us, pcore, rec_async and rec_spin_us in docs/settings.md
tests/settings_doc_check.py failed on dev with these five names in known[] and described nowhere. The rows follow the
code: vk_deswizzle.c (TOTK_DESWIZZLE), kernel.c kspin_ns, main.c (rt_knob PCORE), vk_rec.c rec_submit and rec_main.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 16:28:21 +01:00
Valiantsin DzerakhandClaude Opus 5.5 be7c27047a Keep the 4096-a-side scene of an output near 8K under the new heap bound
The heap bound in scene_for counts the output's own growth against the 2 GiB limit, so a 7680x4320 output at
render_scale game went from the 4096x2304 scene dev renders to 2712x1526, with no setting changed. The bound now
shrinks no scene below 4096 a side, the size dev gave; scenes the 4096 cap kept smaller still grow up to the bound.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:20:31 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1c1ff975f3 Default dynamic_res to 1 so the game keeps its own dynamic resolution
With dynamic_res at 0 by default the fixres set held the scene at 100 % for every player, the reason #573 was turned
down. The default is now 1, so the set stays off unless a player turns dynamic resolution off in the menu or
totk.ini, and the Steam Deck profile no longer needs its own entry.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:20:31 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b6738cf41b Merge pull request #916: dynamic resolution as a setting, on by default, and a scene past 4096 wide (#573 by ProSep, carried by itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 18:20:31 +03:00
Valiantsin DzerakhandClaude Opus 5.5 dfc0b57457 Keep the per-frame pass table's comment to what the code does
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 17:59:54 +03:00
Valiantsin DzerakhandClaude Opus 5.5 173462f33d Merge pull request #1040: keep the targets a frame renders in the per-frame pass table, so draws with a pipeline still building skip a frame instead of waiting 50 to 400 ms (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 17:59:53 +03:00
Valiantsin DzerakhandClaude Opus 5.5 3e037f0044 Keep the shadow log of players without sync_ahead as it was, sort the new setting names, and fix the sync_ahead frame-time sentence
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 17:55:57 +03:00
Valiantsin DzerakhandClaude Opus 5.5 b2db7809b4 Merge pull request #917: let the game run one frame further ahead of the GPU, sync_ahead, off by default (#676 by ProSep, carried by itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 17:55:23 +03:00
Carlos DonatoandClaude Opus 5.5 fb34177cfd Make the Xbox prompts for every game resolution the setup lays the UI out for (#378)
The setup wrote romfs-patches-xbox and romfs-patches-xbox-label for 16:9 only, so prompts = xbox on a 21:9, 32:9,
16:10 or 3:2 screen (the Steam Deck's 1280x800 among them) kept the game resolution at 1920x1080 (cfg.c) or, with
output_res set to the screen's shape, fell back to the Switch prompts. #979 fixed this for prompts = pc; this extends
the same mechanism to both Xbox folders, the shared-files option of #378 by way of #979's --reuse.

- The setup builds romfs-patches-xbox-<w>x<h> and romfs-patches-xbox-label-<w>x<h> for each of ASPECT_SIZES, from
  their 16:9 folder with --reuse, as it does for romfs-patches-pc-<w>x<h>.
- romfs.c overlay_init: at a game resolution of another shape any prompts' folder loads from <folder>-<w>x<h> in place
  of romfs-patches-<w>x<h>, not only the PC one; without it the Switch prompts stay, and the log names the missing
  folder and the command that makes it. romfs_shaped_pc_ready becomes romfs_shaped_prompts_ready(folder, w, h).
- cfg.c: the display-shaped output_res default applies with prompts = xbox when the folder of the pad layout
  (romfs-patches-xbox with the Nintendo layout, romfs-patches-xbox-label with any other) is there for that size.
- The menu's note for a missing shaped folder reads "off at this game resolution (no layout made for it)" in every
  menu language, since 16:9 is no longer the only shape with prompts.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 15:53:49 +01:00
Valiantsin DzerakhandClaude Opus 5.5 8da13aa9b4 Merge pull request #1006: stop the installer space check at an unavailable drive root (Luxury213)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 17:43:41 +03:00
Valiantsin DzerakhandClaude Opus 5.5 719196f183 Merge pull request #1061: let a validation run with DLSS finish, a valid OpSelect in the motion fragment shader and set 1 bound first for the motion draws (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 17:43:41 +03:00
Valiantsin DzerakhandClaude Opus 5.5 fce6364236 Merge pull request #1060: take the feedback-layout images back to GENERAL before the contact shadows' march (itaskaev2)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 17:43:40 +03:00
jay23606 bbd63f9720 Address review feedback 2026-11-10 09:24:56 -05:00
itaskaev2andClaude Opus 5.5 0adcc96bae Bind the motion draws' set 1 before pushing set 0 under the validation layer, as the replay's draws do
vk_mvobj_execute's draws (mo_emit) push set 0 and then bind set 1. Under the validation layer (SDK 1.4.363) a push for
a new INDEPENDENT_SETS layout keeps the push set the layer made for an earlier layout (the replay's last draw) and drops
the writes to bindings that layout lacks: every run with DLSS and validation reported the last-frame banks as missing
(VUID-vkCmdDrawIndexed-None-08114, variable vp_c20) and then faulted inside VkLayer_khronos_validation.dll. The
replay's own draws avoid this by binding set 1 first (set1_first in bind_descriptors); the motion draws now do the
same, only while the layer is active.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 15:11:08 +01:00
itaskaev2andClaude Opus 5.5 f804facd8b Take the feedback-layout images back to GENERAL before the contact shadows' march
vk_contact_exec ended the pass and recorded a memory barrier only. Once a G-buffer draw samples the linear depth or the
scene colour in its own pass, those images stay in ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT across passes
(vk_exec_draw.c, feedback loops), and the march then bound them in GENERAL as a sampled and a storage image. The Vulkan
validation layer reported it on every frame with contact shadows on (vkCmdDispatch imageLayout-00344, followed by
barrier, BeginRendering and QueueSubmit layout errors: 40 per run at Lookout Landing, 0 with contact_shadows = 0).
vk_exec_barrier ends the pass and moves those images back to GENERAL in the same full barrier, as every other
barrier does.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 14:59:34 +01:00
itaskaev2andClaude Opus 5.5 708e0cfe8d Give the per-object motion fragment shader's OpSelect a condition vector, as SPIR-V 1.0 needs
tools/make_mvobj_fs.py assembled OpSelect of a vec4 with a scalar bool condition, which only SPIR-V 1.4 and later
allow. The module is 1.0, so spirv-val in the Vulkan validation layer rejected it (Expected vector sizes of Result Type
and the condition to be equal: Select). The condition is now splatted into a bvec4 first; runtime/vk_mvobj_fs.h is
regenerated and passes spirv-val.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 14:59:31 +01:00
Valiantsin DzerakhandClaude Opus 5.5 7f82a52da8 Merge task/gears: gear doors open above 30 fps on 1.2.1 (#330, #984)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 15:36:35 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6433550e3d Scale the 1.2.1 gear rotation threshold by the AI update's frame delta, as 1.4.3 does (#330, #984)
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>
2026-11-10 15:35:16 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1503b17f7d Merge task/crash705: list the compound physics shape's children in the crash report (#705)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 10:20:07 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4c4bd8c67a List the compound physics shape's children in the crash report for the 1.2.1 fault after the material lookup (#705)
On 1.2.1 the game asks a compound physics shape for its first child's material at main+0xe056d0 and reads the result
without a check. At the reported crash the shape had none of its 125 children left, although every child is filled
when the shape is built. The crash handler now prints that shape's live bits and each record's shape pointer and name,
which tells removed children from switched-off ones and names the object. It runs only after the crash.
--probe-kernel builds a fake shape in a crashing child and checks the listing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 10:19:50 +03:00
shenjack 41899438ea Merge remote-tracking branch 'origin/dev' into pr/v110-patch-parity 2026-11-10 14:25:07 +08:00
Valiantsin DzerakhandClaude Opus 5.5 3d386fe37e Merge task/inteluhd: dynamic alpha to coverage and vertex input off by default on Intel's Windows driver for integrated GPUs (#970, #992)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 09:13:52 +03:00
Valiantsin DzerakhandClaude Opus 5.5 905e2e720d Turn dynamic alpha to coverage and dynamic vertex input off by default on Intel's Windows driver for integrated GPUs (#970, #992)
UHD Graphics (i3-1215U, i3-1305U) and Iris Xe drew coloured noise on foliage with dynamic alpha to coverage and black
patches over the scenery with dynamic vertex input; players confirmed that vk_dyn_a2c = 0 and vk_dyn_vertex = 0 clear
both. vk_caps.intel_igpu_win marks Intel's proprietary Windows driver on an integrated GPU, and both defaults follow it.
An explicit ini value still wins. Arc discrete GPUs and Mesa's ANV keep both on: no report there, and the ANV report
(#989) had both off with its glitch still present.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 09:01:54 +03:00
Valiantsin DzerakhandClaude Opus 5.5 729b00a1c0 Merge task/sdl3420: ship SDL 3.4.20 in the release for pads without motion calibration (#912)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 08:58:32 +03:00
Valiantsin DzerakhandClaude Opus 5.5 2fe1ea1716 Bump the bundled Windows SDL to 3.4.20 (#912)
SDL 3.4.20 uses default Switch controller stick and IMU calibration when the
pad has none, which fixes the infinite gyro readings on the Beitong Asura 2 Pro+.
The pins in tools/make_release.py (version, zip and devel sha256, SDL3.dll sha256)
and the Windows rows of THIRD_PARTY_NOTICES.md follow. The sniper sysroot row stays.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 08:53:49 +03:00
shenjack ec62494bd9 Merge remote-tracking branch 'origin/dev' into pr/v110-patch-parity 2026-11-10 13:39:41 +08:00
Valiantsin DzerakhandClaude Opus 5.5 32f86a3296 Merge task/cheatc0: run cheat opcodes C0-C3 in the data cheat VM (#973)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 08:07:24 +03:00
Valiantsin DzerakhandClaude Opus 5.5 14b1b1aece Run cheat opcodes C0-C3 in the data cheat VM (#973)
The VM refused C0 (register conditional), so cheats like C046B400 FFFFFFFF were greyed out as unsupported. C0 now
runs with dmnt's operand types 0-5, widths and conditions; C1 and C2 save, restore and clear registers, C3 moves
registers to and from the static registers. tools/cheats.py gives the same opcode lengths and accepts the same opcodes.

skip() took the end of a nested block at depth 1 for the else of the failed outer block; it now counts depth the way
dmnt does, and 2x000000 is an else only for x = 1.

tests/cheats_vm_check.py runs tools/cheats.py and runtime/cheats.c on cheats of its own, the two from the issue
included.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 08:05:01 +03:00
ipavlin98 a4b46fa7a9 Keep the targets a frame renders in the table that tells per-frame passes from one-shot ones
The table of the frames each target was last rendered into was direct-mapped with 1024 entries. In a 1.4.3 field run about 16 entries rendered the frame before were taken by another subresource each frame, the scene's colour target among them, so every draw there whose pipeline was still building waited for it as one-shot, 50 to 400 ms, instead of skipping a frame. Sets of 8 ways that evict the way rendered longest ago lost none in the same run.
2026-11-09 21:22:38 +03:00
Valiantsin Dzerakh 8aba3647e0 Up version 0.3.14 2026-11-09 19:57:07 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0238f3069a Merge task/pgostale: warn when a PGO profile was trained with other runtime headers
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 18:50:36 +03:00
Valiantsin DzerakhandClaude Opus 5.5 2d2c6782af Record the runtime headers a PGO profile was trained with and warn when they change
The floating-point helpers in simd.h and simd_fp.h inline into every lifted function before llvm-profdata matches
the profile, so the fpcheap change left pgo-v143 with a fifth of its weight while recomp/ stayed the same and
make_release saw nothing. pgo.py merge now reads the instrumented build's Ninja deps log and stores the digests of
the runtime/ headers the generated objects include (cpu.h, simd.h, simd_fp.h); make_release warns when one differs
or a record has none. docs/building.md says to retrain after a change to those headers, and build_game.py names the
libiconv-2.dll that MSYS2's SDL3.dll needs in deps-mingw/bin.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 18:50:36 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bdcfb42c07 Add contributor and agent guides for pull requests, running and debugging
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 14:44:59 +03:00
Valiantsin DzerakhandClaude Opus 5.5 f9ed079614 Merge task/handheldscene: render the handheld scene at the asked size on 1.4.3
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 14:38:44 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bed6962e09 Render the handheld scene at the asked size on 1.4.3
1.4.3 scales the scene size it reads from the patch page by canvas width over the console mode's base width, which is
1280 in handheld, not 1920. A handheld 1280x720 output at render_scale 100 put 1920x1080 on the page, so the game
rendered a 1920x1080 scene while the DynamicTextureAllocator heap was sized for 1280x720, and heavy scenes ran it out
(crash at main+0x1c2590). scene_scale now uses the mode's base for res_init and res_dlss_mode. In handheld the game
composes a 1280x720 canvas unless the output patch is on, so the output patch is switched on with the scene patch there
and the canvas is the output the factor and the heap assume. Docked is unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 14:38:03 +03:00
itaskaev2 59eb026bd7 Merge branch 'dev' into carry/dynamic-res-100 2026-11-09 09:55:24 +01:00
itaskaev2 2e5d59df83 Merge remote-tracking branch 'origin/dev' into carry/sync-ahead
# Conflicts:
#	docs/architecture.md
#	runtime/cfg.c
#	runtime/vk_sync.c
2026-11-09 09:54:45 +01:00
Valiantsin DzerakhandClaude Opus 5.5 34b39ceca0 Merge task/memcommit: take 64 MiB blocks from the driver for buffers and other images
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 11:08:31 +03:00
Valiantsin DzerakhandClaude Opus 5.5 29cb79086f Take 64 MiB blocks from the driver for buffers and other images
Since the textures moved to a pool of their own, the default device-local
blocks hold mirrors and other buffers. With VMA's 256 MiB blocks one block
held 53 MiB of them after 10 minutes in the field, and the headroom thread
kept half a block of each device-local type ahead. TOTK_VMA_BLOCK_MIB
(default 64, 0 = VMA's 256) sets the size; the headroom spare follows it.

On the RX 9070, 10 minutes in the field: VMA blocks 3582 -> 3252 MiB,
process commit 8614 -> 8327 MB, slow frames 13 (2.8 s) -> 9 (1.1 s).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 10:51:49 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a78268935a Merge task/memcommit: wait out a short out-of-memory spell instead of ending the game
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 10:15:50 +03:00
Valiantsin DzerakhandClaude Opus 5.5 cf44e9013c Merge task/memoom: wait out a short out-of-memory spell instead of ending the game
Conflicts: the image retry goes through vk_texture_image, sweep_pressure keeps the released-texture cap on the new
drop helpers, and vk_headroom_release also frees the texture pool's anchor.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 10:12:55 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4ea472e864 Merge task/memcommit: textures in a pool of their own with 64 MiB blocks
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 10:11:51 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8e05d2b409 Give textures a pool of their own with 64 MiB blocks
Textures shared the default 256 MiB blocks with the mirrors and other buffers, and a block went back to the driver
only once everything in it was gone. On the RX 9070 after a few minutes of roaming the field, 3 of 9 device-local
blocks were 13-27% full, held by a hundred small textures and buffers each, and blocks held 0.8-1.4 GB more than their
allocations; where device memory takes process commit, that commit backs nothing.

Own-memory textures now go to a VMA pool with 64 MiB blocks (TOTK_TEX_BLOCK_MIB, 0 = the default pools). Images of a
quarter block or more, images the driver wants a dedicated allocation for, and images the pool's memory type does not
take get memory of their own; the requirements are read before the image is made, since VMA checks neither for a
custom pool. The headroom thread keeps the pool's next block ahead like the default pools'.

Same 10-minute route: 807 MiB of blocks beyond their allocations instead of 1037, most pool blocks 75-100% full, slow
frames not up. Probes pass on v143.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 10:11:44 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a79ff17314 Merge task/memcommit: count device memory against system memory where it takes process commit, BC3 for ASTC on integrated GPUs, cap the released-texture cache by bytes
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 09:58:10 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0005c01cf5 Remove the stray brace in vk_mem_census that stopped vk_memory.c from compiling
79c6951 left the closing brace of a debug block in the per-heap loop, so the function ended early and the build failed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 09:57:32 +03:00
Valiantsin DzerakhandClaude Opus 5.5 34b340a208 Cap the released-texture cache by bytes
Released textures stayed until 2048 of them were kept or VRAM passed 90% of the budget. On the RX 9070 a 10-minute
field run kept 818 MiB of them, while almost every take-back came within a second. TOTK_TEX_RELEASED_MIB (default
256) runs the same drops as under VRAM pressure while the released entries hold more own memory than that. On the
same route the run ended with 1.1 GB less process commit and 1 GB less in VMA blocks; 15 dropped textures were
created again and the slow frames did not change.

Also documents TOTK_MEM_RESERVE_MIB.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 09:57:32 +03:00
Valiantsin DzerakhandClaude Opus 5.5 213bc6af6a Wait out a short out-of-memory spell instead of ending the game
Crash logs ended in fatal errors when the system's commit ran out for a moment: a staging buffer (-2), a guest commit
with the system at 24442 of 24447 MB, image creation (-2). Windows grows a system-managed page file and some drivers
charge device memory to the process commit, so the same request often succeeds a moment later.

oom.c holds the wait nvn_api_cmd.c realloc_wait already used: it requests a release, retries every 10 ms for up to
30 s, logs the first 8 with the commit numbers. rt_oom_request sets a flag that vk_texture_new_submit takes (one atomic
load per submit): it drops up to 256 released textures of the two kinds sweep_pressure drops (overwritten, clean
mirrored), never GPU-written content, and frees the headroom blocks. vk_oom_release does at once what needs no submit:
headroom blocks, finished upload batches and deferred objects.

- memory.c commit: waits and retries without frz_lock between tries; every caller waits, boot ones too.
- vk_staging and the draw-data chunks (vk_exec_draw.c scratch): release, then wait; the open upload batch is not
  submitted, its caller still records into it.
- create_tex: release and one retry; no wait under the texture lock, the texture is asked for again at its next use.
- the texture write-back buffer: release, then wait.
- the headroom thread keeps no spare block for 30 s after a failure.

TOTK_TEST_OOM=<site>:<n> (commit, staging, image, chunk) fails the first n attempts; probe-kernel forces 3 refused
commits, probe-vkexec 2 staging buffers, 1 image and 1 chunk, and both pass through them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 09:53:30 +03:00
Valiantsin DzerakhandClaude Opus 5.5 5e479f593b Remove the stray brace in vk_mem_census that stopped vk_memory.c from compiling
79c6951 left the closing brace of a debug block in the per-heap loop, so the function ended early and the build failed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 09:51:04 +03:00
Valiantsin DzerakhandClaude Opus 5.5 79c6951688 Measure whether device-local memory takes process commit instead of assuming it per vendor
c838d96 counted system memory for every discrete GPU but NVIDIA's, an assumption. An RTX 5080 log (#398) showed 10.4 GB
of process commit at frame 1200, about what the RX 9070 holds with its VRAM counted, and the RTX 3060 Ti in #670 ran
out of system commit (17.8 GB) at 4K with its VRAM full. vk_mem_host_probe now allocates 128 MiB of device-local memory
once after device creation and compares the process commit before and after; half the size or more turns the system
memory cap on. The log line carries the measured amount, so user logs show what each driver does.

RX 9070: "a 128 MiB device-local allocation took 128 MiB of process commit".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 09:39:54 +03:00
Valiantsin DzerakhandClaude Opus 5.5 a689922180 Decode ASTC to BC3 by default on integrated GPUs
The size rule for TOTK_ASTC_BC looked at the largest device-local heap only. On an integrated GPU that heap is system
RAM reported as VRAM (10.6 GiB on the Ally X, 14.9 GiB on the 880M), so RGBA8 stayed on exactly where memory is
shortest. vk_mem_uma() now turns BC3 on there as well.

7900X iGPU, field save, same exe, frame 1800: RGBA8 commit 7047 MB, GPU 49-53 ms, 16.8-18.4 fps; BC3 commit 6155 MB,
GPU 42.6 ms, 21.6-21.8 fps.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 09:20:09 +03:00
Valiantsin DzerakhandClaude Opus 5.5 d8090a85fe Keep headroom blocks for device-local memory types only
Headroom woke for every memory type that got new device memory, the staging pool's own 64 MiB blocks included, and
then kept a 256 MiB spare block in that type's default pool. On the RX 9070 the default pools of host memory types 1
and 3 held 4 MiB, beside 512 MiB of spare blocks. Textures and mirrors, whose block allocations headroom moves off the
render thread, live in device-local types.

RX 9070, field save, 60 s: heap 0 VMA blocks 192 MiB instead of 704, driver usage 1384 MiB instead of 1896; 60 fps,
1% low 51.9.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 09:05:09 +03:00
Valiantsin DzerakhandClaude Opus 5.5 c838d9692f Count system memory in the device-local budget where device memory takes host memory
The paths that give memory back under pressure (headroom's spare block, released textures, pool mirrors) watched the
Vulkan heap budget only. On a UMA GPU that budget is gigabytes of the same RAM the game runs in, and on Windows the
AMD driver charges device-local allocations to the process commit one to one (RX 9070: VRAM use and private bytes
grew by the same 1164, 256 and 256 MiB). Crash logs show the result: the process at 4.4-10.5 GB of commit, 16 GB
machines at 80-94% RAM, std::bad_alloc inside amdvlk64.dll (#285), allocation failures on Intel UHD.

vk_mem_host_room (vk_memory.c) is what the system can still give beyond a reserve (TOTK_MEM_RESERVE_MIB, 1536):
commit, and on a UMA GPU physical memory too; Linux overcommits, so there only a UMA GPU's available memory counts.
NVIDIA is left out, not measured. vk_mem_vram caps the budget at use plus that room, and headroom keeps its spare
block only while four blocks fit in it.

RX 9070, field save, 60 s with the room near zero from the start (TOTK_MEM_RESERVE_MIB=21000): commit 7124 MB instead
of 8965, VRAM 2631 MiB instead of 3781, released textures 153 instead of 1866; mirrors refused for 423 MiB of pools,
GPU 4.45 ms a frame instead of 3.34 ms, 60 fps either way. Without pressure nothing changes. The census logs the
room, the device class line the mode.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 09:02:36 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6e9ca1ebfd Log the process commit in crash reports and in the memory census
A driver that runs out of memory faults or throws std::bad_alloc instead of returning an error: #285's log shows
bad_alloc inside amdvlk64.dll under gpl_link, and nothing in the report told that apart from a driver bug. The crash
report now prints the process and system commit, as rt_fatal does for our own failed allocations; --probe-kernel
checks the line.

The census at frames 600 and 1800 logs the commit as a baseline and, per heap, VMA's blocks and allocations beside
the driver's usage and budget, so a report shows whose memory grew.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 08:53:57 +03:00
Valiantsin DzerakhandClaude Opus 5.5 717e68f601 Merge task/crashinfo: crash reports carry host registers, code bytes and memory at the register values
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 08:20:01 +03:00
Valiantsin DzerakhandClaude Opus 5.5 06d70d0dfa Report host registers, code bytes and memory at a crash
The crash report named the lifted function and printed the guest registers, but the lifted code keeps guest
registers in host locals and writes them back only at calls, so the dump showed stale values and the faulting
instruction stayed unknown. Logs from #1005, #967 and #998 could not be traced further than the function.

The report now adds the x86 registers of the faulting thread (Windows and Linux), 64 bytes of machine code around
rip with the offset into the lifted function, so the instruction can be found in a local build of the same version,
64 bytes of memory around every register value that points at readable memory, and the first 128 bytes of the
guest stack. --probe-kernel checks the new lines with a child that faults with known values in rbx and x19.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 08:19:31 +03:00
Luxury 2907f4efc3 Stop the installer space check at an unavailable drive root 2026-11-08 23:09:58 -05:00
shenjack 68b918933f Check every SIMD register for integer-only patch preservation 2026-11-09 09:13:09 +08:00
shenjack d2b1c084fa Keep the texture offset attribution in the component table 2026-11-09 08:59:35 +08:00
shenjack c8eb315c1e Describe 1.1.0 field of view support and strengthen patch preservation checks 2026-11-09 08:44:44 +08:00
shenjack 89364414ea Check the 1.1.0 patch contracts and document their coverage 2026-11-09 08:39:10 +08:00
shenjack 6966cee0d4 Bring the core frame and camera patches to game 1.1.0 2026-11-09 08:37:24 +08:00
Valiantsin DzerakhandClaude Opus 5.5 7e440be7ca Merge pull request #978: draw amiibo file names in any script in the F1 menu (KyokoMiki)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 21:13:04 +03:00
Valiantsin DzerakhandClaude Opus 5.5 e17a27acba Merge pull request #623: report heap corruption from the vectored handler (ipavlin98)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 21:13:04 +03:00
Valiantsin DzerakhandClaude Opus 5.5 35968c1efb Merge pull request #990: Linux AppImage: ignore the user site-packages so installer.gui imports (jay23606)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 21:13:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 169d057add Merge pull request #660: keep DLSS off the inventory screen (mictony6)
Ported onto vk_dlaa_plan (#794): the scene end in the inventory also records its submission and op (end_fence,
end_pos) so chunked replays see it at the same point. DLSS-only: everything sits behind dl_active().

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 20:50:18 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0704543249 Merge pull request #947: sync shadow pools from the per-submission write-watch snapshots (corne-ac)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 20:41:23 +03:00
Valiantsin DzerakhandClaude Opus 5.5 bdb41dff7e Merge pull request #979: PC prompts for every game resolution the setup lays the UI out for (Wintego)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 20:36:02 +03:00
Wintego 62b8e9dee5 Draw the PC prompts' Shift as an arrow over its name
The arrow alone read as a direction (review of #585). The key keeps the width of the game's own glyph, so the name goes
under a solid arrow rather than on a wider key.
2026-11-08 20:35:55 +03:00
Valiantsin DzerakhandClaude Opus 5.5 5e56bfc7f3 Merge task/chunked: record large submissions in chunks on several threads (#628, #794), off by default
replay_workers stays 0. On the 7900X 4 threads cut the replay by a quarter (town 6.7 -> 5.0 ms, fight2 5.3 -> 3.9 ms)
with no fps change: the game's own threads bound the frame there. Weak CPUs may gain.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 20:24:08 +03:00
Valiantsin DzerakhandClaude Opus 5.5 35b3d37ea3 Make a chunk's new texture entries follow replay order, and add a knob that records chunks out of order
entry_of decides at record time whether a new texture takes the content of a live GPU-written texture at its storage
(alias_copy) or the storage bytes. In a chunked replay the source's GPU ownership is set when a chunk records its
render, so the choice followed the order the threads got to the chunks: a later chunk could take the old bytes before
an earlier chunk recorded the render, and a mirrored texture keeps them. Now a chunk that makes an entry while a live
colour texture of its size sits at the storage waits until the chunks before it are recorded (vk_exec_chunk_settle,
the texture lock released for the wait), skips sources the scan revives at a later op, and ignores GPU ownership a
later chunk set in this submission. slot_resolve and vk_texture_by_id_locked no longer read tslots through a pointer
taken before the wait.

TOTK_REPLAY_SKEW_US (debug) makes the even chunks wait before they record, so the chunk after each one records
first in every submission. With it at 3000 us and 4 threads the field save runs clean (grass drawn, 0 validation errors); the alias path
did not fire there (0 copied, 0 filled from storage), so this does not reproduce the missing grass reported on
RADV, and the fix there stays unconfirmed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 19:53:12 +03:00
jay23606 9d07157b3e Linux AppImage fails with "No module named installer.gui" when the PyPI 2026-11-08 11:45:21 -05:00
ipavlin98 fd4427cb17 Run DLSS on the chunked replay
DLSS kept the replay on one thread: its decisions follow the passes in replay order, its jitter and camera are noted
draw by draw, and its evaluation reads the per-object motion list the scene's draws build. Now the scan takes DLSS's
decisions on its own state (vk_dlaa_plan, split out of vk_dlaa_pass) and notes the scene camera in replay order
(vk_dlaa_scan_draw), and the copy of the lit scene and the evaluation are records of the chunk that holds the op
(vk_dlaa_exec). A chunk's draws are jittered while they come before the op the scan ended the scene at. The
evaluation waits until the chunks before it are recorded, and the chunks after it wait for it (a hold), since they
sample its output. Chunks note their draws for the per-object motion one at a time (mo_lock in vk_exec_draw.c); the
uniform overrides of a motion draw and shader_for's last-frame variant flag are per thread, as the other chunks' draws
go on meanwhile; the FXAA shader table takes concurrent lookups. fxaa = 0 runs in chunks too.

With dlaa = 1 at 4K (DLSS Quality) on 1.2.1 and an RTX 5070, replay_workers = 4 takes the frame rate from 70 to 78
fps where the CPU is the limit, with no one-frame glitch in 241 consecutive frames.

(cherry picked from commit 04f8bb1b57)
2026-11-08 19:39:18 +03:00
ipavlin98 6b4d84ec50 Record large submissions in chunks on several threads
replay_workers = N (0, the default, keeps the sequential replay) records a submission of enough draws in chunks that start between passes, on N threads and in twice as many chunks, and submits them in order. In the town at 4K on an RTX 5070, 4 threads take the replay from 8.2 to 4.5 ms a frame and the frame rate from 71 to 79.

A sequential scan on the submitting thread applies only what is queue state (fixed-function and bind ops, render targets, render enable and conditions, samples-passed counting) and keeps a copy of it where each chunk starts, with how far its lists got: inline uniform updates, RENDER_COND results, contact shadow marches and the ops that drop uniform copies. A chunk takes those from the lists instead of from the chunks before it, starts with every image in GENERAL and ends with a full barrier, so its recording depends only on the copy and the lists.

Each thread records with a context of its own: the replay's memos, descriptor state, occlusion query segments and per-command-buffer state moved from file statics into VkExec and VkExecDraw, and the tables the contexts share (stand-ins, depth twins, views, mirrors, timestamps, completion callbacks, crumbs) take locks or atomics. The scan makes render targets live in replay order and notes the op (vk_texture_revive), since a chunk can sample a storage before the chunk that renders it got there or after the scan went past a later target there: a chunk's texture slots resolve as of its own op, and the chunks after a texture with no entry yet wait for the chunk that makes it. Uniform copies are dropped at the op that writes them (vk_usnap_drop_at).

Contact shadows plan their march in replay order (vk_contact_plan) and the chunk that holds its op records it; the HDR source keeps the copy that comes last in replay order. DLSS and fxaa = 0 act on the frame draw by draw and keep the replay sequential. TOTK_REPLAY_STATE_CHECK=1 compares the state after the last chunk with the scan's.

A draw or dispatch whose shaders write storage buffers drops the uniform copies they cover from its own op on, as the other GPU writes do (scan_writes). The scan still translates no shader: it reads the shaders the recording contexts translated from a table shared with them (vk_exec_draw_writes), and an op whose shader no context translated yet holds the chunks after it until it is recorded. Before, the chunk that recorded such a write dropped the copies for every position at that moment, so a later chunk recorded first bound the copy taken at the submit call: on an RX 7800 XT on RADV the grass near the camera came out dark or unshaded in some runs with 4 threads.

TOTK_TRACE=perf counts the chunks held per submission by reason and logs when each chunk of the last submission began. The settings menu has the thread count under Advanced, Scheduling, with the count this run uses under it.

The recorder thread begins, ends and submits the submission's open part (vk_rec.c rec_end_cb), so a chunk's mirror prologue stays off it: vk_sync_part waits until the recorder is idle, as the part pool allows one thread at a time, then records, ends and submits the prologue itself. Through the recorder the prologue could reach the queue before it was ended, and the GPU lost the device at the title screen.

(cherry picked from commit b94e2e9642)
2026-11-08 19:39:17 +03:00
Valiantsin DzerakhandClaude Opus 5.5 4fcedda5e6 Merge task/fpcheap: cheaper FPCR checks in the FP helpers
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 16:03:20 +03:00
Valiantsin DzerakhandClaude Opus 5.5 922edb177d Cheaper FPCR checks in the FP helpers
FCMP and the vector compares no longer flush denormal operands under FPCR.FZ: rt_fpcr_sync keeps MXCSR.DAZ equal to
FPCR.FZ, and x86 compares under DAZ read a denormal as a zero of its sign, as ARM does under FZ. The directed RMode
check of FN(op) and FN(vop) moved into the result check's branch, and min/max skip it, since they do not round.

Hot lifted functions shrink by about 10% of their x86 instructions; the town camera-pan bench (1080p, two runs each)
goes from 10.25 to 9.78 ms per frame. simd.py (60000 encodings), lift.py and func.py report 0 failures.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 16:03:14 +03:00
Valiantsin DzerakhandClaude Opus 5.5 31630dee65 Merge task/vbbind: rebind only the vertex streams a draw reads that changed (#974)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 14:01:38 +03:00
Valiantsin DzerakhandClaude Opus 5.5 7c5f88d33c Rebind only the vertex streams a draw reads that changed, and leave the streams it does not read bound
With vb_used the streams a draw does not read got the zero buffer, so draws in a row that read different streams
bound all 17 slots again almost every draw. On an RTX 5060 Laptop that cost 16 % of the frame rate (issue #974). Now
only the read streams are compared, one bind covers the changed ones, and the others keep the buffer bound earlier
in the command buffer, which the deferred frees keep alive until the submission is done.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 13:50:32 +03:00
美樹杏子 9382686c12 Fix Amiibo file names with non-ASCII characters displaying as garbled text in F1 menu 2026-11-08 18:39:21 +08:00
Wintego ceece5683a Make the PC prompts for every game resolution the setup lays the UI out for
The setup wrote romfs-patches-pc for 16:9 only, so prompts = pc on a 21:9, 32:9, 16:10 or 3:2 screen kept the game
resolution at 1920x1080 (cfg.c) or, with output_res set to the screen's shape, fell back to the Switch prompts.

- make_romfs_patches.py --reuse <folder>: a file of an earlier overlay whose contents match is hard-linked (copied
  where links fail) instead of compressed again; the output is byte for byte the same.
- The setup builds romfs-patches-pc-<w>x<h> for each of ASPECT_SIZES from romfs-patches-pc with --reuse: only the
  Common archive is compressed, so the fifteen folders take about two minutes and 6 MiB each instead of 22 minutes
  and 73 MiB each.
- cfg.c: the display-shaped output_res default applies with prompts = pc when romfs-patches-pc-<w>x<h> is there
  (romfs_shaped_pc_ready); Xbox prompts keep 1920x1080 as before.
2026-11-08 13:20:17 +03:00
Valiantsin DzerakhandClaude Opus 5.5 6cf4aab5f0 Merge task/pcore4: no P-core preference on hybrid CPUs with fewer than 4 P-cores
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 12:11:06 +03:00
Valiantsin DzerakhandClaude Opus 5.5 0d9525ba4a Leave the P-core preference off on hybrid CPUs with fewer than 4 P-cores
An i5-1235U or Core 3 100U has 2 P-cores. Binding the five frame-critical threads there, with a spinning recorder
among them, crowds two cores and their hyperthreads while the E-cores stay idle. plat_perf_core_setup now counts the
allowed physical P-cores and selects nothing below PC_MIN_CORES (4), so the scheduler places those threads as before.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 12:11:06 +03:00
Valiantsin Dzerakh b16c4c8938 Merge task/pcore: frame-critical threads prefer the P-cores of a hybrid CPU
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

# Conflicts:
#	runtime/vk_rec.c
2026-11-08 12:03:08 +03:00
Valiantsin DzerakhandClaude Opus 5.5 87fefa8ade Merge task/recasync: the recorder submits without the submitting thread waiting, larger publish batches without the poll
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 12:03:00 +03:00
Valiantsin DzerakhandClaude Opus 5.5 90fa6e1788 Let the recorder submit parts without the submitting thread waiting for it
rec_submit queued each part's submission and then drained the ring until the recorder had submitted it: 0.29 ms a
frame in the town on a Ryzen 7900X, 0.34 ms on 4 cores. Now it publishes the submission and returns
(TOTK_REC_ASYNC=1, default). The queue order the present, uploads, readbacks and device waits rely on is kept by
vk_queue_lock: a thread's first lock waits until the recorder submitted what was queued before (rec_queue_wait).
The recorder itself and a thread that already holds the lock skip the wait. rec_submit reports the first failed
submission the recorder made. Town, in-run A/B: replay -4.1% on all cores, -2.9% on 4 cores / 8 threads; queue
users waited about 0.02 ms a frame. fight2 with TOTK_REC_CHECK and the town under sync validation are clean.

Where the recorder does not poll (fewer than 6 usable logical processors) the producer now publishes the ring head
every 8192 words instead of 64, as Savage Wind Recomp does (runtime/nvn/vulkan/record.c rec_init): each publish
there costs an event set and a wake-up. Town on 4 logical processors: frame interval -1.3%. TOTK_REC_PUB=ab
compares both; the perf log counts the recorder's wake-ups and the queue waits.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 12:02:53 +03:00
Valiantsin DzerakhandClaude Opus 5.5 3a26046cde Let the threads every frame goes through prefer the P-cores of a hybrid CPU
On an Intel CPU with P-cores and E-cores a thread on an E-core runs at about 60% of a P-core's speed, and the frame
waits for its slowest critical thread. The game's main thread, the thread that presents, and the vk replay, recorder
and present threads now select the CPU sets of the P-core logical processors the process affinity allows. Nothing is
selected on a CPU with one efficiency class or when the affinity leaves only one kind of core. TOTK_PCORE=0 turns it
off; "power:" log lines say what was selected and which threads took it. LAS Recomp does the same for its game,
render and vsync threads.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 11:46:10 +03:00
Valiantsin DzerakhandClaude Opus 5.5 1446f3b06b Merge task/hybrid: hybrid laptops ask for the dedicated GPU, Windows power throttling off
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 11:13:45 +03:00
Valiantsin DzerakhandClaude Opus 5.5 320a41e0dc Ask hybrid laptops for the dedicated GPU and opt out of Windows power throttling
The executable exports NvOptimusEnablement and AmdPowerXpressRequestHighPerformance, which NVIDIA Optimus and AMD
switchable graphics read at start to run it on the dedicated GPU; Optimus can otherwise hide its GPU from a program
it put on the integrated one. At start the process opts out of EcoQoS (E-cores and low clocks on hybrid Intel CPUs
when Windows deems it in the background) and of Windows 11 ignoring its timer resolution while the window is hidden.
One "power:" log line says whether Windows accepted it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 11:13:40 +03:00
Valiantsin DzerakhandClaude Opus 5.5 8b81beb98b Merge task/kspin: kernel waits and the recorder poll briefly before they sleep
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 11:05:38 +03:00
Valiantsin DzerakhandClaude Opus 5.5 2d92565ada Poll briefly before kernel waits and the recorder sleep
Guest waits and waits for a virtual core usually end within microseconds. A thread now polls for 20 us with the
global lock released before it sleeps on its condition variable, so a quick wake costs no OS wake-up
(TOTK_KSPIN_US, 0 turns it off). The recorder polls by the clock for 60 us instead of 4096 pauses, which last a few
us on Zen 4 and about 140 us on Coffee Lake (TOTK_REC_SPIN_US). Both stay off with fewer than 6 usable logical
processors. Savage Wind Recomp polls the same way before it parks.

Machine A, town save, in-run A/B: frame interval -1.8% on average for the kernel poll (5 of 7 block pairs), -0.7%
with the process limited to 4 cores / 8 threads; the recorder poll is neutral there.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 11:05:33 +03:00
itaskaev2 a48416dcf4 Merge branch 'dev' into carry/dynamic-res-100 2026-11-08 08:36:47 +01:00
itaskaev2 9b5ca3670f Merge branch 'dev' into carry/sync-ahead 2026-11-08 08:36:44 +01:00
corne-acandClaude Opus 5.5 a733b94645 Keep shadow_snap off by default under Wine until it has been measured there
Shadow storage is on by default under Wine as well, and the region snapshots were only measured on a native Linux
host. TOTK_SHADOW_SNAP=1 still turns them on under Wine.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 22:20:03 +02:00
corne-acandClaude Opus 5.5 02752376f7 Sync shadow pools from the per-submission write-watch snapshots
Each 2 MiB region is now queried at most once per guest submission, shared with the texture checks, instead of once
per pool at every part of a submission. On a Steam Deck at Lookout Landing the replay thread's write tracking fell
from about 4.4 to 1.3 ms a frame and the frame rate rose about 7.5%. TOTK_SHADOW_SNAP=0 restores the old queries.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 22:01:05 +02:00
itaskaev2andClaude Opus 5.5 ce9ed75cee Merge dev into carry/sync-ahead
vk_memory.c: dev now keeps every finalized pool until retire_value (at
least the submission being recorded), which also covers a shadow with a
deferred copy, so shadow_had_deferred goes. The deferred shadow prologue
and dev's upload scratch pool both stay.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 18:22:50 +01:00
itaskaev2andClaude Opus 5.5 91f6fc9838 Merge dev into carry/dynamic-res-100
cfg.c: the key list takes dev's DESWIZZLE and keeps this branch's
DYNAMIC_RES and FIXED_RES_PATCH.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 18:21:41 +01:00
ProSepandClaude Opus 5.5 a3d876e2d2 Let sync_ahead lag the 1.4.3 frame wait too
On 1.4.3 the per-frame wait is the second of the two nvnSyncWait calls in f_70002db8ac (return address 0x70002db99c). Like on 1.2.1, its sync comes from a two-entry ring indexed per frame; the first call waits on one object's sync behind a mode check. wdiasjunior found the site and measured it on an RX 7800 XT (#676): about 67-70 to 81-83 fps on Great Sky Island.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 10:55:56 +01:00
ProSepandClaude Opus 5.5 4624bf8076 Let the game run one frame further ahead of the GPU (TOTK_SYNC_AHEAD, off by default)
Each frame the game waits in one nvnSyncWait (1.2.1 lr 0x7000b23dfc) for the frame it presented last. On the Switch
that work is long done by then; here it is still in the replay and on the GPU, and on Great Sky Island the wait is
about 4.6 ms of a 13 ms frame. With TOTK_SYNC_AHEAD=1 that one wait waits for the frame before it instead, once the
replay thread submitted the asked value, so the game builds the next frame while the GPU runs the last one.

The game then writes guest memory that GPU work still in flight reads. Shadow storage makes that safe: a shadow update
of a pool with a reader in flight is queued and copied by the GPU in the next part's prologue, in queue order, instead
of memcpy'd under that reader (TOTK_SHADOW_DEFER=1, the default with the switch; 0 makes the replay thread wait for
the reader instead). The guard is read under the shadow lock and the wait takes that lock once after raising it, so no
sync that read the old guard is still copying when the game writes again. The switch needs shadow storage (Linux and
Wine by default, TOTK_SHADOW=1 on native Windows) and the 1.2.1 call site; otherwise it stays off with a log line.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 10:55:55 +01:00
ProSepandClaude Opus 5.5 a6c33b072c Hold the game's dynamic resolution at 100 % and let the scene grow past 4096 wide
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>
2026-11-07 10:55:54 +01:00
ProSep e54c0f7f75 Merge remote-tracking branch 'origin/dev' into distant-detail-merge
# Conflicts:
#	recomp/patches-v121.txt
#	runtime/cfg.c
2026-11-05 23:28:19 +01:00
ProSepandClaude Opus 5.5 1584d1ae23 Add the 1.4.3 sites of the distant detail settings
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>
2026-11-05 01:13:01 +01:00
ProSep 84acab6fda Merge remote-tracking branch 'origin/dev' into distant-detail-merge
# Conflicts:
#	runtime/cfg.c
2026-11-05 00:57:35 +01:00
Michael Anthony Bitoon cd32de5ff9 Keep DLSS off the inventory screen and on at every camera angle, with the scope or the camera rune open
The inventory's preview light target is drawn without depth before the bloom chain; a pass like that with nothing armed ends the scene once the bloom follows, so DLSS no longer runs on the finished menu picture. Arming on that target stays allowed, because at some camera angles the field's effects composite comes before the first pass with the scene depth. The G-buffer width is the widest of the frame, a small pass ends the scene only into a scene colour target, and no pair narrower than the widest G-buffer arms: with the scope open the half-size effects pass armed and DLSS scaled the effects into the light target.
2026-11-04 20:01:27 +08:00
ProSepandClaude Opus 5.5 47eed81122 Add the Portuguese and Chinese texts of the distant detail settings
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 00:08:28 +01:00
ProSep 4403a3f8ea Merge remote-tracking branch 'origin/dev' into distant-detail-merge
# Conflicts:
#	recomp/patches-v121.txt
#	recomp/patches-v143.txt
#	runtime/cfg.c
#	runtime/ui/menu.cpp
#	totk.ini.example
2026-11-04 00:08:28 +01:00
ipavlin98 23d24bbc77 Report heap corruption from the vectored handler
The heap manager raises STATUS_HEAP_CORRUPTION and then ends the process itself, so the exception never reaches the unhandled-exception filter, and a run that corrupted its heap ended without a FATAL line. crash_veh hands it to crash_filter, which names the module and the host frames as for any other fault outside the executable.
2026-11-03 23:15:59 +03:00
Zenrap0518 22e42662e5 Match RenoDX default gamma correction 2026-11-02 15:41:11 -07:00
Zenrap0518 5d06d60bd7 Match HDR tonemapping more closely to RenoDX defaults 2026-11-02 14:15:36 -07:00
ProSepandClaude Opus 5.5 a211c4cb3e Keep the game's level for one-level models in the lod patch set
The level picker returns 0 for a model with one level, and the emulator mod returned the floor at its parameters' +0x28
for those too, without checking it against the level count; a floor above 0 would index past the one-level list. The
site now masks the floor to 0 when the count is 1, without flags (a site may use them once), and every other model still
takes the early return with the floor.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-01 04:14:56 +01:00
ProSepandClaude Opus 5.5 11cdd8f797 Add distant model detail settings for 1.2.1
lod_detail and lod_steady (default 0) are two patch sets after the emulator mods "LOD Improvement v2" (theboy181,
sweetmini) and "Disable LOD Quality Reduction": the model level picker returns its finest allowed level at any distance,
and the graphics settings setup skips the reduction of detail under load. The mods turn a conditional branch into an
unconditional one; the generator patches only plain instructions, so the sites feed those branches instead.

The sites are for 1.2.1 only. 1.4.3 and 1.1.1 declare the sets without sites until theirs are found in those builds.
On the Screen tab of the settings menu (English and Russian) and in totk.ini.example.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-01 03:17:10 +01:00
350 changed files with 96063 additions and 3153 deletions

No files matched your search

+36
View File
@@ -0,0 +1,36 @@
<!--
Target branch: dev. Rules: CONTRIBUTING.md, "Pull requests". Write each section in your own words about this diff;
delete the rows that do not apply. Never attach game files, keys, extracted data or logs that contain them.
-->
## Problem
<!-- What the player sees or what is wrong in the code. Issue link if there is one. -->
## Change
<!-- What the diff does and why this way. Name the switch (totk.ini setting or TOTK_* variable) that turns it off. -->
## Where it reproduces
<!-- OS, CPU, GPU and driver, game update (1.2.1 / 1.4.3), settings. Hardware it cannot appear on, if known. -->
## Proof
<!-- Before and after on the same repro: screenshots, log lines, a test that failed and now passes. -->
## Checks run
<!-- The rows of CONTRIBUTING.md "Checks by what you changed" that match the diff, each with its result. -->
- [ ] `python tools/check_content.py --staged`
- [ ] `totk.exe --selftest`
## Measurements
<!-- Frame path, timing or scheduling only. Per run, switch off and on, at least two each: average fps, 1% low or
worst frame, `perf: slow frame` count. Scene, save, seconds, CPU, GPU, driver, resolution. -->
## Not run
<!-- Paths you could not run (Linux, HDR, a vendor you do not have) and how they are gated. -->
+9
View File
@@ -29,6 +29,15 @@ This repository is public. Game data lives outside it and every derived file sta
- Graphics bugs: [docs/maxwell.md](docs/maxwell.md) lists the Maxwell behaviour the Vulkan path must match and the TotK bugs other ports fixed.
- 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) and upstream code by project, file and function: `refs/` moves, so its line numbers rot. Commit hashes belong to the attribution of copied code.
## Running and debugging
- Running the game, screenshots, frame dumps, timings: [docs/agents/running.md](docs/agents/running.md).
- Investigating a bug, glitch or crash: search [docs/agents/symptoms.md](docs/agents/symptoms.md) by the player's words first, then follow [docs/agents/debugging.md](docs/agents/debugging.md). Read the code before running the game.
## Pull requests
Preparing a pull request: target `dev`; the checks by changed area, the proof and the performance runs it carries are in [CONTRIBUTING.md](CONTRIBUTING.md), "Pull requests". Reviewing one: [docs/pr-review-kit/](docs/pr-review-kit/).
## Writing
Code, comments, docs and commit messages are in English. Commit messages are plain sentences without type prefixes.
+86 -7
View File
@@ -29,14 +29,93 @@ Use the issue form. Include the port version and game update from the title line
## Pull requests
- One topic per pull request.
- Describe the problem, then what changed.
- Say how you tested it: which version, which scene, how long.
- A change to the lifter (`recomp/`) or the CPU headers passes the differential tests in [docs/building.md](docs/building.md), "Checks".
- Commit messages are plain sentences, without `feat:` or other prefixes.
- AI-assisted code is welcome. You are responsible for having read and run it.
### Branch
Open pull requests against `dev`. Branch from the current `dev` and rebase on it before you open the pull request. `main` receives `dev` at a release; a pull request against `main` is retargeted to `dev` before review.
### Before you start
- Search the open pull requests and issues on the topic. When another pull request already covers it, improve that one or say in yours how they differ.
- Fixes are reviewed before features, in order of how many players the bug hits. A feature with a design in `docs/milestones/` (mods, cheats, the menu) follows that design. For a feature without one, open an issue first.
- Find out where the bug reproduces: OS, GPU vendor and generation, driver, game update, settings. Put that in the description.
### What the change must keep
- **The default for everyone.** A fix for one setup (a GPU vendor, a memory size, a display) is gated on that setup. Players without the problem see no change.
- **A switch.** New behaviour on the frame path or in rendering sits behind a `totk.ini` setting or a `TOTK_*` variable, so a player can turn it off and a reviewer can compare. A new setting is described in [totk.ini.example](totk.ini.example) and [docs/settings.md](docs/settings.md).
- **The fix, not a disabled feature.** A crash that goes away with a feature off points at the bug in that feature. Turning the feature off for a vendor is not a fix.
- **The frame time on weak hardware.** Game threads and the render thread do no file I/O, no GPU allocations, no per-draw state copies and no global atomic counters. Memory kept per frame or per object is freed. The full list with measured costs: [docs/pr-review-kit/02-performance.md](docs/pr-review-kit/02-performance.md), "What the hot path must not do".
- **Other GPUs.** New Vulkan code queries each feature, extension, format and limit it uses and keeps a working path without it. Nothing is hardcoded from what one GPU reports.
- **Text in the catalogs.** Text a player sees gets an id in `runtime/ui_text.h` and an entry in `runtime/ui_text.c` for every menu language (English, Russian, Brazilian Portuguese, Simplified Chinese); installer text goes into `installer/text/*.json`.
- **The generator owns generated C.** Change `recomp/`, never `generated/`.
### Checks by what you changed
Run every row that matches your diff and list the results in the description. Commands and details: [docs/building.md](docs/building.md), "Checks".
| You changed | Run |
|---|---|
| anything | `python tools/check_content.py --staged`; `build\<ver>\totk.exe --selftest` |
| `recomp/`, `runtime/cpu.h`, `runtime/simd.h` | the differential tests against Unicorn: `tests\diff\lift.py`, `simd.py`, `atomic.py`, `func.py`, `tests\flags_check.py`, `tests\excl_mt.py`; the same with a `--cpu v2` build |
| `recomp/jumptables.py` | `tests\jumptables_check.py`: 0 disagreements on 1.2.1 and 1.4.3 |
| `runtime/` | `--probe-kernel`, `--probe-vkexec`, `--probe-nvn-tex`, `--probe-shader`, plus the probe for the file you touched (list at the top of `runtime/main.c`) |
| settings | `totk.exe --probe-cfg`; `python tests\settings_doc_check.py` |
| button prompts | `.venv-py314\Scripts\python tests\romfs_prompts_test.py` |
| mods, ExeFS patches | `.venv\Scripts\python tests\exefs_patches_test.py`; `totk.exe --probe-mods` |
| `installer/` | `python tests\installer_test.py`; `python tests\installer_gui_test.py` |
| shader translator | `tools\xlate_smoke.py`; `tools\shader_census.py --version <ver> --translate` with no new failure groups |
| rendering | a run in a scene where the change acts, with `TOTK_VK_VALIDATION=1`: no new validation messages; screenshots before and after |
| frame path, timing, scheduling | the measurements below |
Checks that need game files run on your own copy of the game. Results go into the pull request as text: pass or fail, counts, log lines. Never attach logs or dumps that contain game data.
### Proof
- **A bug fix** shows the bug before the change and gone after it, on the same repro: a screenshot pair, a log line, a probe or test that fails before and passes after. A scripted repro (`TOTK_INPUT_RECORD`, [docs/controls.md](docs/controls.md), "Scripted input") is the strongest. If the bug cannot be reproduced on your hardware, say so and point at the code that causes it.
- **A crash fix** names the crash: the log's crash report, `vk: pass marks` lines for a lost device.
- **Parts you could not run** (Linux-only code, HDR, vendor-only paths) are listed as unrun and gated away from everyone else.
### Performance measurements
A change on the frame path, in timing or in scheduling carries these numbers, or it waits until someone measures it.
1. **Ceiling first.** Before the work, estimate the share of the frame the changed code holds on the critical path (`TOTK_CRIT` + `tools/crit_path.py`). A ceiling of a few percent is not worth a hot-path change.
2. **Build 1.4.3** with prepared shaders in that build folder (`tools/prepare_shaders.py`, [docs/building.md](docs/building.md) step 6). Caches copied from another build folder do not count.
3. **A heavy scene** where the change acts: a fight with a large enemy and a crowd, or a town, with `TOTK_FPS_LIMIT=360`.
4. **Whole runs, switch off and on, at least two each**, the same save and the same input script, timed by game seconds:
```powershell
.venv\Scripts\python tools\run_game.py build\v143 --script <input.txt> --seconds 60 --quiet --env TOTK_TRACE=perf,sched --env TOTK_FPS_LIMIT=360 --env <SWITCH>=0
```
`--quiet` waits until no other game or build runs. Close everything heavy on the machine. Before reading the numbers, check that each run reached the world and showed the same scene.
5. **Report per run**: average fps, 1% low or worst frame, the number of `perf: slow frame` lines, VRAM; `tools/perf_summary.py` condenses the log. Add CPU, GPU, driver, RAM, resolution and the settings you changed.
A switch toggled inside one run on a moving scene gives false results: compare whole runs. Zero new slow frames is a hard bar; an fps gain does not buy back new hitches. Background and the reasons behind each rule: [docs/pr-review-kit/02-performance.md](docs/pr-review-kit/02-performance.md).
### Description and commits
Fill in the pull request template: problem, change, where it reproduces, checks, measurements, what stayed unrun. One topic per pull request.
Commit messages are plain English sentences, without `feat:`, `fix:` or other prefixes. A commit that works on an issue ends its subject with the issue numbers: `Render the handheld scene at the asked size on 1.4.3 (#998, #536)`.
### Review and merge
The maintainers review every pull request against [docs/pr-review-kit/](docs/pr-review-kit/): read it to see what gets a pull request rejected, which bug classes are already fixed and which invariants a change must keep. A good pull request that misses the project's conventions is fixed up while merging rather than sent back. Part of a pull request can be taken; the reason for what was left out or rejected is posted on the pull request.
Accepted work merges into `dev` and reaches players through test builds. `main` moves only at a release.
## Coding agents
AI-assisted code is welcome. You are responsible for having read and run it, and the pull request says which checks ran on your machine.
Point your agent at [AGENTS.md](AGENTS.md) (Claude Code reaches it through `CLAUDE.md`), this file and [docs/pr-review-kit/](docs/pr-review-kit/) before it writes code. [docs/agents/](docs/agents/) holds what it needs to run the game unattended, measure, and debug: the method, the bug classes of a recompiled Switch game, and a symptom catalog. The rules in them bind the agent as they bind you:
- Key values stay out of prompts, logs, commands and files. The agent passes the keys file path to the tools.
- Results in the pull request come from runs that happened. A check the agent did not run is listed as not run.
- The agent writes the description in its own words about this diff. A review kit checklist pasted in with every box ticked tells the reviewer nothing.
## Code and docs
- Code, comments, commit messages and documentation are in English.
- Generated code is never edited by hand: change the generator.
- Comments say what the code does and why. Cite our code by file and function, upstream code by project, file and function.
+26 -2
View File
@@ -28,10 +28,10 @@ Report problems as issues, following [CONTRIBUTING.md](CONTRIBUTING.md).
- In-game settings menu (F1) and performance overlay (F10)
- Play time across runs on the Game tab of the settings menu, kept in `playtime.txt` next to the saves
- Discord Rich Presence ("Playing TotK Recomp" with the play time), off by default, own application id supported
- Setup and in-game menu in English, Russian, Brazilian Portuguese and Simplified Chinese
- Setup in 11 languages, in-game menu in 4 ([Languages](#languages))
- Keyboard, mouse and gamepad with remapping, rumble and gyro
- Stereo or 5.1 surround sound output
- Xbox button prompts: LB, RB, LT, RT, Menu and View, and A, B, X and Y as labelled on the button to press, with either button layout
- Xbox and PlayStation button prompts: Xbox's LB, RB, LT, RT, Menu, View and A, B, X, Y, or PlayStation's ○ × △ □, L1, R1, L2, R2, Options and Share, as labelled on the button to press, with either button layout
- Shaders prepared at install instead of during play
- Mods made for emulators: unpack a mod into the `mods` folder next to `totk.exe`; switch and order them in the menu. RomFS
mods, TKMM's merged output and ExeFS code patches (`.ips`, `.pchtxt`) work; the game rebuilds itself for code patches
@@ -39,6 +39,30 @@ Report problems as issues, following [CONTRIBUTING.md](CONTRIBUTING.md).
with the HDPacks.com 4K Texture Pack v1.0 on 1.4.3 and 1.2.1; other packs come with no guarantee
- Atmosphère cheats: put a cheat file into a mod and switch its cheats in the menu ([docs/cheats.md](docs/cheats.md))
## Languages
The game keeps the text and voices of every language it shipped with. The port's own setup and in-game menu (F1) come
in these; both follow the Windows display language, and the menu has its own choice on its Menu tab. A Traditional
Chinese Windows gets the Simplified Chinese setup.
| Language | Setup | In-game menu |
|---|:---:|:---:|
| English | ✅ | ✅ |
| Русский | ✅ | ✅ |
| Português (Brasil) | ✅ | ✅ |
| 简体中文 | ✅ | ✅ |
| Deutsch | ✅ | English |
| Français | ✅ | English |
| Español | ✅ | English |
| Italiano | ✅ | English |
| Nederlands | ✅ | English |
| 日本語 | ✅ | English |
| 한국어 | ✅ | English |
Spotted a clumsy phrase, or want your language added? The setup texts are in `installer/text/<language>.json`, the
menu texts in `runtime/ui_text.c`; open an issue or a pull request ([CONTRIBUTING.md](CONTRIBUTING.md)). Fixes from
native speakers are welcome.
## Planned
- VRR
+11 -5
View File
@@ -10,10 +10,10 @@ Code copied or adapted from another project is listed here with its source, the
| MacNativeGames TotK host runtime: dynamic linking, identity check, module permissions, guest memory and SVCs, threads, IPC, audio renderer, system services, RomFS and save storage, boot sequence, the NVN proc name list | https://github.com/ly05010419/MacNativeGames @ `b75be8cfa704df3701e86130c8ced268e79d6b11` (`games/totk/runtime/`, `games/totk/scripts/prepare_runtime.py`), Copyright (c) 2026 MacNativeGames contributors | MIT | `runtime/loader.c`, `runtime/memory.c`; `runtime/kernel.c`, `runtime/svc.c`, `runtime/ipc.c`, `runtime/ipc.h`, `runtime/audren.c`, `runtime/audren.h`, `runtime/audio_mixer.c`, `runtime/audio_effects.c`, `runtime/audio_effects.h`, `runtime/audio_reverb.c`, `runtime/audio_reverb.h` (SDL3 output replaces CoreAudio), `runtime/ov_system.c` (also `shared_font.c`: the BFTTF layout behind nn::pl), `runtime/ov_input.c` (also `hid_feedback.c`: vibration and six-axis handles and calls), `runtime/motion_fusion.c` (six-axis fusion of `motion_fusion.c`), `runtime/ov_media.c` (hardware Opus decoder over libopus), `runtime/swkbd_win.c` (`swkbd_host.c`: ShowKeyboardArg offsets, UTF-8/UTF-16 conversion, disabled-key filter, result codes; Win32 window replaces the macOS text bar), `runtime/ov_gfx.c`, `runtime/romfs.c`, `runtime/romfs_path.h`, `runtime/fs_host.c`, `runtime/fs.h`, `runtime/boot.c`; `runtime/gfx_window.c`; `tools/gen_nvn_procs.py`, `runtime/nvn_procs.inc` (`NVN/names.txt` and the `NVN_EXTRA` names of `totk_nvn_ext.c`) |
| MacNativeGames TotK frame-rate patches: 60 fps present-interval controller, real-time frame step and its present sampling, hair and cloth clock, trampoline slow-motion check (instruction words and 1.2.1 sites), player position chain; quick-menu capture background RomFS overlay | https://github.com/ly05010419/MacNativeGames @ `ebe621de99bfc48f3c42f2d2aa73e04fbcc6eae2` (`games/totk/runtime/game_patches.c`, `game_version.h`, `world_survey.c`, `games/totk/scripts/make_romfs_patches.py`), Copyright (c) 2026 MacNativeGames contributors | MIT | `runtime/frame_rate.c`, `recomp/patches-v121.txt`, `tools/make_romfs_patches.py` |
| MacNativeGames TotK 1.4.3 fade fix: the four distance / LOD and pre-actor fade sites, their instruction words and the floor of the fade step at 1 | https://github.com/ly05010419/MacNativeGames @ `3e9e7f67fdfdd3404134dcfa0f24969a9425a33f` (`games/totk/runtime/game_patches_v143.c` patch_fade_increment), Copyright (c) 2026 MacNativeGames contributors | MIT | `recomp/patches-v143.txt` (set fade; the floor without flags, clz >> 5, as in pull request #78) |
| MacNativeGames TotK 1.2.1 cursor and aim steps: the map cursor, vertical Ultrahand aim and vertical gyro aim sites, their instruction words and the step scaled by the frame ratio | https://github.com/ly05010419/MacNativeGames @ `363a6eb50434387f7d623349934bcf1e910be48f` (`games/totk/runtime/game_patches.c` patch_cursor_speed), Copyright (c) 2026 MacNativeGames contributors | MIT | `recomp/patches-v121.txt` (set cursor) |
| MacNativeGames TotK aspect ratio: the camera and viewport sites that hand the perspective projection its aspect ratio, and the UI layout edits for a canvas wider than 16:9 | https://github.com/ly05010419/MacNativeGames @ `933b6a0d1438de160208a0a13eb5e8d7a2cb8094` (`games/totk/runtime/aspect_patch.h`, `aspect_math.h`, `game_patches_v143.c`, `games/totk/scripts/ultrawide_layout.py`), Copyright (c) 2026 MacNativeGames contributors | MIT | `recomp/patches-v143.txt` (set aspect), `tools/ultrawide_layout.py`, `tools/make_romfs_patches.py` (--aspect) |
| MacNativeGames TotK 1.2.1 cursor and aim steps: the map cursor, vertical Ultrahand aim and vertical gyro aim sites, their instruction words and the step scaled by the frame ratio | https://github.com/ly05010419/MacNativeGames @ `363a6eb50434387f7d623349934bcf1e910be48f` (`games/totk/runtime/game_patches.c` patch_cursor_speed), Copyright (c) 2026 MacNativeGames contributors | MIT | `recomp/patches-v121.txt`, `recomp/patches-v110.txt` (set cursor) |
| MacNativeGames TotK aspect ratio: the camera and viewport sites that hand the perspective projection its aspect ratio, and the UI layout edits for a canvas wider than 16:9 | https://github.com/ly05010419/MacNativeGames @ `933b6a0d1438de160208a0a13eb5e8d7a2cb8094` (`games/totk/runtime/aspect_patch.h`, `aspect_math.h`, `game_patches_v143.c`, `games/totk/scripts/ultrawide_layout.py`), Copyright (c) 2026 MacNativeGames contributors | MIT | `recomp/patches-v110.txt`, `recomp/patches-v143.txt` (set aspect), `tools/ultrawide_layout.py`, `tools/make_romfs_patches.py` (--aspect) |
| MacNativeGames TotK button icons: the Xbox controller's shoulder buttons, triggers, Menu, View and d-pad drawn with letters from the game's own text fonts, the .bfotf key, the button guide's images and their block-linear layout, the resource size table raised for the archives that grew | https://github.com/ly05010419/MacNativeGames @ `933b6a0d1438de160208a0a13eb5e8d7a2cb8094` (`games/totk/scripts/make_button_icons.py`), Copyright (c) 2026 MacNativeGames contributors | MIT | `tools/button_icons.py`, `tools/make_romfs_patches.py` (--prompts) |
| RenoDX TotK mod (game mod by souperman9, tonemapper by Musa, RenoDX framework by ShortFuse, RenoVK fork by Ritsu): the approach of the HDR tonemap (the game's 1 - e^-x curve kept below a pivot and continued along its tangent above it, the saturation grade applied to the colour scaled into 0..1) and the observation that the passes after the tonemap keep values above 1. No code copied; the shader is our own | https://github.com/clshortfuse/renodx @ `b6f87272ad1bfdc0e6444910a93606815944a085` (`src/games/totk/tonemap.slang`, `addon.cpp`), Copyright (c) 2025 Carlos Lopez Jr. | MIT | `runtime/shaders/hdr_tonemap.frag`, `runtime/vk_hdr.c` |
| RenoDX TotK mod (game mod by souperman9, tonemapper by Musa, RenoDX framework by ShortFuse, RenoVK fork by Ritsu): the HDR tonemap's colour reconstruction (the game's 1 - e^-x curve continued along its tangent above 0.18, the SDR result as hue and purity donor through MacLeod-Boynton in BT.2020, the saturation grade on a Neutwo-compressed colour, per-channel Neutwo to the peak in BT.2020, the sRGB to gamma 2.2 correction) adapted into GLSL, and the observation that the passes after the tonemap keep values above 1 | https://github.com/clshortfuse/renodx @ `43c067b755a6a741f6500b2b936570f1462dcfbe` (`src/games/totk/tonemap.slang`, `src/games/totk/macleod_boynton.hlsli`, `src/shaders/colorcorrect.hlsl`, `src/shaders/tonemap/neutwo.hlsl`), Copyright (c) 2025 Carlos Lopez Jr. | MIT | `runtime/shaders/hdr_tonemap.frag`, `runtime/vk_hdr.c` |
| TOTK-Ultrawide, the community mod for emulators: the list of UI panes the ultrawide layout edits and the distances they move (data only, no code copied; the edit code is our own, and MacNativeGames' `ultrawide_layout.py` in the row above already carries the same values). The mod's repository URL and licence version are not recorded in this repository | TOTK-Ultrawide (community mod; URL not recorded here) | GPL (version not recorded here) | `tools/ultrawide_layout.py` (`KEEP_ROOT`, `edits`, `anim_edits`) |
| MacNativeGames TotK virtual-core preemption: asynchronous preemption of an owner in top-level game code, priority inheritance through guest mutexes, the SDK's preemption-disable protocol (TLR+0x100/+0x102, SVC 0x36), the core-wait diagnostics | https://github.com/ly05010419/MacNativeGames @ `33e8fa83052ea1ae09a3583137008e9797e12950` (`games/totk/runtime/threads.c`, commits 8bf0893 and 19730cd), Copyright (c) 2026 MacNativeGames contributors | MIT | `runtime/kernel.c` (SuspendThread and a register-saving stub replace SIGUSR2), `runtime/hostfn.c`, `runtime/svc.c` (host depth) |
| MacNativeGames RomFS index builder (`TOTKRFS1` layout) | https://github.com/ly05010419/MacNativeGames @ `b75be8cfa704df3701e86130c8ced268e79d6b11` (`games/totk/scripts/prepare_romfs_backend.py`), Copyright (c) 2026 MacNativeGames contributors | MIT | `tools/romfs_index.py` |
@@ -27,10 +27,14 @@ Code copied or adapted from another project is listed here with its source, the
| deko3d block-linear image layout, as ported in MacNativeGames' `nvn_tex.c` (Apple parts dropped, layout math unchanged; licence text in `games/totk/third_party/d2r_gfx/LICENSE.deko3d`, reproduced in the file header) | https://github.com/devkitPro/deko3d (`source/dk_image.cpp`), via MacNativeGames @ `b75be8cfa704df3701e86130c8ced268e79d6b11` (`games/totk/third_party/d2r_gfx/gfx/nvn/nvn_tex.c`, `nvn_tex.h`), Copyright (C) 2018-2020 fincs | zlib | `runtime/nvn_tex.c`, `runtime/nvn_tex.h` |
| MacNativeGames texture auto-layout goldens (40 original-SDK size and block-height cases) | https://github.com/ly05010419/MacNativeGames @ `b75be8cfa704df3701e86130c8ced268e79d6b11` (`games/totk/tests/texture_auto_layout/probe.c`), Copyright (c) 2026 jhaizhou | MIT | `runtime/nvn_tex_probe.c`; `runtime/nvn_probe.c` (four of the cases, through the procs) |
| MacNativeGames block-linear deswizzler (address function; copy loop split out as `tex_bl_copy`) | https://github.com/ly05010419/MacNativeGames @ `b75be8cfa704df3701e86130c8ced268e79d6b11` (`games/totk/third_party/d2r_gfx/gfx/tex/nvn_deswizzle.c`), Copyright (c) 2026 jhaizhou | MIT | `runtime/tex_deswizzle.c`, `runtime/tex.h` |
| SDL 3.4.18, dynamic link, `SDL3.dll` copied next to `totk.exe`. Developer builds use the MSYS2 build (`mingw-w64-ucrt-x86_64-sdl3`, which imports `libiconv-2.dll`, LGPL-2.1, unmodified, copied beside it); the installer release ships the upstream release `SDL3-3.4.18-win32-x64.zip`, which imports no libiconv | https://libsdl.org, Copyright (c) 1997-2026 Sam Lantinga | zlib | `runtime/input_win.c` (gamepad input, rumble, gyro and accelerometer) |
| SDL 3.4.20, dynamic link, `SDL3.dll` copied next to `totk.exe`. Developer builds use the MSYS2 build (`mingw-w64-ucrt-x86_64-sdl3`, which imports `libiconv-2.dll`, LGPL-2.1, unmodified, copied beside it); the installer release ships the upstream release `SDL3-3.4.20-win32-x64.zip`, which imports no libiconv | https://libsdl.org, Copyright (c) 1997-2026 Sam Lantinga | zlib | `runtime/input_win.c` (gamepad input, rumble, gyro and accelerometer) |
| libopus (MSYS2 `mingw-w64-ucrt-x86_64-opus`), dynamic link, `libopus-0.dll` copied next to `totk.exe` | https://opus-codec.org, Copyright (c) 2001-2023 Xiph.Org, Skype Limited, Octasic, Jean-Marc Valin, Timothy B. Terriberry, CSIRO, Gregory Maxwell, Mark Borgerding, Erik de Castro Lopo, Mozilla, Amazon | BSD-3-Clause | `runtime/ov_media.c` (nn::codec hardware Opus decoder) |
| Dear ImGui 1.91.9 (core and Vulkan back end, unmodified), as vendored by LAS Recomp | https://github.com/ocornut/imgui, via https://github.com/peiikai/LASRecomp @ `da35b83a9611d046a9a681aae668d7085954d37f` (`third_party/imgui/`), Copyright (c) 2014-2025 Omar Cornut | MIT | `runtime/third_party/imgui/` (compiled into `totk.exe` for the in-game menu, `runtime/ui/`) |
| AMD FidelityFX SDK 1.1.4 subset (public host and shader headers, frame interpolation, optical flow and FSR 3 upscaler components, the Vulkan backend `ffx_vk.cpp` and its GLSL shaders, shared helpers), with four marked Savage Wind patches (64-byte aligned backend scratch arrays, doubled context size where `wchar_t` is 4 bytes, all six descriptor pool sizes, the upscaler's Catmull-Rom history reprojection) and one of ours (the upscaler's luma history declared `rgba16f`) | https://github.com/GPUOpen-LibrariesAndSDKs/FidelityFX-SDK/tree/v1.1.4, Copyright (C) 2024 Advanced Micro Devices, Inc., via https://github.com/Revivedx/SavageWindRecomp @ `bf6146c14c37fee8781a601e5a544b93dff6d75e` (`third_party/FidelityFX/`) | MIT | `runtime/third_party/FidelityFX/` (compiled into `totk.exe`; licence text in `runtime/third_party/FidelityFX/LICENSE.txt`, shipped as `licenses/FidelityFX-SDK-LICENSE.txt`) |
| SavageWindRecomp FidelityFX build support, frame generation and FSR 3 upscaler set-up: the SDK-to-clang compat header, the glslang SPIR-V shader generator with its resource reflection and its FSR 3 upscaler permutations, the blob lookup and the backend and context creation of `runtime/nvn/vulkan/framegen.cpp`, the upscaler context with its shared images and the dispatch parameters of `runtime/nvn/vulkan/fsr3.cpp`, the pair's present spacing of `runtime/nvn/vulkan/device.c` `present_wait_turn` | https://github.com/Revivedx/SavageWindRecomp @ `bf6146c14c37fee8781a601e5a544b93dff6d75e` (`third_party/FidelityFX/ffx_compat.h`, `tools/ffx_shaders.py`, `runtime/nvn/vulkan/framegen.cpp`, `runtime/nvn/vulkan/fsr3.cpp`, `runtime/nvn/vulkan/device.c`) | MIT | `runtime/third_party/FidelityFX/ffx_compat.h`, `runtime/third_party/FidelityFX/spirv/ffx_shaders_vk.h` and `ffx_fsr3upscaler_vk.h` (output of `tools/ffx_shaders.py`), `tools/ffx_shaders.py`, `runtime/vk_fg.cpp`, `runtime/vk_fsr3.cpp`, `runtime/vk_backend.c` (`present_pair`) |
| SavageWindRecomp settings menu: two-pane option rows (row look, left / right stepping, hold speed-up, description pane), the menu style and tab bar | https://github.com/Revivedx/SavageWindRecomp @ `575ad88e02f9a89a9a885d90039d48af33c982f4` (`runtime/ui/option_rows.mm`, `runtime/ui/menu.mm`), Copyright (c) 2026 Revivedx and the Savage Wind Recomp contributors, Copyright (c) 2026 Peiikai | MIT | `runtime/ui/option_rows.cpp`, `runtime/ui/option_rows.h`, `runtime/ui/menu.cpp` |
| SavageWindRecomp GPU overlap one-off readback rule: a target not read back within the last 16 frames (64-entry table) makes the frame wait wait up to the value that rendered it | https://github.com/Revivedx/SavageWindRecomp @ `bf6146c14c37fee8781a601e5a544b93dff6d75e` (`runtime/nvn/vulkan/exec.c` readback_schedule, renderer_wait_seq), Copyright (c) 2026 Revivedx and the Savage Wind Recomp contributors, Copyright (c) 2026 Peiikai | MIT | `runtime/vk_texture.c` (oneoff_streaming, vk_texture_oneshot) |
| SavageWindRecomp descriptor sets allocated in growing batches per layout | https://github.com/Revivedx/SavageWindRecomp @ `740b18025fe11ba03c117dbb56668db304b5043e` (`runtime/nvn/vulkan/exec.c` vk_alloc_set), Copyright (c) 2026 Revivedx and the Savage Wind Recomp contributors, Copyright (c) 2026 Peiikai | MIT | `runtime/vk_exec_draw.c` (alloc_set_batched) |
| SavageWindRecomp performance overlay: the frame ring and its one-second summary, the NVML calls, the sampling loop, the full panel's layout | https://github.com/Revivedx/SavageWindRecomp @ `575ad88e02f9a89a9a885d90039d48af33c982f4` (`runtime/perfmon.c`, `runtime/perfmon.h`, `perf_overlay_draw` in `runtime/ui/menu.mm`), Copyright (c) 2026 Revivedx and the Savage Wind Recomp contributors, Copyright (c) 2026 Peiikai | MIT | `runtime/perfmon.c`, `runtime/perfmon.h`, `runtime/ui/menu.cpp` |
| Roboto Medium font (Dear ImGui's `misc/fonts/Roboto-Medium.ttf`, unmodified) | https://fonts.google.com/specimen/Roboto, via https://github.com/peiikai/LASRecomp @ `da35b83a9611d046a9a681aae668d7085954d37f` (`third_party/imgui/misc/fonts/`), Copyright 2011 Google Inc. | Apache-2.0 | `runtime/ui/fonts/Roboto-Medium.ttf` (licence text in `runtime/ui/fonts/LICENSE-Roboto.txt`), embedded by `runtime/ui/menu.cpp` |
| Vulkan Memory Allocator 3.4.0 (MSYS2 `mingw-w64-ucrt-x86_64-vulkan-memory-allocator`), header-only, compiled into `totk.exe` | https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator, Copyright (c) 2017-2026 Advanced Micro Devices, Inc. | MIT | `runtime/vk_vma.cpp` (the allocator behind `runtime/vk_memory.c`) |
@@ -41,6 +45,7 @@ Code copied or adapted from another project is listed here with its source, the
| AMD Display Library (ADL) declarations: `AdapterInfo`, `ADLSingleSensorData`, `ADLPMLogDataOutput`, the `ADL_PMLOG_*` sensor numbers and the `ADL2_*` function signatures | https://github.com/GPUOpen-LibrariesAndSDKs/display-library @ `84c881cb2136f04287eb3af12de00a9e2867aa9e` (`include/adl_structures.h`, `include/adl_defines.h`, `include/adl_sdk.h`), Copyright (c) 2016 - 2022 Advanced Micro Devices, Inc. | MIT | `runtime/perfmon.c` |
| Zstandard 1.5.7 (MSYS2 `mingw-w64-ucrt-x86_64-zstd`), static link | https://github.com/facebook/zstd, Copyright (c) Meta Platforms, Inc. and affiliates | BSD-3-Clause | `runtime/resolution.c` (the HeapDef table), `runtime/ov_zstd.c` (the game's zstd frames decoded on the host) |
| musl `fma.c`, `fmaf.c` and `scalbn.c`, adapted into one file for the x86-64-v2 build | https://github.com/kraj/musl @ `5a56ad13e1e0790c06122978aad2a14d6b9efc1a` (mirror of https://git.musl-libc.org/cgit/musl), Copyright (c) 2005-2020 Rich Felker and contributors | MIT | `runtime/fma.c` (the correctly rounded fma/fmaf the FP lowering needs on CPUs without FMA3) |
| MacNativeGames texture pool offset fix: widen the 32-bit texture storage and packaged-data offsets unsigned | https://github.com/ly05010419/MacNativeGames @ `ca311e2d` (`games/totk/runtime/game_patches.c` patch_pool_offset), Copyright (c) 2026 MacNativeGames contributors | MIT | `recomp/patches-v110.txt` (set pooloff; sites located again in 1.1.0) |
## Compiler runtime in a source build
@@ -71,9 +76,10 @@ These tools run on the developer's or player's machine during the build. They ar
| Tcl/Tk 9.0.4, rebuilt with Xft for the Linux installer | https://github.com/tcltk/tcl and https://github.com/tcltk/tk, tag `core-9-0-4`; archives pinned by SHA-256 in `tools/make_release_linux.py` | Tcl/Tk licence (BSD-style) | `python/lib/`; licence texts in `licenses/tcl-license.terms` and `licenses/tk-license.terms` |
| libXft 2 and libXrender 1, the sniper SDK sysroot's shared libraries, bundled beside the Xft Tk of the Linux installer; their Debian `copyright` files go into `licenses/` | https://repo.steampowered.com/steamrt-images-sniper/snapshots/3.0.20261021.266025/ | HPND (MIT-style) | `python/lib/`; `licenses/libXft-copyright.txt`, `licenses/libXrender-copyright.txt` |
| CPython 3.14.9 embeddable package, with `tkinter` and Tcl/Tk 9.0.4 taken from the python.org 3.14.9 installer's component MSI (unpacked, never run); includes `vcruntime140*.dll` (Microsoft, redistributable with Python), OpenSSL, libffi, SQLite, zlib, libtommath | https://www.python.org/downloads/release/python-3149/ | PSF-2.0 (Tcl/Tk: Tcl/Tk licence, BSD-style) | `python/` |
| Sun Valley ttk theme (sv-ttk 2.6.1): the light and dark themes, their sprite sheets and fonts, the look of the setup window | https://github.com/rdbende/Sun-Valley-ttk-theme @ `cefdf5d383073f29f04cb7254e24e195d8bda6a2` (tag v2.6.1, `sv_ttk/sv.tcl`, `sv_ttk/theme/`), Copyright (c) rdbende | MIT | `installer/vendor/sv_ttk/` (unmodified, licence in `installer/vendor/sv_ttk/LICENSE`), loaded by `installer/gui.py` use_sun_valley |
| numpy 2.5.4 (with its bundled OpenBLAS), lz4 4.4.5, cryptography 50.0.2 (with its bundled OpenSSL), fontTools 4.68.0, cffi 2.1.1, pycparser 3.11 | PyPI binary wheels, pins in `tools/requirements-installer.txt` | BSD-3-Clause; lz4 BSD-3-Clause; cryptography Apache-2.0 OR BSD-3-Clause; fontTools MIT; cffi MIT; pycparser BSD-3-Clause | `python/Lib/site-packages/` |
| llvm-mingw 20261020 (LLVM/Clang/LLD 23, mingw-w64, libc++, libunwind, compiler-rt), x86_64 subset | https://github.com/mstorsjo/llvm-mingw/releases/tag/20261020 | Apache-2.0 with LLVM exception; mingw-w64 ZPL-2.1/BSD/public domain; libc++ and libunwind Apache-2.0 with LLVM exception and MIT/UIUC; winpthreads MIT | `llvm/` |
| SDL 3.4.18 upstream Windows release (`SDL3.dll`) and mingw development package (headers, `libSDL3.dll.a`) | https://github.com/libsdl-org/SDL/releases/tag/release-3.4.18 | zlib | `bin/SDL3.dll`, `runtime/deps/` |
| SDL 3.4.20 upstream Windows release (`SDL3.dll`) and mingw development package (headers, `libSDL3.dll.a`) | https://github.com/libsdl-org/SDL/releases/tag/release-3.4.20 | zlib | `bin/SDL3.dll`, `runtime/deps/` |
| libopus 1.6.1 (MSYS2 `mingw-w64-ucrt-x86_64-opus` 1.6.1-2; `libopus-0.dll` imports only KERNEL32 and the UCRT api-ms-win-crt DLLs), headers and import library | https://repo.msys2.org/mingw/ucrt64/ | BSD-3-Clause | `bin/libopus-0.dll`, `runtime/deps/` |
| libvpx 1.17.0 (MSYS2 `mingw-w64-ucrt-x86_64-libvpx` 1.17.0-1), headers and static library compiled into `totk.exe`; `libvpx-LICENSE.txt` and `libvpx-PATENTS.txt` come from the v1.17.0 source tag | https://github.com/webmproject/libvpx | BSD-3-Clause with the WebM patent grant | `runtime/deps/`, `licenses/` |
| Zstandard 1.5.7 (MSYS2 `mingw-w64-ucrt-x86_64-zstd` 1.5.7-2), headers and static library compiled into `totk.exe`; `zstd-LICENSE.txt` from the package | https://github.com/facebook/zstd | BSD-3-Clause | `runtime/deps/`, `licenses/` |
+1 -1
View File
@@ -1 +1 @@
0.3.13
0.4.1
+117
View File
@@ -0,0 +1,117 @@
# Debugging the port: method for agents
A game run costs minutes and a full rebuild costs several more, while reading code costs seconds. Order the work so the
cheap steps decide as much as they can before the game starts. Each step ends on its stated condition.
## Steps
1. **Evidence.** Hold one artifact that shows the symptom: the player's screenshot, log or input recording, a
flight-recorder dump, a frame dump ([running.md](running.md), "Observing"). Done when you can point at the wrong
pixel, line or frame.
2. **Where it reproduces.** OS, GPU vendor and generation, driver, game update, settings, mods, the save. Done when you
know whether your hardware can show the bug at all. NVIDIA bugs do not reproduce on AMD; RDNA1/2 bugs do not
reproduce on RDNA3/4 (another driver branch); a Ryzen 7000 iGPU is RDNA2 and runs that branch. When your hardware
cannot show it, say so and work from the code and the reporter's logs; runs that cannot decide anything are skipped.
3. **Known already?** Search [symptoms.md](symptoms.md), [pr-review-kit/04-knowledge.md](../pr-review-kit/04-knowledge.md)
and [maxwell.md](../maxwell.md) sections 6-7 with the words the player used (black, magenta, flicker, slow motion,
missing, stale, streaks, stuck) and the object (sky, grass, shadow, fog, HUD, weapon). Then the upstream notes:
`refs/nxnative/docs`, `refs/MacNativeGames/docs` and the SavageWindRecomp issue tracker (`tools/fetch_refs.sh`
fetches `refs/`). Done when every hit is either ruled out or is your first hypothesis. A hit on a class we already
fixed: confirm that fix still holds before deriving anything new.
4. **Read the code.** The game's function in Ghidra ([building.md](../building.md), "Reverse engineering") or in
`generated/<ver>/`, and our runtime path in `runtime/`. Done when the code either rules the hypothesis out or names
the exact condition a run must show. A run confirms what the code could not rule out.
5. **The cheapest falsifying check.** An existing switch (a `totk.ini` setting or a `TOTK_*` variable), a dump, a trace
line, a probe. When it refutes the hypothesis, stop: write down what was checked and why it fell, and start again
at step 3 with the next hypothesis. No build, no benchmark for a refuted idea.
6. **Repro red, then green.** The same repro shows the bug before the fix and its absence after. A fix without a
reproduced failure is a guess.
7. **Fix the cause.** A crash that goes away with a feature off points at the bug in that feature; fix the feature.
A fix that one setup needs is gated on that setup, and everyone else keeps today's behaviour.
## Traps
- **One-off failures.** A failure that happens once and not again: rerun before you debug it as a code bug. A crash or
a forced shutdown leaves zero-filled cache files, and memory errors on the host flip bits in files and objects.
- **Every build fails the same way at once.** Suspect the inputs and caches (game files, the OS file cache, shader and
pipeline caches), not the code. Bisecting code is pointless when the old builds fail too.
- **Compile errors in generated C** on a line the generator could not have written are a flipped bit. Regenerate and
compare hashes; `recomp/` is fine.
- **A crash that looks like a race.** Try the save first: some saves crash the same way on a real Switch.
- **Theories about locks and threads.** Read the game's own protocol in Ghidra before running anything. Ten runs on
lock theories once went where one read of the game's double-buffer code would have narrowed it.
- **Numbers from a fast machine.** A change neutral on a fast desktop can matter on a weak laptop or the Steam Deck,
in either direction. Say which hardware your numbers come from.
## Bug classes of a recompiled Switch game
The port runs the game's own code on another OS and another GPU. Most bugs come from places where the host differs
from the console.
### Variable frame step and epsilon-gated timers
The console steps the game by whole 30 Hz units, so a countdown started at a whole value reaches exactly 0. With the
real-time step (`realtime = 1`, the default) the step is a measured ratio, and the last step can leave a remainder of
about 1e-8. Many of the game's updaters step a timer only while it is above `FLT_EPSILON`; a remainder in
(0, `FLT_EPSILON`] is never stepped again. A consumer that tests the same field with `> 0` then sees it active
forever, until a load reinitialises the object. Issue #18 (weapons locked after a Fuse) was this.
Symptom words: stuck until a reload, a teleport or a shrine; locked after an action; works sometimes; only above
30 fps. To check a report: find the field the stuck behaviour reads, then compare the updater's threshold with the
consumer's test. A change to the frame step, the pacer or the fps limit is checked for this class.
### Thread scheduling: Horizon is not a desktop OS
- Horizon runs a woken better-priority thread at once on its core, before the thread that woke it goes on. A host
runs both in parallel, so state can be read one step early or freed while another thread still uses it.
- Threads created with ideal core -2 start pinned to one core on Horizon. The game keys per-core data by
`GetCurrentProcessorNumber` without locks and expects that pinning.
- The game has hundreds of spin loops without a system call. On the console a spinning thread holds one core of three;
on the host it burns a host core and can keep an equal-priority waiter out.
- ARMv8 `stlr` followed by `ldar` is ordered (RCsc). C11 release/acquire lets x86 reorder that store and load. A
two-thread flag handshake that loses a wake points here; lifter changes to barriers and atomics pass
`tests\diff\atomic.py` and `tests\excl_mt.py`.
- A scheduling change is judged by how long a ready, better thread waits for a core it may use, plus the slow-frame
count. A check that made one bug rarer once added 50-75 ms hitches.
### Maxwell behaviour versus Vulkan defaults
The port must do what the Switch GPU does: last-vertex provoking, (0,0,0,1) for unwritten vertex outputs, colour
targets outside the shader's output map keep their texels, the G-buffer pass samples its own targets. The full list
with sources: [maxwell.md](../maxwell.md), section 7.
### Memory shared by the CPU and the GPU
- The game fills textures and buffers with the CPU and samples them on the GPU without the flush a desktop API needs.
Missing uploads show as magenta, brown or stale textures.
- The game reads GPU-rendered textures with the CPU (grass maps, cut and burn masks). Missing write-backs show as
effects that never happen: cut grass stays up, fire does not spread.
- Memory only the GPU writes looks idle to write-watch tracking: a store from a shader leaves no fault and no dirty bit.
- Anything kept per texture, per frame or per object without a free grows host memory until a commit failure after
hours. Watch private memory over a few idle minutes.
### Device lost and GPU hangs
- The `vk: pass marks` lines name the pass in flight. Validation names the misuse when there is one.
- Submits and presents share one queue under one lock. A present from its own thread on a second queue gave device
lost on NVIDIA before Turing in another port.
- Caches from another driver or GPU (pipeline caches, translated shaders) gave black windows after driver updates;
every cache is validated on load and dropped when vendor, device or `pipelineCacheUUID` change.
- A first-time shader stall over 2 s on a slow GPU trips the Windows GPU timeout (display event 4101). Large one-shot
submissions (a boot-time decode of every texture) do the same.
- Point lists from vertex shaders that write no point size are undefined without `VK_KHR_maintenance5`.
### Windows and Wine host costs
What the hot path must not do, with measured costs: [pr-review-kit/02-performance.md](../pr-review-kit/02-performance.md),
"What the hot path must not do". For debugging, also:
- `SuspendThread` returns at once, but `GetThreadContext` waits until the thread leaves the kernel. A sampler or a
debugger stalls for as long as the stopped thread's file open or driver call runs.
- A thread stopped between its `sub rsp` and its stack probe has its stack pointer inside the guard page. Check
`PAGE_GUARD` with `VirtualQuery` before reading another thread's stack.
- Paths go through the W APIs with UTF-8 to UTF-16 conversion. An A API call breaks on a path with non-Latin letters,
such as a Windows user name in Cyrillic or Chinese.
- Wine emulates `GetWriteWatch` with `mprotect` and one fault per first write. Anything relying on cheap OS memory
tricks (write-watch, protection changes, fault handlers) costs more under Proton.
- `win32u.dll` frames in a host stack are kernel graphics calls: memory allocation or submission.
+91
View File
@@ -0,0 +1,91 @@
# Running and observing the game as an agent
How an agent runs a build into gameplay without a person at the controls, captures what the game shows, and reads the
results without flooding its context. Setting names and file formats live in [settings.md](../settings.md) and
[controls.md](../controls.md); this page says which to use when. How to judge a performance change:
[pr-review-kit/02-performance.md](../pr-review-kit/02-performance.md).
## Before the first run
- **A build dir per change.** Build into its own folder (`tools/build_game.py --out build/<ver>-<name>`) so a
comparison has two exes side by side. After every build check the exe's modification time: a failed link leaves the
old `totk.exe` in place and you test old code.
- **Prepared shaders in that folder.** `tools/prepare_shaders.py build/<dir> --version <ver>` ([building.md](../building.md)
step 6). Without it the game compiles shaders during play, and every timing and every "a draw is missing" shot of the
first minutes says nothing about your change. Shader and pipeline caches are not copied between build folders.
- **The same `totk.ini` on both sides** of any comparison. A folder without one runs at the defaults; check the log's
`resolution:` line of each run before comparing them.
- **Saves.** `tools/run_game.py` copies the profile `build/profile`, swaps in a save from `build/save-backup/<name>/`
and deletes the copy afterwards, so the real profile is never written. To make a backup, copy the user folder from
`build/profile/save/` into `build/save-backup/<name>/`. Pick a save that starts where the change acts.
## Running
```powershell
.venv\Scripts\python tools\run_game.py build\<dir> --save <name> --seconds 30 [--script <input.txt>] [--shot out.png] [--env KEY=VALUE] [--quiet] [--tag <name>]
```
- `--seconds` is game time since the world loaded (the log line `frame step: world clock starts` marks the start), at
any frame rate. Measure and script by game time; a frame count at another fps is another scene.
- `--script` replays input ([controls.md](../controls.md), "Scripted input"). A new script starts with the presses of
`tools/input/load_save.txt`, which load the first save from the title. `TOTK_INPUT_RECORD` turns a person's play into
a script; ask the user to record the repro rather than guessing the button sequence.
- `--shot` saves the last frame and builds pipelines synchronously: use it for pictures, never for timing.
- `--quiet` waits until no other `totk.exe` or `ninja.exe` runs. Every timing you report comes from a `--quiet` run.
- The log goes to `<dir>\logs\<tag>.log`; the tool prints `<log>: rc=<code>`.
Run one game at a time: two instances share the GPU's memory and the CPU, and both runs' numbers are void.
Running `totk.exe` yourself: set `TOTK_ASSUME_FOCUS=1` (an unfocused window otherwise pauses the game),
`TOTK_INPUT=none` (the user's keyboard and pad stay out) and `TOTK_BACKGROUND_WINDOW=1`. Stop only the process you
started, by PID: `taskkill /IM totk.exe` also closes the user's game.
**Check that the run reached the world** before trusting it: the world clock line is in the log and the shot shows the
scene you expected. Title menus on a slow boot eat presses, and runs of one script drift apart after 10-15 game seconds
(enemy AI, physics, weather). Two runs are comparable only when shots at the same game second show the same scene.
## Observing
| You need | Use |
|---|---|
| pictures over a time span | `TOTK_SHOTS=w<lo>-<hi>:<step>` (world seconds) and `TOTK_SHOTS_DIR`; 480x270 by default |
| the frames around a hitch or a one-frame glitch | `TOTK_FLIGHT=1`: keeps the last 600 frames with timings and thumbnails, dumps on F8, on a frame over `TOTK_FLIGHT_SPIKE_MS` or at `TOTK_FLIGHT_AT=<frame>`; `python tools/flight_view.py <dump dir>` lists the worst frames and writes a contact sheet |
| every render pass of one frame | `TOTK_DUMP=<frame>` and `TOTK_DUMP_DIR`: a PNG per pass target plus `passes.txt` (draws, bound textures with swizzles, storage buffers, copies, clears) and `images.txt`; `TOTK_DUMP_BUF` adds a guest buffer |
| Vulkan misuse | `TOTK_VK_VALIDATION=1` (needs the Vulkan SDK), run into the world; compare the message kinds with a run without your change. The layer caps repeats, so counts are not totals |
| which pass the GPU was in at a device lost | the `vk: pass marks` lines; on by default on AMD, `TOTK_PASS_CRUMBS=1` elsewhere |
| which object held the address of a GPU memory fault | `TOTK_ADDR_REPORT=1` (off by default: it slows recording, on AMD's Windows driver more and more over a session); the `vk: fault address` lines after the device lost |
| a crash | the crash report at the end of the log: exception, guest and host addresses, registers |
| a run on a large card that acts like a small one | `TOTK_VRAM_LIMIT_MIB=<MiB>` |
Frame dumps: a draw's argument lines come before its pass header. Pass numbers shift between runs, so find a pass by
its draw count or its targets, not by its number. RenderDoc cannot capture this renderer ([controls.md](../controls.md),
"RenderDoc capture").
## Measuring
| What | How |
|---|---|
| fps, worst frame, render-thread waits, GPU busy time, VRAM, `bound: gpu\|cpu\|pace` | `--env TOTK_TRACE=perf,sched`, then `python tools\perf_summary.py <log> <lo> <hi>` |
| slow frames | count the `perf: slow frame` lines; each names what the render thread was blocked on (pipeline, translation, texture, fence, pacing) |
| the frame's critical path, by thread and state | `TOTK_CRIT=w<lo>-<hi>` and `TOTK_CRIT_OUT=<absolute path>` with `sched` tracing, then `python tools\crit_path.py <file>` |
| where CPU time goes | `TOTK_PROFILE=<path>` and `TOTK_PROFILE_FRAMES=w<lo>-<hi>`, then `python tools\prof_report.py <profile> <totk.map>`; `TOTK_PROFILE_RENDER=1` samples the render thread with call chains |
| a switch on a static scene | a setting set to `ab` with `TOTK_AB=<seconds>` alternates the two sides in blocks of game time; `python tools\ab_summary.py <log> --skip <seconds>`. On a moving scene compare whole runs instead |
A single run proves little: runs of one script on one build spread by a third in their 1% lows. Compare medians of at
least two whole runs per side, on a quiet machine.
## Probes
Each probe is a mode of `totk.exe`, run from the build folder; the list with what each covers is at the top of
`runtime/main.c`. `--selftest` needs no game files. `--probe-kernel`, `--probe-vkexec`, `--probe-nvn-tex` and
`--probe-shader` cover most runtime changes and run in seconds: run them before any game run.
## Reading output without filling the context
- Game logs run to megabytes. `grep` the lines you need, `tail` the end, pipe `perf_summary.py` through `grep SUMMARY`.
- Generated C runs to hundreds of thousands of lines per file. `grep -n` the function, then print its line range.
- Look at screenshots downscaled: paste several into one 1280x720 grid and read the grid once. Write down what it shows
instead of opening it again.
- Send long builds and runs to the background with their output in a file; read the last lines when they end.
- Keep a notes file in the build folder from the first finding: what is ruled out, the leading hypothesis, the next
step, temporary debug edits with file and line. A fresh session continues from it.
+83
View File
@@ -0,0 +1,83 @@
# Symptoms and their usual causes
What a player reports, the causes this port and other Switch ports (nxnative, MacNativeGames, SavageWindRecomp,
LAS Recomp) found behind it, and the first check. Search by the player's words and by the object. Which of these are
already fixed here, and where: [pr-review-kit/04-knowledge.md](../pr-review-kit/04-knowledge.md), "Fixed bug classes".
GPU semantics behind the graphics rows: [maxwell.md](../maxwell.md). The method around this table:
[debugging.md](debugging.md).
## Graphics
| Symptom | Usual causes | First check |
|---|---|---|
| magenta, brown or stale textures; caves or sky wrong | the CPU filled the texture and the GPU never got the upload (no flush on the console) | frame dump: the texture's upload count and mirror state in `passes.txt` |
| rain shows only its splashes on the ground, no falling drops; waterfall splashes and mist blink | a GPU write-back copies a whole range over particle records the CPU spawned in it (`vk_memory.c`: the write-back merge, and with `shadow = 1` the shadow's pending ranges) | a run with `TOTK_WB_MERGE=0` or `TOTK_SHADOW=0` against one without |
| effects that never happen: cut grass stays up, fire does not spread | the CPU reads a GPU-rendered texture that was never written back | which texture the game reads after its fence; write-back of that target |
| black scene, black dialog background or loading map | deferred binds read at record time; a 3D target rejected; a texture compare ignoring the channel mapping | frame dump: the first pass whose target goes black |
| lime silhouettes, rectangles in the sky | a target outside the shader's output map overwritten instead of kept | dump: the target's previous contents versus after the pass |
| dark or magenta 16x16 blocks, missing characters | a pass samples its own render targets (G-buffer feedback) | feedback-loop layout and barriers on that pass |
| tile rectangles, wrong data in tiles | storage buffers bound in the wrong slot order | `passes.txt`: storage buffers with their c0 slots |
| streaks on cliffs, characters stretched into streaks | primitive restart ignored; integer vertex inputs against a float format | validation run; the draw's topology and vertex formats in the dump |
| huge stretched slabs over the ground, a ceiling over Link, the ground up to his chest, from the load on for the whole session (the Depths); some runs only, most at a high frame rate; with `sync_ahead`, `replay_workers` and a discrete GPU | a VRAM mirror copied from the shadow before the CPU's write reached it, and kept the old vertices while marked synced (fixed: `vk_memory.c` `vk_mem_mirror_seal`) | `TOTK_MEMORY=verify` mismatch lines; `memory = import` or `replay_workers = 0` makes it go; `fps_limit = 144` shows it in most runs |
| garbage geometry on title or load screens | 8-bit indices widened on the CPU before a copy in the same submission wrote them | whether a copy to the index buffer precedes the draw in one submission |
| black tiles, masks not cleared | clears with a partial channel or stencil mask skipped or done in full | `passes.txt` clears and their masks |
| garbage in feedback effects at first use | new GPU-only images start undefined; the console starts them at zero | clear on creation and compare |
| empty clouds or fog for the whole session | a one-shot draw skipped while its pipeline built, never drawn again | `perf: slow frame` lines naming pipeline waits; the draw's first frame |
| fog that never parts, flicker in tile rows | driver constants (c0: dispatch size, point size, base instance) not filled | the c0 contents the translator expects for that stage |
| no sun shadows, wrong lighting | unwritten vertex outputs read as zero instead of (0,0,0,1) | the shader's output map |
| one flat ambient colour | a 1-layer 2D array sampled as 2D | the view type the shader expects |
| upside-down text | lower-left window origin | origin mode in the log |
| puddles and still water flicker: the reflection turns on and off in patches from frame to frame while the camera stands still, more with DLAA | the game's water volume mask: a volume's top face lies on the water surface and is tested LEQUAL against a depth rebuilt at quarter size, so rounding and the camera's sub-millimetre motion decide it (fixed: `vk_pipeline.c` `vk_pipeline_volume_bias` gives such draws a depth bias toward the viewer) | a `--capture` run: the puddle's brightness swing (`capture.py` frames, a region's mean) with `TOTK_VOLUME_MASK_BIAS=0` and without; in a frame dump, the quarter-size mask after the volume draw changes from frame to frame |
| with DLAA on, water seen at a low angle (ponds, streams) flickers in large patches with a period of about three frames, between the reflection of the trees and that of the sky; without DLAA it is still | the jitter moved the viewport of the scene's draws but not the game's camera, so its full-screen passes rebuilt positions half a pixel off the surface and its screen-space reflections flipped between hit and miss with the jitter's phase (fixed on 1.4.3: `vk_dlaa.c` puts the jitter into the camera blocks where the game copies its matrices, `vk_dlaa_camera_copied`) | `TOTK_DLAA_CAM_JITTER=0` brings the viewport jitter back; a `--capture` run: the region's brightness swing with DLAA, against `TOTK_DLAA_JITTER=0` |
| with DLAA on, the world behind the inventory smears into horizontal streaks on the right half, from the second time the inventory is opened (when Link's model is drawn there) | the camera jitter's read-back took the inventory camera's own off-centre projection (P[0][2] about -0.6) for a jitter and gave DLSS an offset of about 1152 pixels (fixed: `vk_dlaa.c` `cam_offset` takes only an offset it gave that block) | `TOTK_DLAA_CAM_JITTER=0` makes it go; a `--capture` run over the opened inventory: the background's horizontal gradient against its vertical one |
| with DLAA/DLSS on, large distant blocks behind the fog (the Depths) turn darker or lighter for a frame while the camera moves | DLSS created with AutoExposure estimated the exposure of the dark scene itself, and the estimate moved from frame to frame (fixed with `dlss_fixed_exposure = 1`: `vk_dlaa.c` evaluate creates the feature without it) | a flat fogged patch in `capture.py` frames: one value without DLAA, jumps with it |
| flicker or a texture swapped with a similar one | the newest texture picked at shared storage instead of the one with the matching view | texture lookup by id in the dump |
| with DLAA on, dust and small particles in fog (shrines) vanish, smear or behave oddly; the fog looks processed | DLSS ran at the bloom, after the fog and the particles, which have no motion vectors or jitter of their own (fixed: `vk_dlaa.c` effects_point runs DLSS at the first pass into the light target after the lighting, and the effects go over its picture) | `dlaa_effects_after = 0` (Screen tab) brings the old point back; the count "before the effects" in the `dlaa:` log line against the frames anti-aliased |
| with DLAA on, the picture flickers from frame to frame: a little outdoors; the whole scene in a fogged shrine with an ability's targeting view (Ultrahand) open, where the fog also goes back under DLSS | DLSS ran before some effects in one frame and after them in the next: their order changes from frame to frame (the yard's half-size effects pass is in some frames only; the ability highlight, drawn into the light target with a D16 depth of its own, comes before or after the fog layer), and a rule that waited for one of them or took any D16 pass for the lighting followed it (fixed: `vk_dlaa.c` effects_point knows the lighting by its depth and runs DLSS right after it) | the `dlaa:` log line: "before the effects" must equal the frames anti-aliased in the world; a log of the passes into the light target per frame |
## Timing and frame pacing
| Symptom | Usual causes | First check |
|---|---|---|
| stuck until a reload or teleport, locked after an action | a timer remainder below `FLT_EPSILON` with the real-time step ([debugging.md](debugging.md)) | `realtime = 0` in `totk.ini`; if the bug is gone, find the timer field |
| slow motion in GPU-heavy scenes, dynamic resolution never drops | the engine's GPU time comes from report timestamps; wrong timestamps make the frame look free | what the engine reads as GPU time and what the report writes |
| frame counter wanders 50-60 | two 60 Hz clocks (vsync event and present acquire) drifting apart | whether both follow one display tick |
| a 30 Hz thread runs at 27 Hz, slow cutscenes | host sleep overshoot: Windows waitable timers wake 0.3-0.5 ms late | `TOTK_TRACE=sched` sleep asked versus took |
| 20 fps after a scheduler change | a yield back-off that starts too early | yield handling against the console's |
| in the Depths Link takes gloom damage and wears the gloom haze while standing on clean ground, some runs only; only with `sync_ahead = 1` | the game read a GPU result of the frame it was told is done before the GPU wrote it: its one-pixel readbacks go through a buffer per request, which then holds zeros or an answer from the ring's last round (fixed: `vk_memory.c` `vk_mem_shadow_read` waits at the invalidate) | `sync_ahead = 0`; the exit line `mem: the game waited for a GPU write it reads` |
| in shrines the lamps' reflections on the floor go out for single frames, every other frame at some camera angles; only with `sync_ahead = 1`, more with DLAA (the GPU runs further behind) | the game reads its depth query results two frames later and refuses them unless their frame number is exactly the counter - 2; with sync_ahead it is the counter - 3 on frames where the GPU is behind (fixed: patch set `qstamp` in `recomp/patches-v143.txt` also takes the counter - 3) | `sync_ahead = 0`; a `--capture` run with `TOTK_SYNC_AHEAD` on, counting one-frame drops in floor regions |
| climbing or movement wrong only above some fps | game code that assumes a fixed step count per frame | compare at 30, 60 and the failing rate |
## Threads and crashes
| Symptom | Usual causes | First check |
|---|---|---|
| state read one step early, one frame of inconsistent data | a woken better-priority thread does not run before the waker goes on | sched trace around the handoff |
| per-core data corrupted, rare crash in a container walk | threads the console pins to one core run on any host core | the thread's core mask from its creator; a run on one core |
| rare hang or lost wake | address-arbiter signal values or wake order differ from Horizon | the arbiter path against mesosphere |
| a flag handshake loses a wake | `stlr`/`ldar` ordering lost in x86 release/acquire | the guest code's barrier pattern |
| a host core at 100% while the game waits | game spin loops without system calls | profile: which guest function spins |
| crash on world load | sizes the game reads from the driver (command memory used) differ from the console's | the sizes the game asks for against the console's |
| crash with one save only | the save itself; some crash on a real Switch | the same save on another build and, if possible, on hardware |
| random crash after minutes to hours, access violation reading `0xffffffffffffffff` or a small address such as `0x90` in a game function (Windows reports any non-canonical address as `0xffffffffffffffff`) | an invalid value (-1, `0xffff0000ffffffff`) in an optional reference the game checks only for null; in main+0x1bd0138 (Recall / Ultrahand picking a target) also a reused holder whose actor points into other memory. Sets `optref` and `ability` in `recomp/patches-v143.txt` guard both there | the crash dump's faulting host instruction, the register it loads through and the field that register came from; `ability: target dropped` lines in the log |
| crash while using Ultrahand or aiming, in the model scene's report loop (1.4.3 main+0xa22bc..0xa234c) | a report row index read from the report buffer with no bound (Weeping of the Empire #52, #73); set `report` sends a negative handle or an index from 0x8000 to the game's own reset | the faulting address against the report rows base (x12) |
## Device lost, hangs, black window
| Symptom | Usual causes | First check |
|---|---|---|
| device lost a few frames in, GPU writes to address 0 (older NVIDIA) | present from another thread or queue | every submit and present on one queue under one lock |
| device lost or garbage on one AMD generation | views the driver branch mishandles (BC block views of 3D textures) | `vk: pass marks`, validation; the formats in the pass |
| device lost on one scene, every run, one vendor | a shader or pass that driver cannot run | pass marks name the pass; skip shaders by hash to bisect |
| GPU timeout after 1-2 min, single frames over 2 s | first-time shader stalls or a huge one-shot submission on a slow GPU | prepared shaders; submission sizes at boot |
| GPU hang at boot with pipeline libraries | point lists without a point size | the shader writes point size or the device clamps it |
| black window after a driver update | caches from another driver | the log line `vk_pipeline: ... written by another device or driver`; delete the caches next to `totk.exe` |
## Memory
| Symptom | Usual causes | First check |
|---|---|---|
| host memory grows in play until a commit failure after hours | state kept per texture init or per frame and never freed | private memory over a few idle minutes |
| multi-GB peaks while travelling | upload staging grows inside one submission | staging bytes per submission |
| out of memory after minutes | dead textures re-entering tables | live images and allocator bytes over time |
| stutter as VRAM fills | new memory blocks allocated on the render thread (8-23 ms each) | profile the render thread over the hitch: `vkAllocateMemory` under the allocator's lock |
+15 -5
View File
@@ -40,6 +40,10 @@ MacNativeGames cannot run on x86-64 as is: its CPU path executes ARM64 code nati
(`recomp/flags.py`, `recomp/regs.py`): registers are stored back where they changed, before calls, SVCs and
exits, and reloaded after them. A call reloads only X0-X18 and X30, as AAPCS64 has the callee preserve X19-X29 and
SP; `gen.py --no-callee-saved-trust` reloads those too.
- `gen.py --v-locals K` keeps the K most used V registers of each function in a local `u128 vr[32]` that clang
holds in XMM registers (`recomp/vlocals.py`, the `RT_VLOCALS` accessors of `runtime/simd.h`): loaded at entry,
stored where they may have changed before calls and exits, reloaded after calls; `--v-trust` does not reload
V8-V15, whose low halves AAPCS64 has the callee preserve. K is 8 by default; K = 0 keeps every V register in the `Cpu`.
- Coverage oracle: MacNativeGames' NSO rewriter lists every site where game code touches the OS (SVCs, TLS reads, counter reads, `x18`, exclusive windows, jump tables): 68,968 sites in 1.4.3 `main`. The lifter must handle every one.
- Memory: guest address equals host address, all below 2^39 (IPC encodes 39-bit addresses). The heap, stacks and the alias region are reserved with `MEM_WRITE_WATCH`, so the graphics back end can ask which pages the CPU wrote since the last upload (`runtime/memory.c`).
- Indirect branches go through `rt_dispatch` (`runtime/dispatch.c`), which looks the target up in the address table and tail-calls it.
@@ -85,6 +89,10 @@ Every guest thread is a host thread. TotK assumes Horizon's scheduler: three app
- Vulkan 1.3 back end in place of MacNativeGames' Metal one. At `QueueSubmitCommands` the recorded NVN commands are replayed into Vulkan command buffers (`vk_exec*.c`).
- Memory pools. Apple's unified memory let MacNativeGames use the game's pools zero-copy. The back end imports the pools as host memory (`VK_EXT_external_memory_host`). On a discrete GPU, pools bound as buffers are mirrored in device-local memory and the pages the CPU wrote (write watch, above) are uploaded before a replay; idle pool regions are made read-only so the write-watch queries skip them (`vk_memory.c`). GPU-rendered textures are written back when the CPU reads them: on a pool invalidate, on a CPU copy, and for small targets once the CPU waits for a fence (`vk_texture.c`).
- Replay thread. `TOTK_REPLAY_ASYNC=1` moves the replay off the submitting thread onto a queue at most one frame behind the game; reads of GPU results wait for the newest writer instead of draining the queue (`vk_backend.c`). It is off by default. Where the game waits for the GPU it overlaps the replay with the game threads (a GTX 1650 in the Depths, issue #88), a gain measured only there; while it was the default, a GTX 1660 Ti at the 60 fps cap with the GPU at 26 % reported uneven motion (#659). It adds up to a frame of latency; `replay_async = 1` turns it on.
- Chunked replay. A large submission is recorded in chunks by several threads (`TOTK_REPLAY_WORKERS`, 0 by default: the sequential replay; 4 is a good value from 8 logical processors) and the chunks go to the queue in order (`vk_exec.c`). A sequential scan keeps a copy of the queue state where each chunk starts and lists what a chunk would otherwise learn from the chunks before it: inline uniform updates, conditions, contact shadow marches, uniform drops. It also makes render targets live in replay order and notes the op, since a chunk can sample a storage before the chunk that renders it got there or after the scan went past a later target there: a chunk's texture slots resolve as of its own op, and the chunks after a texture with no entry yet wait for the chunk that makes it. DLSS's decisions (the G-buffer, the light target, the end of the scene, the scaling pass) are the scan's too, and its copy of the lit scene and its evaluation are records of the chunk that holds the op; a chunk's draws are jittered while they come before the scan's end of the scene. The evaluation waits until the chunks before it are recorded, as it reads what their draws noted (the camera block, the jitter, the per-object motion list, which chunks add to under one lock), and the chunks after it wait for it, as they sample its output. `TOTK_REPLAY_STATE_CHECK=1` compares the state after the last chunk with the scan's.
- Frame ahead. `TOTK_SYNC_AHEAD=1` (`sync_ahead`, off by default) makes the one `nvnSyncWait` per frame that waits for the frame presented last wait for the frame before it, so the game builds the next frame while the GPU still runs the previous one (`nvn_api_core.c`, `nvnSyncWait`). The game then writes memory that in-flight work still reads. Two forms guard that. With shadow storage (`vk_memory.c`, the CPU-visible pools are host-visible copies of guest memory, on by default on Linux and Wine, `shadow = 1` (`TOTK_SHADOW=1`) on native Windows) a CPU write reaches the GPU only through the shadow copy made before each submit (`vk_mem_shadow_sync`), and a copy that would overwrite bytes an unfinished submission reads is queued as a GPU copy in the prologue command buffer of the part submitted next (`vk_mem_shadow_prologue`, `TOTK_SHADOW_DEFER=1`, the default with the feature) or, with `=0`, waited for on the replay thread (`shadow_reader_wait`). Only that one wait lags (identified by its call site, known for 1.1.0, 1.2.1 and 1.4.3). GPU writes into pool storage come back with their fence, so a buffer the game reads back every frame after that wait holds the result of the frame before; a buffer it has not read lately holds none, and its `nvnMemoryPoolInvalidateMappedRange` waits for the write (`vk_mem_shadow_read`): TotK reads single pixels through a buffer per request, and in the Depths zeros in one of them put Link in gloom. The exit line `mem: the game waited for a GPU write it reads` counts these waits and their time. On 1.4.3 the patch set `qstamp` (`recomp/patches-v143.txt`) lets the game take its depth query results one frame older; it follows the switch and is off when the switch is refused. The fence write-back of small render targets (`vk_texture.c`, `write_back_n`) does not wait for the GPU with `TOTK_WB_EAGER=1` (`wb_eager`, the default, but only while frame-ahead is in effect: with `sync_ahead` off or refused the setting does nothing and the write-back reads the image when it runs): `vk_sync_submit` has `vk_texture_eager_record` copy the targets that value rendered into staging buffers inside the same command buffer, so once the value has passed the write-back only copies from staging into the target's storage. Only a target that was written back within the last 64 timeline values is copied (the first write-back of a target takes the blocking path), and the staging of a target past that window, no longer wanted or released goes through the deferred free (`vk_defer_buffer_until`). A snapshot is used only when its value is the one that last rendered the target, nothing recorded a write to the image since (`wr_fence`) and the GPU has finished it; otherwise the write-back reads the image as before, and the exit line `vk: wb_eager:` counts the reasons. With frame-ahead in effect the exit line `vk: fence write-backs waited for the GPU` counts the write-backs that waited for a copy and the time they waited, for every value of the setting. `check` also reads the old way and compares.
- Frame ahead in place. Without shadow storage the GPU reads the game's own memory, as in Savage Wind's overlap, and `vk_ahead_init` (`runtime/vk_ahead.c`) turns on guards for what the GPU reads or writes there after the recording, each with a switch `TOTK_SYNC_AHEAD_<NAME>` (1 by default unless noted) for A/B runs. `MSYNC`: the VRAM mirrors' sync copies take the synced pages from a staging copy the replay thread makes at submit (`vk_memory.c` `stage_ranges`), not from guest memory when the GPU runs them; the frame wait returns only after the replay submitted the asked value, so those are that frame's bytes. A synced range that an earlier value still writes back into waits for that value first, or the copy would drop its GPU words. `WBMERGE`: every GPU write into a mirror goes back through the word merge (`wb_merge_record`), so a write-back that lands after the game wrote the range for the next frame puts back only the words the GPU changed. `DESWZ`: a texture the CPU rewrote after its last upload is deswizzled on the CPU (`upload_gpu`, reason `frame ahead`). `READS`: GPU writes into CPU-visible memory are listed with their value until it completes (bounded, `aw_add`), and an invalidate of a range not read lately waits for the writer's own value (`ahead_read`). `ONESHOT`: the frame wait waits up to the value that rendered a dirty small target not written back within the last 16 frames (Savage Wind's one-off rule, `vk_texture_oneshot`), so a photo or a pick reads its own frame, while targets read every frame or in turns get the frame before. `QUERIES` (0 by default): the same for samples-passed reports; TotK reads those two updates after it asks (1.2.1 `f_70010c3298`). With import memory (`TOTK_MEMORY=import`, the integrated-GPU mode) the GPU reads vertex, index and storage data in place, which no guard covers (a check run saw the game rewrite about 10 KiB of them a frame after the wait, particles mostly), so the switch is refused there without shadow storage. The exit lines `mem: sync-ahead in place` and `sync-ahead: frame waits made exact` give the guards' waits and copies. `TOTK_SYNC_AHEAD_CHECK=1` runs the detector below with the late wait itself.
- Frame-ahead check. `TOTK_SYNC_AHEAD=check` keeps the frame wait exact and measures what a one-frame-late wait without shadow storage would race (`runtime/vk_ahead.c`). The replay notes, with each submission's value, every access of guest memory the GPU makes after the recording: in-place bindings of imported pools without a VRAM mirror (`VK_AHEAD_READ`), the mirror's sync copies (`vk_mem_mirror_prologue`), GPU deswizzle sources (`vk_texture.c` `upload_gpu`) and the mirror write-backs (`vk_mem_mirror_end`). At the frame wait for value A, whose late form would have waited for L, the notes of values in (L, A] form the frame's read set: merged per class, gap-joined into at most 512 write-watch queries that stamp the writes made so far into the shared page generations (`vk_mem_ahead_observe`). At the next frame-wait entry the queries run again, and every page of the set stamped since is a CPU write the late wait would have raced; memory without a write watch is compared by page hashes. GPU writes into CPU-visible memory and reports are listed with their value: an invalidate of a range written by a value in (L, A] of the last frame wait, and the fence write-back of a small target rendered by one, count as stale readbacks. One line `sync-ahead check:` per second of host time and a run summary with the largest offenders by pool at exit. `--probe-vkmem` checks the detector on a watched pool (`vk_ahead_selftest`); `tests/sync_ahead_check.py` checks that the wait stays exact.
- Recorder thread. The Vulkan calls the replay makes into its command buffer are made by a thread of their own (`vk_rec.c`, after Savage Wind Recomp and LAS Recomp): each `vkCmd*` copies its arguments into a packet of a ring and the recorder makes the calls in order; calls into other command buffers are made at once; the recorder also ends the command buffer, and the submit waits until it has. In the town on an RX 9070 the replay takes 17% less time on the submitting thread. It is off by default on AMD GPUs, where the driver loses the device or hangs the GPU at startup with it (`TOTK_VK_RECORDER=1` forces it on, `=0` makes every call on the submitting thread).
- Uniform snapshot. The game rewrites per-object uniform blocks on other threads soon after it submits the frame
that reads them, while the replay still records it. At the start of a submission's replay every uniform range it
@@ -103,11 +111,13 @@ Every guest thread is a host thread. TotK assumes Horizon's scheduler: three app
RCAS) on the present. An `output_res` that is not 16:9 (more than 1% off, `res_is_16x9`) also switches on the
`aspect` patch set, which hands the output's ratio to the camera, and `romfs.c` `overlay_init` loads the
`romfs-patches-<w>x<h>` overlay for it when it exists (`tools/make_romfs_patches.py --aspect`, laid out by
`tools/ultrawide_layout.py`; the installer builds fifteen sizes: 21:9 2560x1080, 3440x1440, 3840x1600, 5120x2160,
32:9 3840x1080, 5120x1440, 16:10 1280x800, 1680x1050, 1920x1200, 2560x1600 and 3:2 1920x1280, 2160x1440, 2256x1504,
2880x1920, 3000x2000). A wider layout moves the HUD to the
screen's corners, a narrower one to its top and bottom edges. Other sizes get the camera of their shape and the 16:9
HUD stretched over it. The `aspect` setting (`fit`, the default; `stretch`) decides what the present does
`tools/ultrawide_layout.py`; installer/steps.py Shapes builds one canonical folder per needed display/output shape,
chosen by installer/screens.py). A wider layout moves the HUD to the
screen's corners (`hud_width = 21:9` or `16:9` keeps it in the middle of the screen instead, from the `-hud21x9` or
`-hud16x9` variant of the folder), a narrower one to its top and bottom edges. Shapes generates a capped variant
only when selected, alongside the full layout and selected button prompts. `romfs.c` `shaped_name` checks the exact
size then its canonical shape; a missing cap falls back to full, while the menu still offers preparation for the cap.
Without any matching layout the output falls back to 16:9. The `aspect` setting (`fit`, the default; `stretch`) decides what the present does
when the window's shape differs from the output's: `fit` letterboxes, where a 16:9 game in a wider window used to be
stretched.
- HDR (`hdr = 1`, `vk_hdr.c`). The game tonemaps its scene into an r11g11b10f target, upscales it and draws the HUD
+46 -33
View File
@@ -100,7 +100,7 @@ of them.
objects before it links: any AVX, BMI or other instruction above x86-64-v2 outside a function listed there as
dispatched by a runtime CPU check stops the build.
`gen.py` sizes its emit pool from the CPU count and the free memory; `--jobs N` sets it, and so does the environment variable `TOTK_LIFT_JOBS=N`, which the installer's lift step honours too (it has no `--jobs`). When a worker runs out of memory, the pool restarts with half the workers (`emit: out of memory with N workers, retrying with M`), down to one; only an out-of-memory error with one worker fails the step.
`gen.py` sizes its emit pool from the CPU count and the free memory; `--jobs N` sets it, and so does the environment variable `TOTK_LIFT_JOBS=N`, which the installer's lift step honours too (it has no `--jobs`). When a worker runs out of memory, the pool restarts with half the workers (`emit: out of memory with N workers, retrying with M`), down to one; only an out-of-memory error with one worker fails the step. A later lift into the same `--out` lifts again only the chunks whose inputs changed (`<mod>/lift_cache.json`, see the top of `recomp/gen.py`); `--no-cache`, or `TOTK_LIFT_CACHE=0` (which the installer's lift step honours too), lifts every chunk.
Lifting takes about 15 s, a clean compile about 200 s on 24 threads; later builds recompile only what changed.
A compiler cache in front of clang shortens it further: with `SCCACHE` set to an sccache executable, `build_game.py`
@@ -111,18 +111,37 @@ of them.
$env:SCCACHE = "path\to\sccache.exe"
.venv\Scripts\python tools\build_game.py --version <ver>
```
A build into another `--out` (a task build, or a private lift of a patch change with `--gen generated\<ver>-<tag>`)
hardlinks the objects of the main build `build\<ver>` and compiles only `runtime/` and the generated files whose
compile differs. An object is reused when the main `build.ninja` has the same compiler, flags and rule, the main
build is up to date, and every file its compile read according to the main Ninja deps log (the `.c`, the `runtime/`
and generated headers, the system headers) has the same bytes in this build's trees and has not changed since the
object was written, and neither has the compiler. A lift that changes one patch site then compiles one or two chunks
instead of all of them. The build prints `reused N of M generated objects`; `--verbose` lists the others with the
reason, and `--full-build` compiles everything.
`--patches` builds in the frame-rate, resolution and other patch sets, switchable at run time. The link copies
`SDL3.dll`, `libiconv-2.dll` and `libopus-0.dll` next to the exe.
For Xbox button prompts, run `make_romfs_patches.py` twice more, with `--prompts xbox` and `--prompts xbox-label`:
they write `build\<ver>\romfs-patches-xbox` and `romfs-patches-xbox-label` ([controls.md](controls.md), "Xbox
button prompts"), which `build_game.py` copies next to `totk.exe` like `romfs-patches`. `--prompts pc` writes
`romfs-patches-pc`, the keyboard and mouse prompts ([controls.md](controls.md), "PC button prompts").
For Xbox and PlayStation button prompts, run `make_romfs_patches.py` twice more for each, with `--prompts xbox`,
`--prompts xbox-label`, `--prompts playstation` and `--prompts playstation-xbox`: they write
`build\<ver>\romfs-patches-xbox`, `-xbox-label`, `-playstation` and `-playstation-xbox`
([controls.md](controls.md), "Xbox and PlayStation button prompts"), which `build_game.py` copies next to `totk.exe`
like `romfs-patches`. `--prompts pc` writes `romfs-patches-pc`, the keyboard and mouse prompts
([controls.md](controls.md), "PC button prompts").
`--aspect <w>x<h>` writes the UI laid out for a game resolution of another shape; with `--hud 16:9` or `--hud 21:9`
(a screen wider than that) the HUD stays within the middle 16:9 or 21:9 instead of the screen's corners. The default
`--out` then is `build\<ver>\romfs-patches-<w>x<h>-hud16x9` (`-hud21x9`), which the game loads for `hud_width = 16:9`
(`21:9`) in `totk.ini` ([totk.ini.example](../totk.ini.example)).
Setup's Shapes step builds only the currently selected cap for the canonical shapes needed by connected displays
and `output_res`, together with the selected prompts. `full` generates no capped folders. After changing the HUD
width, use the Screen tab's layout preparation action or rerun setup before restarting the game. Lookup prefers
the selected cap at the exact or canonical size before falling back to a full-width layout.
A build from source has no layouts for other shapes than 16:9. At an `output_res` such as 5120x1440 the game then
draws the largest 16:9 size inside it (2560x1440) and the present adds bars, instead of a wide camera over a
stretched HUD (`runtime/resolution.c`, `shape_fallback`). For the full shape make `romfs-patches-<w>x<h>` once per
size: `make_romfs_patches.py --version <ver> --aspect <w>x<h> --out build\<ver>\romfs-patches-<w>x<h>` (the sizes
the installer makes are `ASPECT_SIZES` in `installer/steps.py`); `build_game.py` copies every `romfs-patches*`
the installer maps to are in `installer/screens.py`); `build_game.py` copies every `romfs-patches*`
folder next to `totk.exe`.
6. Prepare the shaders (once per build folder and translator). It needs `refs\MacNativeGames` (`tools\fetch_refs.sh`)
@@ -160,30 +179,9 @@ folder. The folder holds code and data derived from your game: for your own mach
### Profile-guided build
`build_game.py --pgo <file>.profdata` compiles the generated code at -O2 with an execution profile, and the runtime
with it too: hot paths laid out straight, hot calls inlined, code that never ran compiled for size. On 1.4.3 the fight
bench ran 12-15% faster per frame and a fight outside the training about 6%. The installer builds with
`data/pgo-<ver>.profdata` of the release when the update has one, else at -O1.
A profile only fits the generated C it was trained on: functions are matched by name and control-flow hash, so a
function whose C changes loses its counts without a warning. Retrain after a lifter or generator change, from a clean
`recomp/`. The instrumented build needs llvm-mingw, as MSYS2's clang has no profile runtime:
```powershell
$llvm = "toolchain\llvm-mingw-<date>\llvm-mingw-<date>-ucrt-x86_64"
.venv\Scripts\python tools\build_game.py --version v143 --out build\v143-pgogen --toolchain $llvm --pgo gen
```
Play `build\v143-pgogen\totk.exe` through varied scenes (fights, towns, riding, building, the Depths, menus) for 20-30
minutes; it is slower than a normal build. It writes `build\v143-pgogen\pgo\*.profraw` every minute and at exit.
Scripted runs from saves (`tools/run_game.py`) add to the same file. Then:
```powershell
.venv\Scripts\python tools\pgo.py merge build\v143-pgogen --version v143
```
writes `build\pgo\pgo-v143.profdata` and its record (`.json`: the `recomp/` tree it fits). `make_release.py` ships every
profile of `build\pgo` in `data\` and warns when a record names another `recomp/` tree than the one released.
`build_game.py --pgo <file>.profdata` compiles the generated code and the runtime at -O2 with an execution
profile, 6-12% shorter frames. Which build uses which profile, when to retrain, where and how to train and how to
measure a new profile: [pgo.md](pgo.md).
## Linux (in progress)
@@ -221,7 +219,7 @@ re-protecting imported memory invalidates the driver's userptr buffer on every s
amdgpu), and importing pins the pages, which drops their write protection. Each CPU-visible pool therefore gets a
host-visible copy (shadow storage, `runtime/vk_memory.c`): the pages the CPU wrote go in before each submit, and the GPU's
writes come back at its fence. In play that costs about 0.2 ms a frame and doubles the memory of those pools (about
1.1 GB). `TOTK_SHADOW=1` turns it on under Windows too. The Steam Deck's RADV has `VK_EXT_external_memory_host` as
1.1 GB). `shadow = 1` in `totk.ini` (or `TOTK_SHADOW=1`) turns it on under Windows too. The Steam Deck's RADV has `VK_EXT_external_memory_host` as
well: the shadow copies are chosen for the measured cost above, not for a missing extension.
The Deck's GPU (Van Gogh) has no native ASTC, so its textures go through the compute decoder (`runtime/vk_astc.c`,
@@ -238,10 +236,25 @@ Before a commit:
A change to the button prompts (`tools/make_romfs_patches.py --prompts`, `tools/button_icons.py`) passes
`.venv-py314\Scripts\python tests\romfs_prompts_test.py`, which runs the tool on a RomFS it makes itself (no game
files); a change to the settings passes `totk.exe --probe-cfg` and `python tests\settings_doc_check.py`, which fails
when a setting is described neither in `totk.ini.example` nor in [settings.md](settings.md). A change to the mods' ExeFS patches
when a setting is described neither in `totk.ini.example` nor in [settings.md](settings.md).
HUD pane/animation and generator naming regressions run with Python 3.14+: `tests/hud_layout_test.py`.
Set `HUD_TEST_ROMFS` to a verified extracted RomFS directory to include a real-archive comparison against the
pre-port layout generator; all game-derived temporary data stays under `build/`.
`python tests/romfs_shapes_check.py --cc <clang>` compiles the production folder-selection and preparation helpers
to check canonical aliases, capped/full fallback, prompt arguments, the missing 16:9 prompts and generation
deduplication without game files. `tests/romfs_prompts_test.py` checks that two `--background` runs for one folder
publish it once and that a folder with a manifest is kept.
A change to the mods' ExeFS patches
(`tools/exefs_patches.py`, `runtime/mods.c`, the `folded.txt` of `recomp/gen.py`) passes
`.venv\Scripts\python tests\exefs_patches_test.py`, which makes its own modules and runs `gen.py` on one with a jump
table (no game files), and `totk.exe --probe-mods`.
table (no game files), and `totk.exe --probe-mods`. A change to the cheat VM or the cheat opcode tables
(`runtime/cheats.c`, `tools/cheats.py`) passes `.venv\Scripts\python tests\cheats_vm_check.py`, which runs both on
cheats of its own with clang from PATH (`--cc` names another). A change to what a generated chunk depends on, or to
the lift cache of `recomp/gen.py` (`<mod>/lift_cache.json`), passes `.venv\Scripts\python tests\lift_cache_test.py`,
which lifts a module it makes itself with and without the cache and compares the output (no game files); a new input
of the chunk text goes into `chunk_key` with a case there. On game files, a lift with the cache into a used output
folder and a `--no-cache` lift into an empty one give the same files apart from `manifest.json` and
`lift_cache.json`.
The lifter (`recomp/`) and the CPU headers (`runtime/cpu.h`, `runtime/simd.h`) are checked against Unicorn. Every lifter
change passes these, all run with `.venv`:
+2 -2
View File
@@ -58,7 +58,7 @@ The game's code is compiled ahead of time, so a cheat cannot write new instructi
|---|---|---|
| code | Opcode 0 writes into main's code | Built into the game at setup as a patch set (`recomp/patches.py`); switches at once. |
| key | Code writes inside a button condition (`8` mask, writes, `21` else, the original words, `20`) | A patch set that is on while the cheat is on and the buttons are held. |
| data | Writes data only: heap, main's data, pointer chains, button conditions | Runs in a cheat VM after dmnt's, opcodes 0 to A, every presented frame while on. |
| data | Writes data only: heap, main's data, pointer chains, button conditions | Runs in a cheat VM after dmnt's, opcodes 0 to A and C0 to C3, every presented frame while on. |
| master | `{name}` with code writes | A patch set that is always on. |
| restore | Writes back only the game's original instructions | Not needed: switching a cheat off restores them. Greyed out. |
@@ -66,7 +66,7 @@ A cheat whose code writes call or jump into a code cave the cheat writes itself
Not supported, and shown greyed out with the reason:
- the 0xC and 0xF opcode extensions;
- opcode C4 (extended button condition) and the 0xF extensions (FF0 pause, FF1 resume, FFF debug log);
- opcode 5 with a register offset;
- code writes mixed with other opcodes, except the button pattern above;
- code writes that change the CPU flags differently from the game's instruction, or code caves with branches or pc-relative instructions.
+139 -15
View File
@@ -8,7 +8,7 @@ Input comes from the first SDL3 gamepad, the keyboard and the mouse, merged into
- `xbox`: south A, east B, west X, north Y, as an Xbox pad labels them; on a PlayStation pad cross is A, circle B, square X, triangle Y.
- `auto` (default): `nintendo` for a pad whose east button SDL reports labelled A (Switch Pro Controller, Nintendo-layout pads), `xbox` for the others.
The log names the layout in effect (`input: gamepad layout ...`); the menu shows it under *Automatic*. Which controller's buttons the game's prompts show is `TOTK_PROMPTS` (see Xbox button prompts below). 0.1.9's `pad_layout = xbox_prompts` is read as `pad_layout = nintendo` with `prompts = xbox`, and the menu writes it that way.
The log names the layout in effect (`input: gamepad layout ...`); the menu shows it under *Automatic*. Which controller's buttons the game's prompts show is `TOTK_PROMPTS` (see Button prompts below). 0.1.9's `pad_layout = xbox_prompts` is read as `pad_layout = nintendo` with `prompts = xbox`, and the menu writes it that way.
| Switch | Gamepad (by position, Nintendo layout) | Keyboard and mouse | Action in the world |
|---|---|---|---|
@@ -29,11 +29,11 @@ The log names the layout in effect (`input: gamepad layout ...`); the menu shows
| Minus | Back | M | map |
| Right stick shaken left and right | shake the right stick | G | detach a fused part from what Ultrahand holds |
Esc is unbound in the game; it opens the settings menu and releases the mouse cursor (see Mouse camera). Z and X duplicate ZL and ZR so menu pages turn with two neighbouring keys; the menu tabs (L, R) are Q and R. T duplicates Y for the game's menus, where the left mouse button is A while the pointer is shown (sort the inventory with T). The mouse wheel zooms the Purah Pad's map and is unbound elsewhere. The bindings are the tables of `input_map` in `runtime/input_map.c`: the keys (platform-neutral key ids) and one gamepad table per layout (gamepad inputs by position); `runtime/input_win.c` translates Win32 virtual keys and SDL buttons.
Esc is unbound in the game; it opens the settings menu and releases the mouse cursor (see Mouse camera). Z and X duplicate ZL and ZR so menu pages turn with two neighbouring keys; the menu tabs (L, R) are Q and R. T duplicates Y for the game's menus, where the left mouse button is A while the pointer is shown (sort the inventory with T). The mouse wheel zooms the Purah Pad's map and its camera, steps the game's menus and the d-pad strips (see Mouse in the game's menus), and is unbound elsewhere. The bindings are the tables of `input_map` in `runtime/input_map.c`: the keys (platform-neutral key ids) and one gamepad table per layout (gamepad inputs by position); `runtime/input_win.c` translates Win32 virtual keys and SDL buttons.
## Xbox button prompts
## Xbox and PlayStation button prompts
`TOTK_PROMPTS` (`prompts`, the *Button prompts* row on the Controls tab, read at start) picks the controller whose buttons the game's prompts show: `nintendo` (default) keeps the game's own, `xbox` shows an Xbox controller's, `pc` the keyboard and mouse (PC button prompts, below).
`TOTK_PROMPTS` (`prompts`, the *Button prompts* row on the Controls tab, read at start) picks the controller whose buttons the game's prompts show: `nintendo` (default) keeps the game's own, `xbox` shows an Xbox controller's, `playstation` a PlayStation controller's, `pc` the keyboard and mouse (PC button prompts, below).
- L, R, ZL, ZR, Plus and Minus become LB, RB, LT, RT, Menu and View, and the d-pad prompts a cross with an arrow for each direction meant. The letters on the keys are cut out in the game's own text font.
- A, B, X and Y name the label of the button the pad layout presses, so each prompt names the button to press. `pad_layout = nintendo` plays an Xbox pad by position: the right button, labelled B, does Switch A (interact, confirm), and the bottom one, labelled A, does Switch B (run, cancel), so the prompts swap A with B and X with Y. `xbox` and `auto` put Switch A on the button labelled A, and the letters stay.
@@ -48,14 +48,34 @@ Esc is unbound in the game; it opens the settings menu and releases the mouse cu
The action prompt (`DoCommand_00`) shows its button in a diamond whose shape gives the face buttons' positions as on a Switch, with the other three letters around it. With `nintendo` its letters are swapped with the rest and every one names the button in that place. With `xbox` and `auto` the letters stay and the diamond is laid out as an Xbox pad: A at the bottom, B on the right, X on the left and Y at the top, the button the prompt names lit in its place, its bar reaching left from X and right from the others (`tools/make_romfs_patches.py`, `bflyt_xbox_diamond`: the panes of `blyt/DoCommand_00.bflyt` take their partner's place, A's of B and X's of Y). The sticks keep the Switch icons, and so do prompts drawn as fixed images (some tutorial animations).
The prompts are part of the game's fonts, textures and messages, so they follow the layout and not the bindings. A button remapped with a `bind_` line or on the Controls tab keeps the prompt the game draws for it, which then names the wrong button. Use the Xbox prompts with the default bindings.
### PlayStation
`prompts = playstation` shows a PlayStation pad's buttons: the face buttons as ○ (circle), × (cross), △ (triangle) and □ (square), L1, R1, L2 and R2 on the shoulders and triggers, Options and Share on Plus and Minus, and the d-pad as a cross. Each prompt names the button to press, so the shapes follow `pad_layout`:
| Switch | `nintendo` layout | `xbox` or `auto` layout |
|---|---|---|
| A, B, X, Y | ○, ×, △, □ | ×, ○, □, △ |
| L, R | L1, R1 | L1, R1 |
| ZL, ZR | L2, R2 | L2, R2 |
| Plus, Minus | Options, Share | Options, Share |
| D-pad | cross | cross |
The game's text fonts already have the four shapes (U+25CB, U+00D7, U+25B3 and U+25A1), so the action prompt's diamond uses them as text; the action prompt's button image and the button guide's images are drawn with the same shapes. The game loads `romfs-patches-playstation` (`pad_layout = nintendo`) or `romfs-patches-playstation-xbox` (`xbox`, `auto`) in place of `romfs-patches`; the setup writes both with `tools/make_romfs_patches.py --prompts playstation` and `--prompts playstation-xbox` (`tools/button_icons.py`, `playstation_icons`). With `xbox` and `auto` the diamond is laid out as for the Xbox prompts: × at the bottom, ○ on the right, □ on the left and △ at the top. At a game resolution of another shape the prompts follow the shape's UI layout as the Xbox ones do (below).
The prompts are part of the game's fonts, textures and messages, so they follow the layout and not the bindings. A button remapped with a `bind_` line or on the Controls tab keeps the prompt the game draws for it, which then names the wrong button. Use the Xbox or PlayStation prompts with the default bindings.
The game reads its UI archive and fonts once at boot, so the prompts change at the next start, also after `pad_layout` changes between `nintendo` and the others (the menu says *prompts change after restart*); the buttons change at once. Under that note the menu offers *Restart now*: after a confirmation it writes `totk.ini`, closes the game as *Quit game* does and starts the game again with the same command line, which waits until the old process is gone before it opens the log and the saves (`runtime/gfx_present.c`, `gfx_window_closed`; `plat_restart` and `plat_restart_wait` in `runtime/platform/win32.c` and `linux.c`). Progress since the last save is lost, as with *Quit game*; while the game writes a save, the confirmation waits. With `prompts = xbox` the game loads `romfs-patches-xbox` (`pad_layout = nintendo`) or `romfs-patches-xbox-label` (`xbox`, `auto`) next to `romfs-index.bin` in place of `romfs-patches` (`runtime/romfs.c`, `overlay_init`; `runtime/input_map.c`, `input_prompts_folder`): the same 60 fps patches, with the prompts drawn from the game's own files by `tools/make_romfs_patches.py --prompts xbox` or `--prompts xbox-label` (`tools/button_icons.py`, after MacNativeGames' `make_button_icons.py`), which the setup runs next to the plain one:
- every prompt but the button guide in play is text in the button font, `scft/External.bfotf` in each `Font/Font*.Nin_NX_NVN.bfarc.zs`: glyphs U+E040 to U+E043 (A B X Y), U+E044 to U+E047 (L R ZL ZR), U+E04B and U+E04C (Plus, Minus), U+E049 and U+E060 to U+E065 (the d-pad). fontTools writes the font again, so the archives grow and the folder also carries the resource size table (`System/Resource/ResourceSizeTable.Product.<n>...rsizetable.zs`) with their entries raised by as much; without that the game stops at start.
- the button guide in play draws L and ZL from the images `Nt_KeyTexL_00` and `Nt_KeyTexZL_00` of the Common archive's `timg/__Combined.bntx`, painted with the same icons. The action prompt draws its button from `Nt_KeyTexA/B/X/Y_00`, whose image data is swapped for `nintendo`, and the diamond's letters are text the game takes from `LayoutMsg/DoCommand_00.msbt` of each language's `Mals` archive (and the layout's own text panes behind it), swapped the same way.
The Switch prompts stay, with a note under *Button prompts* and a `RomFS overlay: ...` line in the log, when the folder is missing (an install made by an older setup, or one where the setup could not prepare it and showed a warning; running the setup again on the install folder writes it), when it fails its check, with a game resolution of another shape than 16:9 (its own UI layout wins; 16:10 and 21:9), and when the `romfs_mods` folder replaces one of its files: `romfs-patches` then loads in its place, where two overlays replacing one file would stop the game. In a source build, `.venv-py314\Scripts\python tools\make_romfs_patches.py --version <ver> --prompts xbox` (and `--prompts xbox-label`) writes `build\<ver>\romfs-patches-xbox` (`-label`); it needs fontTools from `tools/requirements-py314.txt`. `--xbox-prompts` is the older name of `--prompts xbox`.
With `prompts = playstation` the game loads `romfs-patches-playstation` (`pad_layout = nintendo`) or `romfs-patches-playstation-xbox` (`xbox`, `auto`) the same way, written by `tools/make_romfs_patches.py --prompts playstation` and `--prompts playstation-xbox`: the same 60 fps patches, with the face buttons' images and the diamond's letters drawn as ○ × △ □, the shoulders and triggers as L1 R1 L2 R2, Options and Share, and the button guide's L and ZL images. The game's text fonts already have the four shapes, so the diamond's panes and messages hold those characters instead of the letters.
The Switch prompts stay, with a note under *Button prompts* and a `RomFS overlay: ...` line in the log, when the folder is missing (an install made by an older setup, or one where the setup could not prepare it and showed a warning; running the setup again on the install folder writes it; an install whose setup's tools sit next to the game makes it itself, see below), when it fails its check, with a game resolution of another shape than 16:9 that has no folder of its own (below), and when the `romfs_mods` folder replaces one of its files: `romfs-patches` then loads in its place, where two overlays replacing one file would stop the game. In a source build, `.venv-py314\Scripts\python tools\make_romfs_patches.py --version <ver> --prompts xbox` (and `--prompts xbox-label`) writes `build\<ver>\romfs-patches-xbox` (`-label`); `--prompts playstation` and `--prompts playstation-xbox` write `build\<ver>\romfs-patches-playstation` and `-playstation-xbox` the same way. It needs fontTools from `tools/requirements-py314.txt`. `--xbox-prompts` is the older name of `--prompts xbox`.
A missing prompts folder, at 16:9 or of a game resolution's shape, is made by the game itself on an install whose setup left its tools next to the game (`build-cache/rebuild.txt`): choosing those prompts or a pad layout that needs it, or starting the game with them selected, starts `make_romfs_patches.py --background` for it (`runtime/romfs.c`, `romfs_folders_prepare`; `runtime/ui/menu.cpp`, `folders_tick`, once the choice has stayed for 1.5 seconds). The note says *prompt files being made in the background; used at the next start*; when the tools did not start it says so and *Try again* starts them again. A source build has no `rebuild.txt` and keeps the notes above.
At a game resolution of another shape than 16:9 the game loads `romfs-patches-<style>-<w>x<h>` (`romfs-patches-xbox-<w>x<h>`, `-xbox-label-`, `-playstation-` or `-playstation-xbox-`) in place of `romfs-patches-<w>x<h>`: the same prompts with that shape's UI layout, `make_romfs_patches.py --prompts <style> --aspect <w>x<h> --reuse <install>\romfs-patches-<style> --out <install>\romfs-patches-<style>-<w>x<h>`. The setup writes it for the shapes of the connected displays and `output_res`, for the selected prompts only (installer Shapes step), as for the PC prompts below. At another size, without that folder, the Switch prompts stay (*off at this game resolution*) until the game has made it in the background (above).
## PC button prompts
@@ -63,17 +83,18 @@ The Switch prompts stay, with a note under *Button prompts* and a `RomFS overlay
| Switch | Prompt |
|---|---|
| A, B, X, Y | E, Shift, Space, left click |
| A, B, X, Y | E, Shift, Space, left click (T in text prompts) |
| L, R, ZL, ZR | Q, R, right click, F |
| Plus, Minus | Tab, M |
| D-pad | 1 (left), 2 (up), 3 (right), 4 (down), as a cross or the keys of the directions meant |
| Left stick, its press | W A S D (or the keys of the directions meant), Ctrl |
| Right stick, its press | the mouse, with an arrow for each direction meant, C |
- The glyphs keep the width of the game's own, so the right-aligned guides do not run into their text. A key is a rounded square with its label cut out in the game's own text fonts; a mouse button is a mouse with that button filled and the others hollow.
- The glyphs keep the width of the game's own, so the right-aligned guides do not run into their text. A key is a rounded square with its label cut out in the game's own text fonts (Shift: an arrow over its name); a mouse button is a mouse with that button filled and the others hollow.
- The button guide in play draws every button from images of the Common archive (`Nt_KeyTexA/B/X/Y/L/ZL_00`, `Nt_KeyTexLSt_00` and `_01`, the stick tilted and pressed): all of them are painted with the same icons. The letters of the action prompt's diamond are one character of the Normal font each: E, an arrow for Shift, a bar for Space, L and R for the mouse buttons.
- Like the Xbox prompts they follow the defaults and not the bindings. `--binds <totk.ini>` draws the first key of each `bind_` line of that file instead, for a folder made by hand.
- At a game resolution of another shape than 16:9 the game loads `romfs-patches-pc-<w>x<h>` in place of `romfs-patches-<w>x<h>` when it is there: the same prompts with that shape's UI layout, `make_romfs_patches.py --prompts pc --aspect <w>x<h> --out <install>\romfs-patches-pc-<w>x<h>`. The setup does not write those, so without one the Switch prompts stay (*off at a game resolution not 16:9*).
- Y has two keys, the left mouse button and T. The button guide in play and the action prompt show the left button, which attacks there; the prompts in text (the menus' guides such as *Sort*, the dialogue log's) show T, because while a menu has the pointer the left button is that menu's A, and T presses Y everywhere (`PC_TEXT_KEYS` in `tools/button_icons.py`). With a `bind_y` line, the text prompts take its first key that is not a mouse button (its only key when all are mouse buttons).
- They follow the bindings of the install's `totk.ini` as the setup found them: its *Drawing the keyboard and mouse prompts* step passes the file as `--binds` (the first key of each `bind_` line), and the keyboard defaults without one. After a change on the Controls tab run the setup again: that step alone runs, since it is keyed by the `bind_` lines (`PcPrompts` in `installer/steps.py`). The Xbox prompts follow the defaults.
- At a game resolution of another shape than 16:9 the game loads `romfs-patches-pc-<w>x<h>` in place of `romfs-patches-<w>x<h>`: the same prompts with that shape's UI layout, `make_romfs_patches.py --prompts pc --aspect <w>x<h> --reuse <install>\romfs-patches-pc --out <install>\romfs-patches-pc-<w>x<h>`. The setup writes one for each of the fifteen sizes it lays the UI out for, so on a display of one of those shapes the game resolution follows the display with these prompts too. At another size, without that folder, the Switch prompts stay (*off at this game resolution*).
## Window keys
@@ -82,6 +103,7 @@ The Switch prompts stay, with a note under *Button prompts* and a `RomFS overlay
| F1 or Esc | Minus and Plus together | open or close the settings menu; the game gets no input while it is open |
| F10 | L3 + R3 (both stick clicks) | performance overlay: off, frame rate, full panel |
| F11 | | borderless fullscreen on or off, saved to `totk.ini` |
| F6, F7 | | with `quicksave = 1`: quick save and quick load, as in Half-Life, with no menu; `quicksave_key` and `quickload_key` choose other keys ([Quick save](#quick-save)) |
The Minus+Plus combo never reaches the game. In the menu the arrow keys, the D-pad or the left stick move, Enter or A selects, Q and E or L and R switch tabs, Esc or B goes back (Switch button names, as in the table above).
@@ -91,7 +113,7 @@ The *Controls* tab of the settings menu lists, under the button layout, every Sw
The tab writes `totk.ini` lines, one per Switch button or stick direction: `bind_<button> = <entry>, <entry>, ...`. The button is `A B X Y L R ZL ZR PLUS MINUS LEFT UP RIGHT DOWN LCLICK RCLICK`, or a stick direction `LSTICK_LEFT LSTICK_UP LSTICK_RIGHT LSTICK_DOWN` (movement, W A S D by default) and `RSTICK_...` (camera, the arrow keys), or `SHAKE` (keys only, G by default). An entry is `pad:<name>` or `key:<name>`:
- pad names: `south east west north l r zl zr start back lstick rstick dpad_left dpad_up dpad_right dpad_down lpaddle1 rpaddle1 lpaddle2 rpaddle2` (`zl`, `zr` are the triggers; the paddles are the back buttons of an Xbox Elite, DualSense Edge or Steam Controller, upper pair 1, lower pair 2, and no Switch button has them by default)
- pad names: `south east west north l r zl zr start back lstick rstick dpad_left dpad_up dpad_right dpad_down lpaddle1 rpaddle1 lpaddle2 rpaddle2 touchpad` (`zl`, `zr` are the triggers; the paddles are the back buttons of an Xbox Elite, DualSense Edge or Steam Controller, upper pair 1, lower pair 2; `touchpad` is the touchpad click of a DualSense or DualShock 4; no Switch button has the paddles or the touchpad by default)
- key names: `a` to `z`, `0` to `9`, `f2` to `f7`, `f9`, `f12`, `num0` to `num9`, `space tab enter backspace lshift rshift lctrl rctrl lalt capslock insert delete home end pageup pagedown up down left right`, `num_add num_sub num_mul num_div num_decimal`, `minus equals lbracket rbracket semicolon apostrophe comma period slash backslash grave`, `mouse_l mouse_r mouse_m mouse_x1 mouse_x2`
- `key:default` and `pad:default` keep that part's defaults (`pad:default` is each layout's own button).
- `none` leaves the button unbound.
@@ -107,6 +129,40 @@ bind_X = pad:west, key:space
bind_Y = pad:north, key:mouse_l
```
## Free camera
On game 1.4.3, a chosen gamepad combo or a key steps the free camera through three stages: move, lock, and off again.
It is off by default: turn on *Free camera* on the Controls tab (`freecam_patch = 1`) and restart. Then pick the
combo or the key, neither set by default, with `freecam_pad` and `freecam_key` in `totk.ini` or on the Controls tab
(for example ZL+ZR+L3, LT+RT+L3 on an Xbox pad, and F2; `none` turns one off). An input script can press the combo as a
gamepad would; the keys bound to its buttons do not. While the free camera moves, the world goes on but the game gets
no input, so Link stands where he was.
Locked, the view stays where the flight left it and the game gets its input back. Link walks where the left stick
points on screen, as the game steers him by the camera it draws. The right stick and the mouse turn the game camera,
which still follows Link unseen.
| Gamepad | Keyboard and mouse (default bindings) | Free camera |
|---|---|---|
| Left stick | W A S D | forward and back along the view, and sideways |
| ZR / ZL (RT / LT) | X / Z | straight up / down; a trigger by how far it is pressed |
| Right stick | mouse, arrow keys | turn (yaw and pitch; pitch stops 5 degrees short of straight up or down) |
| R / L (RB / LB) | R / Q | each press doubles / halves the speed, 0.25 to 512 m/s |
The keys are the ones bound to the left and right stick and to ZR, ZL, R and L (`bind_` lines), so remapped keys follow.
The mouse turns the free camera at the game camera's rate (0.08 degrees a count at `mouse_sens = 1`) and the game's
mouse camera gets none of it meanwhile. Each switch starts at the game camera's position and view at 8 m/s; the speed
follows the clock, so it is the same at any frame rate and game speed. The horizon stays level.
How it works (`runtime/freecam.c`): the camera component update (main+0x628460) copies each component's eye, target
and up into its sead camera. The site `freecam` (`recomp/patches-v143.txt`, main+0x6286d4) runs before that copy and
writes the component's one-shot eye and target overrides (+0x180, +0x198), which the update takes in place of the pose
and then clears, so the game camera's own state is never changed and resumes the frame the free camera ends. Locked,
the site keeps writing the overrides without moving them. The up
vector is levelled through the component's up offset (+0x200), which is kept and put back. Of the three components a
frame updates, the free camera drives the two that share the player camera's eye and leaves the one at the default pose
(eye 0, 0, 10). After a load replaced the components it picks the new ones and keeps its position.
## Mouse camera
`mouse_mode = direct` (the default) turns the camera by the raw mouse motion on games 1.4.3 and 1.2.1, through hooks in the game's camera code (`runtime/mouse_direct.c`, the `mouse_direct` sites of `recomp/patches-v143.txt` and `recomp/patches-v121.txt`). None of them changes a step of the gamepad alone. The free-orbit camera receives raw-count
@@ -132,6 +188,12 @@ degrees a count as the camera does elsewhere. The follow range is read from the
once, the mouse is stick input there). The stick loads that only test for input keep the mouse in the stick. A step with mouse motion that no
direct hook took is logged (`mouse: step N with mouse motion took the stick path`, the first 30, then one in 600, with
the player's state), so the cameras still on stick input show in `logs/totk.log`.
Some cameras run none of the direct hooks and read their turn from input the hooks never see: Autobuild's placement
camera (games 1.4.3 and 1.2.1) turns by the right stick but, in direct mode, not by the mouse (issue #1300). After two
camera steps in a row that ran no direct hook (none of the free orbit, the load sites above or Ultrahand's held-object
input), the mouse acts as the right stick there, as with `mouse_mode = stick`, until a step runs a direct hook again
(`mouse: the camera runs no direct hook; the mouse acts as the right stick` and `... runs a direct hook again` in the
log, the first 6 changes; `camera_unhooked` in `runtime/mouse_direct.c`).
Lock-on keeps pointing the camera at the target; the stick, and so the mouse, adds an offset around that direction,
which the game limits and lets return: the mouse's degrees are the step's turn the game adds to the offset and judges
the return by.
@@ -172,7 +234,8 @@ The horizontal quick lists (D-pad up/left/right: materials, shields and weapons)
with at least 32 ms of neutral between them. At sensitivity 1, 32 horizontal counts request a step; a large flick
cannot queue continued scrolling after the mouse stops. Vertical movement is ignored in these lists. Switching or
releasing a selector resets its cursor/step state without sending the last movement to the camera. Selector input is
not consumed by the direct camera or Ultrahand hooks.
not consumed by the direct camera or Ultrahand hooks. The scroll wheel steps these lists too: each notch is one step,
away from you to the left, towards you to the right.
To detach a fused part from what Ultrahand holds, shake the mouse left and right, or press G (`bind_SHAKE`). A press
swings the right stick left and right for 0.8 s, holding the key keeps it swinging. With `mouse_mode = direct` a shake
of the mouse while Ultrahand holds an object swings the right stick with it: once the swings (10 degrees of camera turn
@@ -197,16 +260,70 @@ The stick direction bits (`StickLLeft` to `StickRDown`) are derived from the sti
## Mouse in the game's menus
On game 1.4.3, while one of the game's menus has its focus box (the frame the d-pad moves: the title, the save list, the inventory and its System tab, Options, shops, dialogue choices), the cursor is released from the mouse camera and shown in the middle of the window. A focus gap of up to 300 ms (a tab switch, a popup opening: the game drops the focus box for a frame or two) keeps the pointer where it is instead of capturing and centring it again. The item under the pointer takes the focus as if the d-pad had moved there, with the game's highlight, sound and description; a left click is A on it, a right click is B. The middle and side mouse buttons keep their bindings (bound to L and R they turn the tabs), and T presses Y (sort). The keys and the pad keep working, and the focus moves only when the pointer moves. This happens only while the keyboard and mouse are the device used last: after a gamepad button press or a stick pushed past half way the menus are as on the console, with no pointer, until the mouse moves or a key is pressed (`input_kbm_last` in `runtime/input.c`). The ability wheel, the d-pad strips, Autobuild and the Purah Pad's camera stay gameplay: the mouse keeps the camera there. The map has no focus box; it is found in `eui::ScreenMgr`'s list of open screens (every 100 ms: the Purah Pad's frame `AppMenuOverlay_00` with `AppMap_00` and the menu background `AppMenuBG_00`), and there the mouse moves the map's cursor as the left stick does, with the cursor still captured, and the scroll wheel zooms: each notch is a full-tilt push of the right stick (the map's zoom) for 100 ms with 50 ms of neutral after it, up (in) for a turn away from you; a fast scroll's notches wait their turn (at most four), a turn the other way drops them. The Scope opens the same map screen without the menu background and keeps the mouse camera. When the menu closes the cursor is captured again.
On game 1.4.3, while one of the game's menus has its focus box (the frame the d-pad moves: the title, the save list, the inventory and its System tab, Options, shops, dialogue choices), the cursor is released from the mouse camera and shown in the middle of the window. A focus gap of up to 300 ms (a tab switch, a popup opening: the game drops the focus box for a frame or two) keeps the pointer where it is instead of capturing and centring it again. The item under the pointer takes the focus as if the d-pad had moved there, with the game's highlight, sound and description; a left click is A on it, a right click is B. The middle and side mouse buttons keep their bindings (bound to L and R they turn the tabs), and T presses Y (sort). The scroll wheel moves the focus up and down, one step a notch (a full-tilt push of the left stick for 70 ms with 50 ms of neutral after it, up for a turn away from you), so a long list of items scrolls without moving the pointer; `menu_cursor = 0` turns this off with the pointer. The keys and the pad keep working, and the focus moves with the pointer only when the pointer moves: after the wheel, a key or the pad moved the focus off the pointer's item, the pointer takes it back once it has moved 6 layout units (the menus' 1280 x 720: about 9 window pixels at 1080p, 18 at 4K) from where it was then (`DEAD_ZONE` in `runtime/menu_cursor.c`), so a hand resting on the mouse does not undo a scroll; a click acts at once. With `pointer_image = 1` (off by default) the game window shows a pointer of its own while the cursor is not captured, a gold arrowhead drawn at the window's DPI (`runtime/cursor_art.c`), in place of the system arrow. This happens only while the keyboard and mouse are the device used last: after a gamepad button press or a stick pushed past half way the menus are as on the console, with no pointer, until the mouse moves or a key is pressed (`input_kbm_last` in `runtime/input.c`). The ability wheel, the d-pad strips, Autobuild and the Purah Pad's camera stay gameplay: the mouse keeps the camera there. The map has no focus box; it is found in `eui::ScreenMgr`'s list of open screens (every 100 ms: the Purah Pad's frame `AppMenuOverlay_00` with `AppMap_00` and the menu background `AppMenuBG_00`), and there the mouse moves the map's cursor as the left stick does, with the cursor still captured, and the scroll wheel zooms: each notch is a full-tilt push of the right stick (the map's zoom) for 100 ms with 50 ms of neutral after it, up (in) for a turn away from you; a fast scroll's notches wait their turn (at most four), a turn the other way drops them. The Scope opens the same map screen without the menu background and keeps the mouse camera. The Purah Pad's camera (the ability wheel's camera) opens the frame and its pointer `CameraPointer_00` without `AppMap_00` (the Scope has it); there the scroll wheel zooms as the camera's guide shows: each notch is a press of the d-pad's up (in, for a turn away from you) or down for 100 ms with 50 ms of release after it (`menu_cursor_camera`). The Scope itself has no zoom; the wheel does nothing there. When the menu closes the cursor is captured again.
`runtime/menu_cursor.c` reads eui's screens at each pad read and moves the focus with the writes `eui::BoxCursorMgr::moveBoxCursor` makes, so no game code is called. `menu_cursor = 0` (`TOTK_MENU_CURSOR=0`, live; the *Mouse in the game's menus* row of the Controls tab) turns it off; `TOTK_MENU_CURSOR_LOG=1` logs every screen it reads (by default the first six), with the layout size, the node count and the hit panes it uses.
### Left click on the map
With `map_click = 1` (off by default, so each key presses one controller button as everywhere else), on game 1.4.3, while the Purah Pad's map is open (found as above; the Scope is not the map), the left mouse button presses A at the map's cursor instead of the button it is bound to (Y by default). A press is A or the binding from the moment the button goes down until it is released, so a button held as the map opens or closes keeps what it pressed (`poll_merged` in `runtime/input.c`). `map_click = 1` (`TOTK_MAP_CLICK=1`, live; the *Left click on the map* row of the Controls tab) turns it on and `0`, the default, leaves the left button on its binding there. The map is found only while `menu_cursor` is on.
### Clicks in dialogue
With `dialogue_click = 1` (off by default, so each key presses one controller button as everywhere else), on game 1.4.3, while a dialogue box is open (the layout `MessageDialog_00`: a character's lines and the game's own messages), the left mouse button presses B and the right one A, instead of the buttons they are bound to. B continues the text as A does and also shows the rest of a line that is still scrolling in; the left button's default, Y, would open the dialogue log there, and the log stays in the way until B closes it. Dialogue choices are a menu with the focus box, so the pointer above takes their clicks and a left click is A on the choice under it: clicking through a conversation fast does not pick the choice the focus starts on. A press is the dialogue's button or the binding from the moment the button goes down until it is released: the click that closes the last box does not become an attack while it is still held, and a button held when the box opens does not skip its first line. Between two lines of a conversation the game closes the box and opens it again, so both buttons stay B and A for 500 ms after the box was last open (`DIALOGUE_GAP_MS`); the first clicks after a conversation fall in that time too, as they do for a player who taps the button through the last line. `TOTK_MENU_CURSOR_LOG=1` logs how long each such gap was. The dialogue window has no focus box of its own: the scan of `eui::ScreenMgr`'s open screens (every 100 ms) finds its screen, and from then on that screen's state is read at every pad read (`dialogue_shown` in `runtime/menu_cursor.c`), so the first click after a box opens is already the dialogue's. `dialogue_click = 1` (`TOTK_DIALOGUE_CLICK=1`, live; the *Clicks in dialogue* row of the Controls tab) turns it on and `0`, the default, leaves both buttons on their bindings; the setting does not depend on `menu_cursor`. The log names the first box it sees (`menu_cursor: a dialogue box is open ...`).
## Quick save
With `quicksave = 1` (off by default; the *Quick save and load* row of the Controls tab, live), on game 1.4.3, one key saves the game at once and another loads that save: F6 and F7 by default, the keys Half-Life has for them. No menu shows on the screen (`runtime/quicksave.c`). It is for the keyboard and the mouse only (a gamepad has no quick save button yet) and for game 1.4.3 only (the addresses below are 1.4.3's; on 1.2.1 the setting does nothing).
Quick save asks the game for one of its own autosaves, the way its event graphs do: it calls the AutoSaveMgr's request with the kind the sequence node `OneShotAutoSaveMgrRequestAutoSave` uses, after the game's own check whether it would autosave now. That check also holds autosaves back for some ten minutes after the game's last one; quick save, being the player's own, skips that wait (it sets the AutoSaveMgr's timer to 0, and puts it back when the game says no for another reason), as Save in the System tab does. The game then saves as it does after a shrine or a story event, its autosave icon included, into one of its autosave slots: the oldest autosave is replaced, as by any autosave of the game. The commit of that save names the slot folder it wrote (`fs_save_commits` in `runtime/fs_host.c`), and quick save keeps a copy of it: `<profile>/quicksave/slot`, with the slot's name in `<profile>/quicksave/slot.txt`. *Game saved* shows at the top of the picture for a few seconds (`menu_toast`, `runtime/ui/menu.cpp`). The game can take the request and still hold the autosave back (seen once in a fight in the Depths); when no save commit comes within 5 s, quick save takes its request back, so the game does not save some time later on its own, and says it is not possible right now. The game's manual save is not touched.
Quick load has no request in play to start from: the game starts a load only from its own load list (System tab) or its Game Over screen, and loads the slot that screen names. So quick load goes through the load list as a player with a controller would, but out of sight. *Loading the quick save* shows at the top of the picture, and from the next frames on the window keeps that picture (`gfx_present_hold` in `runtime/gfx_present.c`, as while the window is minimized) while quick load presses Plus, R until the System tab shows, Load, A on the list's first save and Load on the confirmation. From that confirmation on, every read the game makes of a file in a slot folder (`save:/slot_NN/<file>`) opens the quick save's file instead (`fs_save_read_from` in `runtime/fs_host.c`; the log names each one, `fs: quick load: ... read from ...`), so the game loads the quick save whichever slot the list offered first, and no slot of the save is written for it. The redirect ends with the load: once the game has read the quick save's files, its loading fade has closed and the HUD has been back for half a second (`quickload: slot reads go to the save again`); at once when a menu with the focus box opens, so a Load right after it lists and loads the slots as they are. The picture comes back with the game's loading fade, about 5 s after the key. When a step finds a screen it does not expect, or none within its time, the log names the step, B is pressed until no menu has the focus box, the picture comes back and the line says *Quick load failed*. The quick save stays in the profile, so F7 loads the same state again until F6 makes a new one.
Both start only in play: a save loaded, the HUD (`PlayerStatus_00`) open, no menu with the focus box, no dialogue box and no loading fade. Anywhere else, and wherever the game itself would not autosave (a cutscene, an event, a fight), nothing happens but a line at the top of the picture (*Quick save is not possible right now*), and the log says why (`quicksave: not now: ...`). Without a quick save F7 says so. Quick save's calls into the game run on the game thread in its pad read, between two of its own calls; while quick load runs the game gets only its presses, not the player's input. While the setting is on its two keys reach no binding; with it off nothing changes and nothing is logged.
The keys are `quicksave_key` and `quickload_key` (`TOTK_QUICKSAVE_KEY`, `TOTK_QUICKLOAD_KEY`, live). The *Quick save key* and *Quick load key* rows under the switch take any key or mouse button the way a binding's cell does: select the cell, press the key (Esc cancels); Delete, Backspace or X leaves that one without a key (`none`). In `totk.ini` the value is a key name of the [Remapping](#remapping) list, in any case, or `none`. A name the list does not have is logged (`quicksave: quickload_key: unknown key '...', f7 is used`) and the default is used; the same key for both saves and leaves loading without a key. With the setting on the log names the keys in use (`quicksave: f6 saves, f7 loads`). A key a binding also uses presses only quick save or quick load while the setting is on: the row says which button it took (*also A*).
`QUICKSAVE` and `QUICKLOAD` lines in an input script ([Scripted input](#scripted-input)) start it as the keys do.
## Gameplay tweaks
With `gameplay_tweaks_enabled = 1` (`TOTK_GAMEPLAY_TWEAKS_ENABLED=1`, live; off by default in `totk.ini`), the mouse wheel and keyboard can drive common gameplay interactions directly:
- **Ultrahand object rotation**: turning the mouse wheel while Ultrahand holds an object rotates it directly without holding R or pressing the D-pad (`gameplay_ultrahand_rotate = 1`, sensitivity `gameplay_rotation_sensitivity = 1`). Holding C while scrolling rotates around the alternate axis (`gameplay_ultrahand_c_axis = 1`).
- **Ultrahand distance**: holding the right mouse button while scrolling pushes or pulls the held object closer or farther (`gameplay_ultrahand_distance = 1`, sensitivity `gameplay_distance_sensitivity = 1`).
- **Free-roam weapon switching**: scrolling the mouse wheel in free roam steps through equipped weapons (`gameplay_weapon_wheel = 1`, sensitivity `gameplay_weapon_sensitivity = 1`). Press E to confirm the chosen weapon; right click or pressing B cancels.
- **Quick-selection menus**: scrolling the mouse wheel browses items while a quick-selection menu (weapons, bows, shields, materials) is open (`gameplay_item_wheel = 1`, sensitivity `gameplay_item_sensitivity = 1`). A and D keys step left and right through the strip (`gameplay_item_ad = 1`).
- **Smooth map zoom**: the mouse wheel performs continuous inertial zooming on the Purah Pad map (`gameplay_map_zoom = 1`, sensitivity `gameplay_map_zoom_sensitivity = 1`).
All sub-toggles default to 1 and sensitivities to 1 (range 0.25 to 4.0), so enabling `gameplay_tweaks_enabled` activates the full suite immediately while allowing individual features to be toggled or tuned.
## Nintendo Switch 2 controllers
Windows does not present the Switch 2 Pro Controller as a gamepad SDL can open (the log says `input: no gamepad`), so it needs a bridge program that wakes it and creates a virtual gamepad. The DS4Windows fork by hbashton ([github.com/hbashton/DS4Windows](https://github.com/hbashton/DS4Windows), tested with release VIIPERRC4.5.1, a pre-release) with the output set to an emulated DualSense gives buttons, rumble, gyro and accelerometer, and reads the sticks through the controller's calibration (they rest at 0 to 2%). The game reads its virtual DualSense directly; the log then shows `input: gamepad "DualSense Wireless Controller" (rumble, gyro and accelerometer, ...)` and `input: motion sensors on`. Its release notes also list Joy-Con 2 support, which is untested here.
Bridges that output a ViGEm DualShock 4 (ProCon2Windows, connectyourpro as tested) give buttons and rumble but no motion: their virtual DualShock 4 reports a gyro and an accelerometer that never change, so motion aiming and Ultrahand rotation do nothing. Run one bridge at a time; Steam Input can also claim the controller, so close Steam if the bridge does not find it.
## Steam Input and motion
A game Steam starts sees Steam's virtual gamepad in place of the controllers Steam Input reads (Steam lists them in
`SDL_GAMECONTROLLER_IGNORE_DEVICES`), and that virtual pad has no gyro or accelerometer. With `motion = 1` the game
clears that list before SDL starts (`runtime/input.c`, `steam_reveal`): buttons and sticks still come from the virtual
pad, so Steam's remapping applies and nothing is read twice, and when the virtual pad has no sensors the motion thread
opens the real controller behind it for its gyro and accelerometer only (`motion_source`). The log then shows
`input: motion from "<name>" (<vendor>:<product>), the controller behind Steam Input's virtual gamepad`. This covers the
Steam Controller and the Steam Deck's built-in controls, which Steam Input cannot be turned off for, and other
controllers Steam Input wraps. A controller Steam hid serves for buttons only while no other gamepad is there (Steam's
virtual pad can come up after the game starts); once the virtual pad is up the buttons move to it. With `motion = 0`
at start Steam's list stays in force.
Steam switches the controller's gyro off while the game's layout binds nothing to it: the reports keep coming with the
gyro at zero, and the game's request for it (SDL renews it every 3 s) does not win. The layout needs a gyro binding,
for example Gyro Behavior "As Mouse"; its activation only decides when Steam itself moves the mouse, the game gets the
gyro all the time. Pick an activation the game does not need (a back button), or Steam's mouse turns the camera on top
of the game's own motion. Under Steam the Steam Controller's gyro arrives already corrected, so it keeps a bias of its
own (`gyro_bias_pad` ends in "(under Steam)").
## Scripted input
`TOTK_INPUT_SCRIPT=<file>` replays presses. It is ORed with real input and still applies under `TOTK_INPUT=none`. One event per line, `#` starts a comment:
@@ -214,10 +331,14 @@ Bridges that output a ViGEm DualShock 4 (ProCon2Windows, connectyourpro as teste
```
<frame> <button> [hold_frames] # A B X Y L R ZL ZR PLUS MINUS LEFT UP RIGHT DOWN LCLICK RCLICK; hold defaults to 4
<frame> LSTICK|RSTICK <x> <y> [hold_frames] # -32767..32767, up is +y
<frame> MOUSE <dx> <dy> # direct-mode raw counts, once; down is +dy
<frame> MOUSE <dx> <dy> # raw mouse counts, once; down is +dy
@<ms> <button> [hold_ms] # timed on the world clock
@<ms> LSTICK|RSTICK <x> <y> [hold_ms]
@<ms> MOUSE <dx> <dy>
<frame> WHEEL <notches> # scroll wheel notches, once; + away from the player
@<ms> WHEEL <notches>
<frame> QUICKSAVE|QUICKLOAD # quicksave = 1's save or load key, once
@<ms> QUICKSAVE|QUICKLOAD
```
`<frame>` counts 60 Hz ticks of game time since the first frame (presented frames at 60 fps), so the title menus get the presses at the same game time at any frame limit. `@<ms>` counts milliseconds of the world clock: game time stepped since the end of the first save load (the player leaves the title screen's origin), so a timed event lands at the same game time at any frame rate and load length. A later load, such as fast travel, still shifts what follows. In a script with timed lines the untimed ones stop when the world clock starts, as the load ends at another tick in each run. Each event logs once (`input: script frame N tick T: A`). `tools/input/load_save.txt` loads the first save from the title screen.
@@ -226,7 +347,10 @@ Bridges that output a ViGEm DualShock 4 (ProCon2Windows, connectyourpro as teste
In direct mouse mode the recording also writes one `MOUSE` event per consumed raw displacement. These are one-shot
displacements rather than held stick segments. They replay without cursor capture, including with `input = none`;
the game must be accepting camera input when the event reaches its camera update.
the game must be accepting camera input when the event reaches its camera update. Where the mouse acts as the right
stick (`mouse_mode = stick`, a camera with no direct hook, the game not accepting camera input), a script's `MOUSE`
lines move the right stick as the mouse would, also without cursor capture or with `input = none`, for 100 ms after
each line (`mouse_camera` in `runtime/input.c`); spread a turn over lines a frame apart, as a real mouse moves.
`TOTK_TEST_PAD=<lx>,<ly>,<rx>,<ry>` attaches an SDL virtual gamepad at start whose sticks rest at these raw SDL axis values (-32768 to 32767, down is +y), so a drifting or held stick can be tested without a controller: the values go through the gamepad mapping and `TOTK_STICK_DEADZONE` like a real pad's, and `TOTK_INPUT_RECORD` shows what reached the game.
+97 -42
View File
@@ -1,8 +1,9 @@
# Installer
A public release that turns the player's own game files into a playable TotK folder. The release carries no game
data and no code derived from the game: the installer builds the game on the player's machine. The installed folder
holds only the game; the installer and its tools stay outside it.
data and no code derived from the game: the installer builds the game on the player's machine. On Windows the
installed folder also holds the build kit, the installer's tools the game rebuilds itself with for code mods, so the
setup folder can be deleted after the install and the install folder moved.
## What the player does
@@ -16,7 +17,8 @@ holds only the game; the installer and its tools stay outside it.
needed for Chinese, Korean and Traditional Chinese text;
- the game language and the install folder.
3. Waits for the setup, one time. The window shows each step and its progress.
4. Plays `totk.exe` from the install folder. The installer and the source NSP or XCI (or NSZ, XCZ) can be deleted.
4. Plays `totk.exe` from the install folder. The setup folder and the source NSP or XCI (or NSZ, XCZ) can be deleted,
and the install folder can be moved: code mods rebuild the game with the build kit inside it.
The install folder (`main.c` `portable_paths()` reads this layout; it stays portable):
@@ -32,16 +34,25 @@ The install folder (`main.c` `portable_paths()` reads this layout; it stays port
logs/ totk.log of the last run, totk.1.log to totk.4.log of the runs before it
shader and pipeline caches prepared by the setup; shader-cache/shader-cache.pack holds the translations
totk-install.json what built this folder: release version, input hashes, finished steps
build-kit/ Windows: the release folder without TotK-Setup.exe (about 0.65 GB); the game's rebuild
for code mods runs the setup window from it
build-cache/ what the rebuild built in (cheats.status, exefs.status, plugins.status), rebuild.txt,
and work/: the generated C, the lift cache and the objects (about 1.6 GB, Windows)
```
## Updating the port
The player runs a newer installer on the same folder. It reads `totk-install.json`, keeps `romfs/`, `exefs/`,
`shared-fonts/`, `profile/` and `totk.ini` after checking their hashes, rebuilds `totk.exe` and re-prepares the
shaders. A newer release that changes nothing game-derived skips the rebuild. The window starts with the last install folder
and the base, update, keys and firmware paths it ran with (paths only, never the keys file's contents), kept in
`%LOCALAPPDATA%\TotK Recomp\setup.json` (`$XDG_STATE_HOME/totk-recomp/setup.json` elsewhere). Entries that no longer exist
stay empty. A reinstall or a switch to another game version starts filled in.
`shared-fonts/`, `profile/` and `totk.ini` after checking their hashes, replaces `build-kit/` with its own files,
rebuilds `totk.exe` and re-prepares the shaders. The setup is an installer and updater: nothing after the install needs
its folder. An install made by a setup before the build kit kept its temp folder in that setup's folder
(`<setup>/temp/<install name>-<hash>`, the setup `build-cache/rebuild.txt` named); the first newer setup moves it into
`build-cache/work` when both are on one disk (on another it starts empty) and writes the new `rebuild.txt`. Until then
the old `rebuild.txt` keeps using the old setup folder. A newer release that changes nothing game-derived skips the
rebuild. The window starts with the last install folder and the base, update, keys and firmware paths it ran with (paths
only, never the keys file's contents), kept in `%LOCALAPPDATA%\TotK Recomp\setup.json`
(`$XDG_STATE_HOME/totk-recomp/setup.json` elsewhere). Entries that no longer exist stay empty. A reinstall or a switch
to another game version starts filled in.
Given an update file other than the recorded one (1.1.0, then 1.2.1, then 1.4.3), the installer extracts and builds again from it
and keeps `profile/`. Saves carry over both ways between 1.2.1 and 1.4.3: 1.4.3 converts a 1.2.1 save on load, and 1.2.1
@@ -53,57 +64,97 @@ loads the saves 1.4.3 wrote.
`tools/extract.py`), the keys are new enough for the update, enough space is free on the target disk (about 36 GiB at the peak of a
first install, 20 GiB after it), the CPU is at least x86-64-v2 (SSE4.2; with AVX2/FMA the faster `v3` build is used,
otherwise the `v2` one), a Vulkan 1.3 GPU exists. Each failure is one clear message.
2. **Fonts** with Chinese, Korean or Traditional Chinese text and a firmware folder: extract the Switch system fonts
2. **Kit** (Windows): copy the release folder without `TotK-Setup.exe` into `build-kit/` in the install folder
(`installer/steps.py` `Kit`, `installer/layout.py` `KIT_ITEMS`); every step after it runs its tools from there, so
the commands the build records (the compiler's path in the Ninja file) are the ones the game's rebuild runs later.
A newer setup replaces the kit; the kit's own rebuild keeps it. The steps' keys fingerprint file contents, not
paths (`runtime_key` leaves out the lines of `clang --version` that name its folder), so a rebuild from the kit
or from a moved install folder keeps every step the setup recorded.
3. **Fonts** with Chinese, Korean or Traditional Chinese text and a firmware folder: extract the Switch system fonts
from the firmware into `shared-fonts/` (MacNativeGames' `extract_shared_fonts.py`, which verifies every NCA layer
and BFTTF header). Without a firmware folder the setup warns and goes on; the game then lacks those glyphs.
3. **Extract** ExeFS and RomFS into the install folder and verify the hashes.
4. **Lift** the ExeFS to C (`recomp/gen.py`, `recomp/patches-v121.txt` or `patches-v143.txt`) into a temp folder next
to the installer. The code cheats of the mods' cheat files and the mods' ExeFS patch files become patch sets first
(`tools/cheats.py`, `tools/exefs_patches.py`, status in `build-cache/cheats.status` and `exefs.status`); a file the
tools refuse costs those cheats or patches, not the install. The patch files' writes into main's data go to
`build-cache/exefs.data`, which the game stores into main at start; after the lift they are checked against the
bytes the lifted code read as constants (`<gen>/main/folded.txt`, its jump tables).
5. **Compile** the generated C, `modules.c`, `romfs.c`, `patches.c` and `ov_zstd.c` (they bake the per-install layout, RomFS
4. **Extract** ExeFS and RomFS into the install folder and verify the hashes.
5. **Lift** the ExeFS to C (`recomp/gen.py`, `recomp/patches-v121.txt` or `patches-v143.txt`) into the temp folder,
`build-cache/work` in the install folder (`.setup-temp` on Linux, `--temp DIR` elsewhere). The code cheats of the
mods' cheat files and the mods' ExeFS patch files become patch sets first (`tools/cheats.py`,
`tools/exefs_patches.py`, status in `build-cache/cheats.status` and `exefs.status`); a file the tools refuse costs
those cheats or patches, not the install. The patch files' writes into main's data go to `build-cache/exefs.data`,
which the game stores into main at start; after the lift they are checked against the bytes the lifted code read as
constants (`<gen>/main/folded.txt`, its jump tables).
6. **Compile** the generated C, `modules.c`, `romfs.c`, `patches.c` and `ov_zstd.c` (they bake the per-install layout, RomFS
hashes and the game version's patch page) and link
them with the prebuilt runtime library for the host's level (`libtotkrt.a` or `libtotkrt-v2.a`) into `totk.exe`
(`build_game.py --runtime-lib`; about 3 min on 24 cores).
6. **Prepare** (only when the runtime, the translator or the game version changed, not for a new lift) the RomFS
7. **Prepare** (only when the runtime, the translator or the game version changed, not for a new lift) the RomFS
patches and the shaders (`tools/make_romfs_patches.py`, `tools/prepare_shaders.py`,
`totk.exe --prepare-shaders`) in the install folder, then fold the shader cache's loose files (four per shader, about
117,000) into `shader-cache/shader-cache.pack` (`tools/pack_shader_cache.py`). totk.exe reads the pack first and
writes the translations it makes in play as loose files; running the tool again with the game closed folds those in.
The patches are written four times: `romfs-patches`, `romfs-patches-xbox` and `romfs-patches-xbox-label`
The patches are written five times: `romfs-patches`, `romfs-patches-xbox` and `romfs-patches-xbox-label`
(`--prompts`: Xbox button prompts for `prompts = xbox`, the first for `pad_layout = nintendo`, the second for `xbox`
and `auto`), and `romfs-patches-pc` (keyboard and mouse prompts for `prompts = pc`). The three prompt folders are
optional: when one cannot be made, the setup warns and finishes.
and `auto`), `romfs-patches-playstation` and `romfs-patches-playstation-xbox` (PlayStation prompts for
`prompts = playstation`, the same split). The prompt folders are optional: when one cannot be made, the setup warns
and finishes.
**PC prompts** (step `pc_prompts`): `romfs-patches-pc`, the keyboard and mouse prompts for `prompts = pc`, drawn
from the `bind_` lines of `totk.ini` (`--binds`). Its key holds those lines, so a setup run after a change of the
bindings draws only these again. Optional like the Xbox prompts. All six 16:9 folders are always written, so a
switch of the prompts style at 16:9 needs no setup run.
When the graphics driver crashes while building the shaders, `prepare_shaders.py` runs that part again without the
variants it was building ([building.md](building.md), step 6), and the setup finishes with a warning that names how
many were left out.
7. **DLSS** (the window's tick box, on by default, or `--dlss`; Windows with an NVIDIA RTX GPU): download
8. **Shapes**: the UI laid out for each screen shape this player needs, `romfs-patches-<w>x<h>`
(`--aspect`), and with Xbox or PC prompts in `totk.ini` that layout with those prompts too,
`romfs-patches-<style>-<w>x<h>` (`--prompts <style> --aspect --reuse romfs-patches-<style>`, which hard-links every
file but the UI archive; for `pc` with the same `--binds` as the PC prompts step, whose key the step follows). The shapes are those of every connected display (Windows: `EnumDisplayDevices`; Linux:
`xrandr`, else the DRM connectors), of the `output_res` the game defaults to on each, and of the `totk.ini`
`output_res` (`installer/screens.py`). One folder per shape, named after the shape's size in `ASPECT_SIZES` (the
closest within 1%; `5120x2160` uses `2560x1080`); `runtime/romfs.c` `overlay_init` maps the game resolution the
same way, and a folder of the exact size from an older setup still wins. A 16:9 player gets none. The step runs
again when the displays, the prompts or the patches change. At a game resolution whose shape has no folder the
game draws 16:9 with bars and starts the generator itself, in the background, for the next start: at start and
when the settings menu changes the resolution, the HUD width, the prompts or the pad layout
(`runtime/romfs.c`, `romfs_folders_prepare`, with the Python and tools that `build-cache/rebuild.txt` names; a
missing 16:9 prompts folder too). Those runs use `--background`: below-normal priority, and a folder that has a
manifest is never written into. Every `make_romfs_patches.py` run writes `<folder>.part-<pid>` and renames it into
place when complete; the clean-up step removes the `.part` folders of stopped runs once they are an hour old.
9. **DLSS** (the window's tick box, on by default, or `--dlss`; Windows with an NVIDIA RTX GPU): download
`nvngx_dlss.dll` from NVIDIA's own DLSS SDK repository (github.com/NVIDIA/DLSS, a pinned tag, NVIDIA RTX SDK
license) into the install folder and check its size and SHA-256 (`steps.py`, `Dlss`). The release does not ship
the library; NGX loads it from the folder of totk.exe for `dlaa` and the DLSS modes. A DLSS library already in the
folder (a newer one the player put there) is kept. Without an RTX GPU the step only logs and does nothing; a failed
download warns, the game runs without DLSS, and the next run of the setup tries again.
8. **Clean up** the temp folder, except the generated C and the objects (about 1.3 GB), and write
10. **Clean up** the temp folder, except the generated C and the objects (about 1.3 GB), and write
`build-cache/rebuild.txt` in the install folder.
A cancelled or failed setup resumes from the last finished step (`totk-install.json`).
## Rebuilding for the mods
The generated C and the objects stay in the temp folder, so the next lift rewrites only the chunks whose C changed and
Ninja recompiles only those: a new or edited code cheat costs the lift (under a minute on 24 cores, a few minutes on 4)
and a few dozen chunks, not a full compile, and the shaders stay prepared.
The generated C and the objects stay in the temp folder, inside the install folder. The next lift lifts again only the
chunks whose inputs changed (the lift cache of `recomp/gen.py`: the patch sites inside a chunk, with their set indices)
and rewrites only those whose C changed, and Ninja recompiles only those. A new or edited code cheat costs a few seconds
of lift (discovery and a hash of the kept chunks; 7 s for one changed cheat word on 12 cores, against 102 s for the
whole lift) and the compile of the chunks that hold its sites, not a full compile, and the shaders stay prepared. A
cheat set added or removed before others in the patch file moves their set indices, so the chunks of their sites are
lifted too. A change to `recomp/*.py` lifts everything.
`build-cache/rebuild.txt` holds the command that opens the setup window in its rebuild mode on the install folder
(`installer/gui.py --rebuild <install folder>`, started through `python -c` so the release folder is on `sys.path`
whatever the working folder), one argument per line. When an enabled mod has code cheats or ExeFS patch files the build
lacks, `totk.exe` runs it at start and exits (`runtime/cheats.c` `rebuild_if_needed`); the
window runs the setup on the folder at once and starts the game again when it succeeds. A failed or cancelled rebuild
offers to start the game with the code it has; `build-cache/rebuild.skip` then keeps the same files from starting it
again, until "Rebuild the game now" on the Cheats or Mods tab. `[mods] mods_rebuild = off` turns it off. The rebuild
needs the release folder the setup ran from: a moved or deleted release folder means running a setup again.
whatever the working folder), one argument per line. On Windows it names the build kit relative to the install folder
(`build-kit\python\pythonw.exe`, `build-kit`, `--rebuild .`): `totk.exe` takes the program from its own folder and
starts the command there, so no path of the setup or of the install folder is stored. When an enabled mod has code
cheats or ExeFS patch files the build lacks, `totk.exe` runs it at start and exits (`runtime/cheats.c`
`rebuild_if_needed`); the window runs the setup on the folder at once and starts the game again when it succeeds. A
failed or cancelled rebuild offers to start the game with the code it has; `build-cache/rebuild.skip` then keeps the
same files from starting it again, until "Rebuild the game now" on the Cheats or Mods tab. A command that does not start
at all leaves no `rebuild.skip`, so the next start tries it again. `[mods] mods_rebuild = off` turns it off. A moved
install folder keeps its incremental rebuild: the kit's builds run `tools/build_game.py --portable`, whose Ninja file
and deps log name every path relative to the kit (3.5 s to rebuild after a move instead of a full compile). A build with
a mod plugin names the plugin's file by its absolute path (`recomp/layout.py`), so after a move the game finds it gone
and runs the rebuild once. On Linux the command starts the AppImage file itself (`$APPIMAGE --rebuild <install
folder>`), because the AppImage's mounted folder is gone once the setup exits; a moved or deleted AppImage means running
a setup again. Installs set up by an AppImage before this change hold a command into that mount: running the new setup
once on the install folder writes the new one.
## Command line
@@ -126,13 +177,16 @@ python -m installer --base FILE --update FILE --keys FILE --lang CODE --dest DIR
resume and update are one rule; output kept from another release is re-hashed first.
- Peak space on the install disk is about 36 GiB, not 22: the extraction copies both Program NCAs (16.3 GiB) next to
the merged RomFS (15.9 GiB) before it deletes them. The check computes the exact figure.
- Window (`python -m installer.gui`, `installer/gui.py` draws, `installer/guilogic.py` decides): form, step list with
progress, space line, collapsible log, Cancel (Ctrl+Break to the CLI's process group, then it waits for the exit),
finish screen with Open folder. English, Russian, Brazilian Portuguese or Simplified Chinese, chosen from the Windows
display language (zh-CN and zh-SG give Chinese; the Traditional Chinese regions give English), switchable in the
window; every sentence is an id in `installer/text/<en|ru|pt-BR|zh-Hans>.json`. A Chinese window still starts with
English as the game language, because Chinese game text needs the Switch shared fonts, which the setup extracts only
from a firmware folder. A folder with
- Window (`python -m installer.gui`, `installer/gui.py` draws, `installer/guilogic.py` decides): form (game files and
install sections, the explanations under More details, the share notice next to Start) in the Sun Valley ttk theme
(`installer/vendor/sv_ttk/`, the platform theme when it does not load), step list with progress, space line,
collapsible log, Cancel (Ctrl+Break to the CLI's process group, then it waits for the exit), finish screen with Open
folder. English, Russian, Brazilian Portuguese, Simplified Chinese, German, French, Spanish, Italian, Dutch, Japanese
or Korean (`guilogic.UI_LANGUAGES`), chosen from the Windows display language (every Chinese, zh-TW and zh-HK
included, gives Simplified Chinese; pt-PT and languages without a catalog give English), switchable in the window;
every sentence is an id in `installer/text/<lang>.json`. The game language starts as the window's when the game has
it; a Chinese or Korean window still starts with English, because that game text needs the Switch shared fonts,
which the setup extracts only from a firmware folder. A folder with
`totk-install.json` needs only the folder. `--selftest [--shots DIR]` builds every screen in every language and
closes itself. The window is not stretched on a display whose scale is the system DPI: `installer/dpi.py` makes the
process system DPI aware before Tk starts, Tk then draws the fonts at the display's scale and `dpi.px` sizes the
@@ -148,8 +202,9 @@ python -m installer --base FILE --update FILE --keys FILE --lang CODE --dest DIR
The unpacked release; `tools/make_release.py` assembles it and `--zip` packs it:
```
TotK-Setup.exe starts python/pythonw.exe -m installer.gui (installer/launcher/launcher.c, no console)
installer/ the installer: steps, CLI, window, en/ru/zh-Hans text catalog
TotK-Setup.exe starts python/pythonw.exe -m installer.gui (installer/launcher/launcher.c, no console); the
rest is what the Kit step copies into the install folder's build-kit/
installer/ the installer: steps, CLI, window, text catalogs (text/<lang>.json), Sun Valley theme (vendor/)
python/ Python 3.14.9 embeddable + numpy, lz4, cryptography, cffi, pycparser (+ tkinter for the window)
recomp/, tools/ the lifter and the build, extraction and shader scripts the steps run (copied from the repo)
llvm/ llvm-mingw, x86_64-only subset (Apache-2.0 with LLVM exception; mingw-w64 parts permissive)
@@ -157,7 +212,7 @@ runtime/ libtotkrt.a, libtotkrt-v2.a and the headers the generated
include
bin/ totk_xlate.exe, hactool.exe, SDL3.dll, libopus-0.dll, ninja.exe
data/ shader_list.tsv (MacNativeGames, MIT); pgo-<ver>.profdata + .json, the execution profile an
update's code and the runtime libraries compile with (building.md, "Profile-guided build")
update's code and the runtime libraries compile with (pgo.md)
THIRD_PARTY_NOTICES.md
totk.ini.example, VERSION the default ini; the release string (the repository's VERSION plus the commit)
```
+2 -2
View File
@@ -35,7 +35,7 @@ Source shorthands:
|---|---|---|---|---|
| 1.1 | **Colour target the fragment shader does not write keeps its old texel**, even with blending enabled. | Undefined value written/blended. | NXN: zero write mask and no blend for unwritten outputs (`reflection colors`). Already fixed here. | NXN; MNG `games/totk/tests/metal_semantics/probe.m:5` |
| 1.2 | **Unwritten vertex outputs read as (0, 0, 0, 1)** in the next stage, including the unwritten components of a partly written output (VS writes xyz, FS divides by w). | FS input with no VS output: interface mismatch, value undefined; an unwritten component of a written output is undefined (AMD: whatever the register holds, often 0). | Ryujinx initialises exactly the components the next stage reads, but only when stages are linked (`Translation/Translator.cs:212-227`, `NextInputAttributesComponents`); position starts (0,0,0,1) (`:259`). NXN Link's Awakening: sun shadow lookups divided by w = 0, scene dim, no shadows. Ours: missing outputs padded with (0, 0, 0, 1), unlinked outputs initialised by translator patch 0006 (section 7, check 2). | NXN |
| 1.3 | **Clears honour the scissor and the clear's own channel / stencil write mask**, and may come between draws inside a pass. `SET_CLEAR_SURFACE_CONTROL` (0x10f8) has `RESPECT_STENCIL_MASK`, `USE_CLEAR_RECT`, `USE_SCISSOR0`, `USE_VIEWPORT_CLIP0`. | `vkCmdClearAttachments` takes a rect but **ignores the colour write mask**; load-op clears are whole-attachment. | NXN/MNG draw a triangle with the clear's mask (`clear_color_tri`, `clear_ds_tri`); TotK uses mid-pass, partial-mask and partial-scissor clears (NXN). yuzu: "red dot" was clears hitting the wrong RT index (YZ-2305, PR 10243). Hardware recipe (DK3D): `CLEAR_BUFFERS` (`0x674` = 0x19d0) carries the colour channel mask (bits 2-5), depth (0), stencil (1), target id (6-9) and layer (10-20) in one word; `ClearBufferFlags` (`0x43E` = 0x10f8) is set once to `StencilMask | Scissor` (`maxwell/gpu_3d_base.cpp:69`), so every clear is cut by scissor 0 and its stencil bits by the stencil front write mask register, and DK3D's colour clear does not program `ColorWriteMask` (`0x680`). A stencil clear writes `StencilFrontMask` (`0x4E7`) and `ClearStencil` (`0x368`) just before the clear and restores the shadowed state after (`gpu_3d_base.cpp:497-510`). Multisample raster is switched off around a colour clear (`:459, :465`). Arrays: an MME macro repeats the clear for every layer (`maxwell/clear_buffers.mme:5-22`). No pass concept: clears sit between draws. Ours: masked colour and stencil clears are **skipped** (check 3). | OGD 0x10f8; NXN; DK3D `maxwell/gpu_3d_base.cpp:444-512`, `engine_3d.def:305, 644` |
| 1.3 | **Clears honour the scissor and the clear's own channel / stencil write mask**, and may come between draws inside a pass. `SET_CLEAR_SURFACE_CONTROL` (0x10f8) has `RESPECT_STENCIL_MASK`, `USE_CLEAR_RECT`, `USE_SCISSOR0`, `USE_VIEWPORT_CLIP0`. | `vkCmdClearAttachments` takes a rect but **ignores the colour write mask**; load-op clears are whole-attachment. | NXN/MNG draw a triangle with the clear's mask (`clear_color_tri`, `clear_ds_tri`); TotK uses mid-pass, partial-mask and partial-scissor clears (NXN). yuzu: "red dot" was clears hitting the wrong RT index (YZ-2305, PR 10243). Hardware recipe (DK3D): `CLEAR_BUFFERS` (`0x674` = 0x19d0) carries the colour channel mask (bits 2-5), depth (0), stencil (1), target id (6-9) and layer (10-20) in one word; `ClearBufferFlags` (`0x43E` = 0x10f8) is set once to `StencilMask \| Scissor` (`maxwell/gpu_3d_base.cpp:69`), so every clear is cut by scissor 0 and its stencil bits by the stencil front write mask register, and DK3D's colour clear does not program `ColorWriteMask` (`0x680`). A stencil clear writes `StencilFrontMask` (`0x4E7`) and `ClearStencil` (`0x368`) just before the clear and restores the shadowed state after (`gpu_3d_base.cpp:497-510`). Multisample raster is switched off around a colour clear (`:459, :465`). Arrays: an MME macro repeats the clear for every layer (`maxwell/clear_buffers.mme:5-22`). No pass concept: clears sit between draws. Ours: masked colour and stencil clears are **skipped** (check 3). | OGD 0x10f8; NXN; DK3D `maxwell/gpu_3d_base.cpp:444-512`, `engine_3d.def:305, 644` |
| 1.4 | **Conditional rendering** (`SET_RENDER_ENABLE_A..C` 0x1550-0x1558, NVN `SetRenderEnableConditional`) compares two 64-bit counters at `addr` and `addr+16` on the GPU, in command order. TotK wraps nearly every clear in it. A `TIMESTAMP` report writes 0 to the counter field. | `VK_EXT_conditional_rendering` tests one 32-bit word against zero. | NXN: honouring it fixed the black 3D scene (light-volume depth never cleared). deko3d has no conditional rendering at all (no `SET_RENDER_ENABLE` in `engine_3d.def`), so it cannot settle the compare rule. Ours: evaluated on the CPU at record time; a report from an unfinished submission counts as 0 (check 5). | OGD; NXN |
| 1.5 | **Depth mode** is runtime state: `nvnDeviceSetDepthMode` near = -w (GL, NVN default) or 0. Register `SET_VIEWPORT_Z_CLIP` (0x0d7c) `NEGATIVE_W_TO_POSITIVE_W` / `ZERO_TO_POSITIVE_W`. | Vulkan clips z < 0 unless `VK_EXT_depth_clip_control` `negativeOneToOne`. | Ryujinx infers the mode from the viewport transform, falling back to the register (`GetDepthMode`, RYU-SU). NXN: wrong mode either clips everything (black window) or puts all depth in 0.5..1 (DOF blurs the screen). Ours: `negativeOneToOne` from NVN state. DK3D programs both halves: `SetDepthMode` (`0x35F` = 0xd7c) selects the pre-transform clip range, and the viewport transform maps z to [near, far] itself: scale z = `0.5 * (far - near)` and offset z = `0.5 * (near + far)` for -1..1, scale `far - near` and offset `near` for 0..1 (`maxwell/gpu_3d_base.cpp:143-147, 336-343`). Same maths as Vulkan `negativeOneToOne`. | OGD 0x0d7c; NXN-64, NXN; DK3D `maxwell/gpu_3d_base.cpp:136-147, 321-362` |
| 1.6 | **Depth clamp / clip**: `SET_VIEWPORT_CLIP_CONTROL` (0x193c) has separate `PIXEL_MIN_Z`/`PIXEL_MAX_Z` CLIP or CLAMP and geometry-clip modes. | `depthClampEnable` also disables z clipping (unless `VK_EXT_depth_clip_enable`). RADV had a dynamic depth clamp driver bug causing TotK vertex explosions. | Ryujinx: clamp = `!(clip & DepthClampDisabled)` (RYU-SU `UpdateDepthClampState`). yuzu disabled dynamic depth clamp on affected RADV (YZ-2305, PR 10262). DK3D has one switch, `depthClampEnable`, and writes `VIEW_VOLUME_CLIP_CONTROL` (`0x64F` = 0x193c) with `0x101A` when on and `0x181D` when off (default at setup is `0x181D`); it labels the bits "todo: figure out what this actually does". Bits 3-4 (`DepthClampNear/Far`) are set in both values, bits 0-2 and 11 differ. There is no separate depth-clip toggle. The viewport near/far registers (`Viewport` array words 2-3) carry the clamp range and are swapped when far < near (`:349-350`). Vulkan clamp to [min, max] of the viewport depth matches. | OGD 0x193c; DK3D `maxwell/gpu_3d_state.cpp:42`, `gpu_3d_base.cpp:135-139, 349-350`, `engine_3d.def:621` |
@@ -81,7 +81,7 @@ Source shorthands:
| 3.2 | **FMZ multiply mode** (`FMUL/FFMA/...` field `Fmz`, `.FMZ`): 0 × anything = 0, including Inf/NaN (DX9 rule). | IEEE: 0 × Inf = NaN. | Ryujinx decodes `Fmz` (`Decoders/InstDecoders.cs:306-309, 1901`) but no emitter reads it. Ours: same. Census needed (check 13). | RYU-SH |
| 3.3 | **Denormals**: per-instruction `.FTZ`. | AMD flushes fp32 denormals by default; `VK_KHR_shader_float_controls` sets it per shader. | Ryujinx ignores `.FTZ`. Low risk. | RYU-SH (no `Ftz` use in `Instructions/`) |
| 3.4 | **Warp size 32**: `SHFL`, `VOTE`, `S2R LANEID`, ballots are 32-bit. | AMD RDNA runs wave32 or wave64 per shader (the driver chooses; RADV fragment default wave64); `VK_EXT_subgroup_size_control` `requiredSubgroupSize = 32` fixes it. | Ryujinx adapts lane masks to `QueryHostSubgroupSize()` (default 32, `IGpuAccessor.cs:218`; `Instructions/InstEmitWarp.cs:72, 106`, `InstEmitMove.cs:175-185`). Ours: not overridden, no required size (check 6). | <https://docs.mesa3d.org/envvars.html> (`RADV_PERFTEST=pswave32`) |
| 3.5 | **Discard (`KIL`)** keeps the quad's derivatives valid (demote semantics). | `OpKill` terminates; later derivatives in the quad undefined. | Ryujinx emits `OpKill` (`CodeGen/Spirv/Instructions.cs:508`). | — |
| 3.5 | **Discard (`KIL`)** keeps the quad's derivatives valid (demote semantics). | `OpKill` terminates; later derivatives in the quad undefined. | Ryujinx emits `OpKill` (`CodeGen/Spirv/Instructions.cs:508`). Ours: on AMD's own drivers (`vk_caps.amd` without `mesa`) `vk_pipeline.c` `spirv_demote` turns each `OpKill` that a selection header branches to into `OpDemoteToHelperInvocation` plus a branch to the selection's merge block; `TOTK_DEMOTE` overrides. TotK's cloud shader discards and then takes `OpImageQueryLod`: with `OpKill` AMD's Windows driver lost fog in the fragments sharing a quad with a discarded one (#164). | <https://github.com/KhronosGroup/SPIRV-Registry/blob/main/extensions/EXT/SPV_EXT_demote_to_helper_invocation.asciidoc> |
| 3.6 | **Implicit-LOD sampling in divergent control flow** works on Maxwell (TEX unit uses quad neighbours). | Undefined in non-uniform control flow; AMD whole-quad mode usually works. | — | VKSPEC (derivatives) |
| 3.7 | **Integer division** does not exist (compiled to `XMAD`/`IMAD` sequences); MUFU.RCP(0) = +Inf, LG2(0) = -Inf. | Same IEEE edge cases through `1/x`, `Log2`. | Low risk. | — |
| 3.8 | **FP64** in some TotK cutscene shaders. | No FP64 on some hosts. | yuzu FP64 → FP32 (YZ-2306, PR 10693); ours: `softfloat64` job flag (`tools/xlate/Program.cs` `QueryHostSupportsShaderFloat64`). | — |
+70 -10
View File
@@ -34,11 +34,27 @@ packs, gameplay and text changes from GameBanana and similar sites, TKMM's merge
## Order and switches
The Mods tab lists every folder in `mods`. Select a mod and press A or Enter to switch it on or off. The top face button
or Ctrl+Up moves it up, the left face button or Ctrl+Down moves it down. When two mods change the same file, the
higher one wins; the lower mod's row says how many of its files the higher one covers. Changes apply after a restart.
or Ctrl+Up moves it up, the left face button or Ctrl+Down moves it down. Changes apply after a restart.
The menu saves the order and the switches in `totk.ini`, under `[mods]`, by folder name: `mods_order` and
`mods_disabled`. A folder the list does not name yet, such as a new or renamed one, goes below the named ones.
The order decides every conflict, as in PC mod managers: when two mods change the same game file, the same bytes of the
game's data or the same instruction of the game's code, the higher one wins. Moving a mod and restarting is enough; the
game is not rebuilt for it. Each row lists what the mod wins and loses, by mod: "3 of its files come from X, which is
higher in the list", "It overrides 2 code patch sites of Y, which is lower in the list", and the same for game data.
`logs\totk.log` has the same as `mods: X: overrides Y at 2 code sites` and `mods: Y: 2 code sites overridden by X`, and
one line per contested code site.
The menu saves the order and the switches in `totk.ini`, under `[mods]`, by folder name: `mods_order`,
`mods_disabled` and `mods_no_code`. A folder the list does not name yet, such as a new or renamed one, goes below the
named ones.
### Mods with code the port cannot run
Some mods bring code the port cannot run: their own Switch code (a replaced main, or a subsdk plugin the rebuild
refused, as it refuses UltraCam's) or a code patch in a form the port cannot apply. Such a mod stays off as a whole, because its other files may expect
that code. Under its row the Mods tab then shows **Use <mod> without its code** (off by default). Switched on, the code
the port cannot run is left out and the rest of the mod loads after a restart: its game files, cheats and the code
patches that work. The mod's row says which part is left out and why. If the game misbehaves with it, switch it off
again. `mods_without_code = 1` under `[mods]` holds the switch on for every mod.
### Mods that change the same files
@@ -64,17 +80,59 @@ ahead of time, so these patches are built into `totk.exe`:
2. Until the rebuild succeeds, the whole mod stays off, its other files included.
3. After the rebuild the mod switches on and off from the Mods tab like any other, without another rebuild.
The rebuild needs the setup folder the game was installed from. When that folder was moved or deleted, run
`TotK-Setup.exe` again on the same install folder: it does the same job. `mods_rebuild = off` under `[mods]` in
`totk.ini` turns the automatic rebuild off.
The rebuild runs from `build-kit` in the game folder, which the setup put there: the setup folder can be deleted
and the game folder moved. After a move, a game with a code plugin mod rebuilds once at its next start. A game
installed by an older setup (no `build-kit` in its folder) still rebuilds from that setup folder until a newer
setup runs once on it.
`mods_rebuild = off` under `[mods]` in `totk.ini` turns the automatic rebuild off.
A code patch over one of the port's own patches (the 60 FPS patch, the resolution patch and the other entries under
**Built into the port**) turns that built-in patch off while the mod is on. The mod's row names it.
When two mods patch the same instruction, the code of the higher one runs there; the other mod's patches run
everywhere else. The rebuild builds every mod's patch in, so a new order needs only a restart. Two patch files of one
mod that patch the same instruction: the one later by path inside the mod wins, as emulators apply a mod's files in
name order, each over the one before. A cheat that changes the same instruction runs instead of both while it is on.
A patch file may also change the game's data (constants and tables in its `.rodata` and `.data`). Those bytes are
stored into the loaded game at start, before it runs. When two mods write the same bytes, the higher one wins,
as with files.
## Code plugins (exefs subsdk)
Some mods ship their own Switch code as an exlaunch plugin: a file `exefs\subsdk<N>` (The Second Quest's MSFix, Full
Inventory Expansion's sort fixer, Quick Weapon Durability). On the Switch the plugin starts with the game and
redirects some of the game's instructions into its own code. The port does the same with the plugin's code compiled
ahead of time, after the design in [#845](https://github.com/valentderah/totk-pc-recomp/issues/845) by itaskaev2:
1. The rebuild (the same one as for code patches above) compiles the plugins with the game, then starts the game's
code in a service mode that runs only one plugin's start-up (`totk.exe --plugin-init`), twice per plugin, and
records which instructions it redirects. Each redirect becomes a code site of the mod, built into `totk.exe`. Each
plugin is judged on its own: one that is refused, or whose start-up crashes or never returns, stays off with its
reason, and the other plugins are built in.
2. At every start each plugin's start-up runs again, before the game's own start-up code, in the same setting: it
sees the game's own instructions, as in its service run. Its redirects are compared with the record of the
rebuild. When they match, the mod's code sites go on. When they do not, the plugin stays off for this run, the
mod's row says why, and the next start runs the rebuild.
3. The plugin keeps what its start-up made (its memory, its tables), so its code works as on the Switch. The start
costs about 50 ms per plugin; the game runs no differently without a plugin.
4. Removing a plugin mod from the mods folder starts the rebuild at the next start, which builds the game without
it (half a minute on 12 cores with the lift cache). A plugin mod switched off on the Mods tab only stays off.
The Mods tab order decides between a plugin and another mod's patch on the same instruction, as for code patches. A
plugin site over one of the port's own patches turns that built-in patch off while the mod is on.
The rebuild refuses a plugin when its start-up or the code its redirects reach needs what the port does not give it:
system calls other than the few its start-up needs (memory queries and maps, the clock, debug output), library calls
outside a reviewed list (memory and string functions, the heap, text formatting), threads, services or input; a
redirect that is not one of exlaunch's hook shapes (inline hook, replace hook, call-site rewrite); or two runs of its
start-up that differ in code; or a start-up that crashes the service run or does not return within two minutes. The
row then says **Its plugin ... cannot run in the port** with the reason, and the mod stays off; **Use <mod> without its
code** uses the rest of it, including its other plugins that were built in. UltraCam stays refused: it hooks the graphics API,
reads input and opens sockets.
`plugin_trace = 1` in `totk.ini` logs the first call into each of a plugin's hooks (`plugins: hook entry ... reached`).
## Cheats
A cheat file is part of a mod: `mods\<mod>\cheats\<build id>.txt`, switched cheat by cheat on the Cheats tab. Cheats
@@ -111,10 +169,12 @@ keeps its textures at a quarter of the size.
| On the Mods tab | Why | What to do |
|---|---|---|
| This folder has no romfs, exefs or cheats files. | The archive was unpacked one level too deep (`mods\Mod\Mod\romfs`), or it holds no game files. | Move the folders up so `romfs` sits directly in the mod's folder. |
| ... files are made for another game version and are left out. | The mod's files carry another update's version in their names (`.Product.<number>.`). | Download the mod's release for your game update. |
| ... files carry another game version in their names. | The files are named for another update (`.Product.<number>.`) and the game's own files have no such name. They are still served under those names, as on a console, because the game sometimes asks for one; another update's resource size table is the exception and only lends its entries. | Nothing if the mod works. If it does nothing, download its release for your game update. |
| Its code patches (exefs) are made for another game version. | The patch files name another update's build id. | Same: get the release for your update. |
| This mod brings its own game code (a subsdk plugin or a replaced main). | Mods such as UltraCam ship compiled Switch code. The port cannot load it. | No workaround; the whole mod stays off. |
| This mod patches the game code (exefs) in a way the port cannot apply. | The patch writes the game's data, not its code, or changes code in a form the port cannot build. | No workaround; the reason follows on the row. |
| This mod brings its own game code (a subsdk plugin or a replaced main). | The mod replaces the game's main code, which the port cannot load. | The whole mod stays off. **Use <mod> without its code** under its row uses the rest of it, which may expect the missing code (see Mods with code the port cannot run). |
| Its plugin ... cannot run in the port: ... | The rebuild refused the mod's code plugin; the reason follows (see Code plugins). | The whole mod stays off. **Use <mod> without its code** under its row uses the rest of it. |
| Its plugin stays off this time: it started differently from the build. | The plugin redirected other instructions at this start than in the rebuild, for example after the mod was updated in place. | Nothing: the next start runs the rebuild. |
| This mod patches the game code (exefs) in a way the port cannot apply. | The patch changes code in a form the port cannot build, or bytes the port cannot change at start. The reason follows on the row. | The whole mod stays off. **Use <mod> without its code** under its row leaves that patch file out and uses the rest of the mod. |
| The folder name contains \|. | The mod list uses `\|` between names. | Rename the folder. |
A mod never stops the game from starting. Whatever the port cannot use is left out and shown on the Mods tab.
+67
View File
@@ -0,0 +1,67 @@
# Game 1.1.0 patch coverage
The built-in table is [recomp/patches-v110.txt](../recomp/patches-v110.txt). These sites were located in the local 1.1.0 main and checked against its original instruction words, rather than applying a version-wide address shift. The generator rejects a different word or an invalid spin back-edge.
## Added coverage
| Set | Sites added | Runtime control |
| --- | ---: | --- |
| realtime | 1 | Equipment-switch cooldown: step every positive remainder, including values below FLT_EPSILON. Follows the existing real-time clock switch. |
| cursor | 3 | Scale map panning, vertical ability aim and vertical gyro aim by the 30 Hz ratio; follows `TOTK_HIGHFPS_FIX`. |
| aspect | 4 | The two camera and two viewport projections read page +56. The resolution code enables it for non-16:9 output. |
| fov | 2 | The two camera projections multiply their vertical angle by page +60. The field-of-view setting is live; 100 leaves the original path. |
| pooloff | 2 | Widen texture-pool offsets unsigned, covering 2..4 GiB without changing offsets below 2 GiB. Enabled by default; `TOTK_POOL_OFFSET_PATCH=0` retains the original path. |
| shadow | 1 | The sun shadow map takes its fixed size from page +92 before rounding. The shadow-resolution setting enables it; `shadow_res=game` leaves the game's sizing. |
| cascade | 4 | Read the four sun shadow cascade defaults from page +64..76. Shadow range 100 leaves the original constructor. |
| climb | 1 | Climbing speed above 60 fps: the 1.2.1 climb factor in the 1.1.0 climb controller. Follows `TOTK_CLIMB_FIX` and needs the real-time step. |
| gears | 2 | The gear rotation check scales its one-frame threshold by the update's frame delta, so shrine gears read as turning above 30 fps. Follows `TOTK_HIGHFPS_FIX`. |
The table has 16 sets and 54 instruction sites in total. Its 889 spin back-edges are unchanged. The sets use the existing runtime page and settings; no new setting, allocator or renderer path is introduced.
The camera sites were cross-checked by normalized instruction-window matching from the local 1.0.0 main. The viewport routine has two matching copies: both are patched. Other sites were checked through their data flow: the equipment timer and its gate, the map clock, the ability clock, the NVN texture storage/package calls, the shadow size publication and the cascade parameter constructor. FOV's s8 is overwritten by the next original instruction; x10 is saved. The cursor sites use the same scratch registers as their 1.2.1 counterparts.
## Deliberately separate
- Direct mouse: 1.1.0 continues to use stick emulation. Porting the complete camera hook set also needs the runtime layout and load-site table; matching an individual store or one camera mode is not sufficient. No partial set is enabled here.
- Fade: the four 1.4.3 sites are not presumed to exist in 1.1.0. An equivalent zero-increment path has not been established.
- Native Zstandard: the existing host bridge calls back to hard-coded 1.4.3 decoder entry points on fallback. Adding only the BL patches to 1.1.0 would be incorrect.
- Live DLSS scene sizing and game-menu mouse input retain their existing version restrictions. They are not patch-table parity work.
## Validation
Run with Python's numpy, lz4, capstone and unicorn dependencies and a runtime-supported Clang:
```sh
# CC selects the Clang used by the differential harness.
python tests/patches_v110_check.py
python tests/patches_v110_check.py --cflags=-march=x86-64-v2
python tests/patches_v110_check.py --exefs <local ExeFS directory>
```
Without ExeFS, the test uses synthetic memory and the patch table only. It compares the complete integer/SIMD register state, SP and NZCV of the lifted C and Unicorn for all 17 additions, on and off, at 30/60/120 Hz, including pool offsets immediately below and above 2 GiB and at the end of the 32-bit range. Windows test mappings respect its 64 KiB allocation granularity. With ExeFS it additionally validates every original word and spin target. Extracted images and generated C are local build artifacts, never repository content.
These checks establish instruction and code-generation contracts. World-scene visual acceptance, texture packs allocating a pool above 2 GiB, physical gyro and comparisons of shadow quality still require gameplay checks.
## Climbing and gears
Both sets port their 1.2.1 counterparts in [recomp/patches-v121.txt](../recomp/patches-v121.txt); the comments there explain the formulas.
**climb**, one site at main+0x19279f0 (1.2.1: main+0x19182cc) in the climb controller's velocity step at main+0x1927948. The site replaces `fmov s1, #1.5` after the shipping factor 1.272 - 0.362 (r - 1), r in s9, s8 = 0.5. The body between prologue and epilogue is word for word the 1.2.1 one: it reads u = max(page +0, r) and gives s0 = max(s0, h), s1 = max(1.5, h). At r >= 1 h stays at or below the shipping factor, so 30 fps and slower keep it bit for bit; at 60 fps the factor becomes 1.4.3's, about 1.8665 instead of 1.453; above 60 fps g(u) takes over. Unlike 1.2.1, the site does not rely on dead registers: a 96-byte stack frame saves x8 and full q5, q6, q7, q16 and q17 and restores them before the original code continues, so only s0 and s1 change. `TOTK_CLIMB_FIX=0` runs the original `fmov`; [frame_step_init](../runtime/frame_rate.c) switches the set off without the real-time step, where the page is not written.
**gears**, two sites in the ActorCheckRotateModule update at main+0x213eec4 (vtable 0x347e8e8 slot +0x110; 1.2.1: main+0x21350c0). The first, main+0x213eee4, loads the update context's frame delta (x1 + 8) into s12 before the function overwrites x1; the prologue saved d12 at main+0x213eec8, nothing writes s12 before the second site, and callees preserve the low 64 bits of v12. The second, main+0x213f0d4, turns `fdiv s12, s0, s4` into s12 = (s0 / s4) * delta, the RotateStartDeg / 30 threshold scaled by the delta, which the three `fcmp s8, s12` at main+0x213f10c, +0x213f174 and +0x213f1b0 read. It saves full q4 in a 16-byte stack slot and restores it and SP. The set does not read the patch page and works with or without the real-time step; `TOTK_HIGHFPS_FIX=0` keeps both original sites.
Each original window below occurs once in the 1.1.0 main (addresses and hashes, not game bytes):
| Window | Length | SHA-256 |
| --- | ---: | --- |
| +0x19279b0 | 108 bytes | 8262a11c180c734f2692a74e9563140f26d743f0f1f95d31732f975b46c27331 |
| +0x213eee4 | 32 bytes | 17487c0fe195655e9a1bcaf49835208bd1ebca86eeef9a2ca0059752f503e378 |
| +0x213f0d0 | 28 bytes | d07279a2abea53cffbd8861e95034cd1a5c85edf90f6094c5261ba55da203577 |
```sh
python tests/patches_v110_highfps_check.py
python tests/patches_v110_highfps_check.py --cflags=-march=x86-64-v2
python tests/patches_v110_highfps_check.py --exefs <local ExeFS directory>
```
The test lifts both sets and runs them against Unicorn on and off, at 30, 60, 120 and 240 Hz and slower steps, with zero and tiny deltas, adjacent ULPs around 0.5 and at each compare threshold, and all 16 NZCV values (3240 cases). It compares all general and full 128-bit SIMD registers, SP, NZCV and the whole scratch memory: only s0/s1 (climb), x1/s12 (gears) and the exact save slots may change. It also compiles [patches.c](../runtime/patches.c) with frame_step_init for the nine combinations of the three switches. With `--exefs` it checks every original word, the shipping constants, the d12 save, the vtable entry and the three compares with their branch targets. These are instruction and switch contracts; climbing and the shrine gears still need checks in the game.
+120
View File
@@ -0,0 +1,120 @@
# Profile-guided build
A profile-guided build compiles the generated code and the runtime at -O2 with an execution profile: a record of
which functions and branches ran while someone played. Hot paths are laid out straight, hot calls are inlined, and code
that never ran is compiled for size. On 1.4.3 a trained fight ran 12% faster per frame and an untrained fight about
6%; on 1.2.1 the trained fight ran 11% faster.
Each game version has its own profile, `pgo-v121.profdata` and `pgo-v143.profdata`, trained on that version's code.
## How a build uses a profile
- `build_game.py --pgo <file>.profdata` compiles with that profile. Every compile depends on the file, so a new
profile rebuilds everything.
- `tools/pgo.py merge` writes the profile to `build\pgo\pgo-<ver>.profdata`, next to its record `pgo-<ver>.json`. The
record holds the git tree of `recomp/` it was trained on and the digests of the runtime headers the generated C
includes (`cpu.h`, `simd.h`, `simd_fp.h`).
- `make_release.py` ships every profile in `build\pgo` in the release's `data\` folder. It warns when a record names
another `recomp/` tree than the one released, or a header digest differs. The runtime libraries of the release
compile with the newest version's profile.
- The installer builds a player's game with `data\pgo-<ver>.profdata` when the release has one for that version, and
at -O1 without it.
A profile only fits the code it was trained on. clang matches each function by name and control-flow hash, and a
function whose code changed loses its counts without a warning (`build_game.py` passes `-Wno-backend-plugin`, which
hides the "hash mismatch" messages). The inline helpers of `cpu.h`, `simd.h` and `simd_fp.h` become part of every
lifted function, so a change to them invalidates the profile as surely as a generator change: one change to the
floating-point helpers left a profile with a fifth of its weight and 2% of its gain.
## When to retrain
- After a change to the lifter or the generator (`recomp/`) that changes the generated C. Patch table changes
(`recomp/patches-<ver>.txt`) touch only the patched functions and can wait for the next retrain.
- After a change to `runtime/cpu.h`, `runtime/simd.h` or `runtime/simd_fp.h`.
- Before a release whose `make_release.py` run warns about a profile.
Train both versions from the same commit, from a clean `recomp/`.
## Train
### 1. Instrumented build
MSYS2's clang has no profile runtime, so the instrumented build uses llvm-mingw (unpack it under `toolchain\`):
```powershell
$llvm = "toolchain\llvm-mingw-<date>\llvm-mingw-<date>-ucrt-x86_64"
.venv\Scripts\python tools\build_game.py --version v143 --out build\v143-pgogen --toolchain $llvm --pgo gen
```
Regenerate `generated\<ver>` first if it is older than the commit you train on. If `totk.exe` stops at start with
`0xc000007b`, copy `libiconv-2.dll` from `C:\msys64\ucrt64\bin` next to it.
`totk.exe` writes `build\v143-pgogen\pgo\default_<id>.profraw` every minute and at exit. Each run of the same exe adds
to that file.
### 2. Shaders
Copy your `totk.ini` into the build folder and prepare the shaders (`tools\prepare_shaders.py build\v143-pgogen
--version v143`). Shader preparation runs `totk.exe` too, so move `pgo\*.profraw` out of the build folder afterwards:
its counts describe shader building, not play.
Keep the default settings, with the GPU command recorder on (`vk_recorder = 1`, the default).
### 3. Training scenes
The instrumented build runs slower than a normal one. Count each scene's time by the game clock, not by the wall
clock. Spend 90 to 120 seconds on each of the first four scenes, where most frames are spent, and about 60 seconds on
each of the others, which cover code the first four do not reach.
| Place | What to do | Time |
| --- | --- | --- |
| Lookout Landing | Stand in the middle of the town and turn the camera slowly all the way round, then walk through the crowd. | 120 s |
| Kakariko Village | The same: a slow camera turn, then walk between the houses. | 100 s |
| A fight with a Battle Talus | Fight it with weapons and the bow. | 110 s |
| The Depths, near a Lightroot | Turn the camera over the lit area, throw a Brightbloom Seed. | 90 s |
| The Depths, away from any light | Walk and turn the camera in the dark. | 60 s |
| The edge of a sky island | Run off the edge, skydive, open the paraglider. | 60 s |
| Outdoors in the rain | Walk and look around while it rains. | 60 s |
| A cave with Brightbloom plants | Walk in and fight the Moblins and Bokoblins inside. | 60 s |
| Inside a shrine | Walk through the first rooms. | 60 s |
| A Moblin camp | Fight several Moblins at once. | 60 s |
| Next to Yunobo | Use his ability: roll him into something. | 60 s |
| Hyrule Field, by the standing stone pillars | Run across the field, also backwards past the pillars. | 60 s |
Keep two scenes out of the training, so that you can measure on scenes the profile has not seen: Hyrule Field in tall
grass, and a fight with Moblins and Zonai constructs at once.
With a save at a scene, `tools\run_game.py` plays it without you: `--save <backup> --script <input file> --seconds
<game time>` ([agents/running.md](agents/running.md)). Without a save, play the scenes by hand.
### 4. Free play
Then play for 15 to 25 minutes and touch every kind of thing the game does, so that no common path is left without
counts:
- Run, sprint, climb, swim and glide; ride a horse; jump from a tower and skydive.
- Fight with one-handed and two-handed weapons, a spear and the bow; shield parry, flurry rush, fused arrows.
- Use every ability: Ultrahand (build a vehicle with a fan and wheels and drive it), Fuse, Ascend, Recall, Autobuild.
- Call the sages and use their abilities: Tulin, Riju, Sidon, Yunobo, Mineru.
- Open the inventory, the map and the camera; cook at a pot; talk to people in a town.
- Travel quickly to a few places, so that areas load; enter and leave a shrine and the Depths.
- Play in daytime and at night, in clear weather and in rain or snow.
### 5. Merge
```powershell
.venv\Scripts\python tools\pgo.py merge build\v143-pgogen --version v143
```
writes `build\pgo\pgo-v143.profdata` and its record. Merge right after the training, from the checkout and commit the
instrumented build was made in: the record reads the `recomp/` tree from git and the header digests from the build's
Ninja deps log.
Repeat steps 1 to 5 with `v121` for 1.2.1.
## Measure
Build the same code three ways in three folders with llvm-mingw, as the installer does: with the new profile, with
the old one and with none. Prepare the shaders in each folder. Then run the held-out scenes and one trained scene
in the order new, old, none, none, old, new, and compare the mean frame time over the same stretch of game time. One
run of a fight can vary by up to 15% from the next, so a profile counts as better only when it wins both pairs.
+2 -1
View File
@@ -30,6 +30,7 @@ If a PR touches this code, confirm the fix still holds.
| lime silhouettes in grass; rectangles in the sky | a target outside the output map must keep its texel; zero-filling it wiped the half-res depth | `vk_pipeline.c` `target_wmask` |
| stale grass maps in the far terrain for a second after a hit | write-back of a texture the CPU had rewritten | `vk_texture.c` `write_back` |
| cut grass stays standing; fire does not spread (#132) | CPU reads of GPU-rendered textures without an invalidate | `vk_texture.c` `vk_texture_write_back_small`, `nvn_ext.c` `nvn_pool_invalidate` |
| gloom damage on clean ground in the Depths with `sync_ahead` | the game read a one-request pixel buffer before the GPU of the frame in flight wrote it | `vk_memory.c` `vk_mem_shadow_read`, from `nvn_ext.c` `nvn_pool_invalidate` |
| cloud and fog volumes empty for the session | a one-shot draw skipped instead of waiting for its pipeline | `vk_exec_draw.c` `prepare_draw` |
| tile rectangles | storage buffers bound by Ryujinx first-use order, not the c0 slot | `vk_exec_draw.c` `ssbo_slot` |
| black dialog background and loading map | 3D targets rejected, the grading LUT never written | `vk_exec.c` `resolve_target` |
@@ -75,7 +76,7 @@ A PR touching these needs stronger proof.
| #519, #582 amiibo | rewritten by us | took the data-format fixes; left out the features and the Linux event rework |
| #483 vs #585 | #585's mapping kept | #483's stick glyph mapping was rewritten unasked while #585 already had it right |
| #528 rain | taken after a check | code review fine, merged only after a run on a rain save |
| #767 | taken with our fix | the default was skipped with `prompts = xbox|pc` when those folders did not exist |
| #767 | taken with our fix | the default was skipped with `prompts = xbox\|pc` when those folders did not exist |
| #625 frame queue | taken, off by default | a new frame queue, one field run with it on |
| #743 UB overlay | waiting | +25% in a Depths fight on an RTX 4080; needs review, fight runs x2 and shots on AMD |
+56 -3
View File
@@ -14,15 +14,25 @@ Many rows below are developer tools that only act together with another setting
`tests/settings_doc_check.py` fails when a name in `known[]` (`runtime/cfg.c`) is described neither here nor in `totk.ini.example`, or when a default here differs from the code.
## HUD placement
| Setting | What it does | Effect of changing it | Safety |
| --- | --- | --- | --- |
| `hud_width` (default `full`) | `full` places the HUD at the screen's edges; `21:9` or `16:9` constrains it to that centered area on a wider game resolution. A cap that is not narrower than the screen, and 16:9 or taller output, keep the full layout. | Read at start. The Shapes installer step builds the selected cap only for needed screen shapes and button prompts. After a change in the Screen tab an install makes a missing layout in the background; it loads at the next start. If a capped folder is missing the full layout loads with a log message. Explicit overlay overrides and player UI mods keep their precedence. | Safe |
## Diagnostics and logging
| Setting | What it does | Effect of changing it | Safety |
| --- | --- | --- | --- |
| `astc_time` | `1` times the GPU dispatches of each ASTC texture decode and logs the time per block footprint and the largest call. | Adds GPU timestamp queries around every decode; if the queue has no timestamps or no `hostQueryReset`, the log says the decodes are not timed and nothing is measured. | Caution |
| `bind_stats` | `1` counts bindings and descriptors per draw of each stage and how much of the bound state changes between draws. | Adds per-draw bookkeeping to the render thread and extra log output; frames get slower. | Caution |
| `contact_debug` | `1` draws the contact-shadow factor in grey in place of the picture. | The frame shows a grey debug image while it is set; has no effect when contact shadows are off. | Caution |
| `contact_debug` | `1` draws the contact-shadow factor in grey in place of the picture; `2` draws the sun visibility the shadows are scaled by (white in the sun, black in shade and underground). | The frame shows a grey debug image while it is set; has no effect when contact shadows are off. | Caution |
| `core_diag` | `1` records why ready guest threads wait for a virtual core and for how long, with a histogram every 60 presents. | Turns on host-call and SVC depth tracking and writes many log lines (one per present over 25 ms); frames get slower. | Caution |
| `barrier_merge` (default `0`) | Experimental. `1` keeps a render pass open through the game's Barrier calls that ask only for fragment ordering and texture invalidation, when no draw of the pass can write a storage buffer or image; the next draw that samples a written target gets a by-region barrier in the pass (the feedback layout). In scenes with about a thousand such barriers a frame this cuts the passes from about 1200 to 130 and the GPU time from 24.5 to 7.8 ms. | The game's barrier orders every pixel, the in-pass by-region barrier only the pixel a draw writes: a driver that runs it per screen tile can show flicker or squares at the edges of water, decals or particles. | Caution |
| `menu_cursor_log` | `1` logs what the menu cursor code reads at every screen change. | Only adds log lines. | Safe |
| `plugin_tick_offset` (default `0`) | Added to every GetSystemTick in the plugin service run (`totk.exe --plugin-init DIR`), so `tools/exefs_plugins.py` can run a plugin's init twice with other ticks and compare the records. | Has no effect outside `--plugin-init`; a plugin's init at the start of the game gets the plain ticks. | Safe |
| `plugin_trace` (default `0`) | `1` logs the first call of each entry of a mod plugin's hooks (its callbacks, replace and call targets) as `plugins: hook entry ... reached`. | Each such call goes through a counting step; nothing changes without a mod plugin. | Safe |
| `perf_census` (default `1`) | With `TOTK_TRACE=perf` and the import memory mode (`TOTK_MEMORY=import`, the automatic mode on an integrated GPU; the mirror mode of a discrete GPU has its own `mem:` lines instead of the census), `0` turns off the dirty census: the `mem: dirty` lines that count, at every submit, the pages the CPU wrote in the pools the replay binds as buffers. | The census queries the write watch at every submit, 3.5-5 ms of the replay thread a frame on a Steam Deck; with `0` a perf trace measures the frame without that cost, and `tools/perf_summary.py` prints no dirty lines. | Safe |
| `perf_slow_ms` (default `50`) | Frames at least this many milliseconds long get a `perf: slow frame` log line with the time blocked per cause. | Changes how many frames are logged; a small value fills the log. | Safe |
| `replay_check` | `1` reads every texture read-back a second time after a full drain of the replay queue and compares the two. | Stalls the replay queue at every read-back, so frames get much slower; mismatches are only counted and logged. | Caution |
| `resolve_check` | `1` compares every cached pool lookup with the locked lookup and stops on a difference. | Slows every pool lookup; the game stops if the two ever differ. | Caution |
@@ -77,7 +87,9 @@ Many rows below are developer tools that only act together with another setting
| `probe_movie_bench` | `1` makes the movie probe also time the resampler that fits a movie to a game resolution of another shape, and print the time per frame. | Only used by the movie decoder probe. | Safe |
| `swkbd_answer` | `<text>`, `<cancel>` or `<initial>`: answers the on-screen keyboard (for example a horse name) without opening a window. | The game gets that answer every time it asks for text. | Caution |
| `swkbd_test` | `ok` or `cancel` opens the keyboard window and presses OK or Cancel on the first timer tick. | The keyboard window closes by itself. | Caution |
| `test_oom` | `<site>:<n>[,...]` fails the first n allocations at a site: `commit` (guest memory), `staging` (upload buffers), `image` (texture images), `chunk` (draw data buffers). | Each forced failure takes the out-of-memory path: a memory release, a wait of 10 ms per retry and log lines; a large n stalls up to 30 s and then ends the game. | Caution |
| `test_pad` | `<lx>,<ly>,<rx>,<ry>` attaches a virtual gamepad whose sticks rest at these raw SDL axis values (-32768 to 32767). | The game sees a controller with that drift or deflection; a malformed value is logged and ignored. | Caution |
| `test_pad_rumble_ms` | `<n>` gives the `test_pad` gamepad rumble, and each rumble write to it takes n ms, as a slow Bluetooth write does. | Only with `test_pad`; checks that a slow rumble write does not hold up the game thread. | Caution |
| `test_prepare_shaders` | `1` translates every recorded shader on all usable CPUs during start. | Start takes longer and fills the shader cache folder; the CPU is fully used while it runs. | Caution |
## Input
@@ -85,6 +97,9 @@ Many rows below are developer tools that only act together with another setting
| Setting | What it does | Effect of changing it | Safety |
| --- | --- | --- | --- |
| `bind_<button>` | Remaps one Switch button or stick direction to `pad:<name>` or `key:<name>` entries; covers `bind_a`, `bind_b`, `bind_x`, `bind_y`, `bind_l`, `bind_r`, `bind_zl`, `bind_zr`, `bind_plus`, `bind_minus`, `bind_left`, `bind_up`, `bind_right`, `bind_down`, `bind_lclick`, `bind_rclick`, `bind_lstick_left`, `bind_lstick_up`, `bind_lstick_right`, `bind_lstick_down`, `bind_rstick_left`, `bind_rstick_up`, `bind_rstick_right`, `bind_rstick_down` and `bind_shake`. | A line replaces every default of that button; button prompts in the game still show the default layout. The Controls tab of the menu writes these lines; `docs/controls.md` lists the entry names. | Safe |
| `quicksave` (default `0`) | `1`: `quicksave_key` makes one of the game's autosaves at once and keeps a copy as the quick save (`<profile>/quicksave`), `quickload_key` loads that copy (`runtime/quicksave.c`, game 1.4.3, keyboard and mouse keys only; `docs/controls.md`, "Quick save"). | No menu shows; a line at the top of the picture says *Game saved* or why nothing was saved. Quick save takes one of the game's autosave slots and so replaces the oldest autosave, as the game's own autosaves do (the manual save stays); quick load (about 5 s, the picture held while it runs the game's load list underneath) reloads the quick save, losing the progress since. | Save risk |
| `quicksave_key` (default `f6`) | The key of quick save with `quicksave = 1`: a key name of the remapping list (`docs/controls.md`, "Remapping") or `none`; an unknown name is logged and `f6` is used. | While `quicksave = 1` the key reaches no binding. | Safe |
| `quickload_key` (default `f7`) | The key of quick load with `quicksave = 1`, as `quicksave_key`; an unknown name is logged and `f7` is used, the same key as `quicksave_key` leaves loading without a key. | While `quicksave = 1` the key reaches no binding; it reloads the quick save, losing the progress since. | Safe |
## Paths and files
@@ -92,9 +107,12 @@ Many rows below are developer tools that only act together with another setting
| --- | --- | --- | --- |
| `amiibo_dir` | Folder the Amiibo tab starts in; the tab saves the folder you last browsed here. | Only changes which folder the tab lists first. | Safe |
| `exefs` | Folder of the game's ExeFS (with `main.npdm`); a relative path is relative to `totk.exe`'s folder. | Without it, an `exefs` folder next to `totk.exe` is used, else the path set at build time. The game code is compiled into `totk.exe`, and the loader checks the files here by SHA-256, so files from another build or game version stop the start with a message. | Caution |
| `menu_font_fontconfig` (default `1`) | On Linux, `1` asks fontconfig which font file draws each menu language's name, and `0` keeps the fixed distribution paths (`/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc` and four more). The menu merges that file into its font atlas. | `0` is for a system whose fontconfig resolves to a font the menu's parser cannot read; the log then says `menu: system font ... left out`. Has no effect on Windows, where the file names are fixed, and none on a language the ASCII font already draws. The atlas is rebuilt when the window size or the menu language changes. `TOTK_MENU_FONT` names a file directly and wins over both. | Safe |
| `mods_dir` (default `mods`) | Folder that holds one subfolder per player mod, beside `totk.exe`. | Mods found there replace game files; see `docs/mods.md`. | Caution |
| `mods_disabled` | Names of mods that are switched off, separated by `\|`. | Listed mods are not applied; the Mods tab writes this line. | Safe |
| `mods_order` | Mod names, top first, separated by `\|`; the top mod wins a file that two mods replace. | Changes which mod's file the game gets; unlisted mods go below the listed ones, by name. | Safe |
| `mods_no_code` | Names of mods used without their code part, separated by `\|`; the Mods tab's switch "Use ... without its code" writes it. | A listed mod's code modules and the ExeFS patch files the port cannot apply are left out and the rest of the mod loads, where otherwise the whole mod stays off. Its files may expect the missing code. | Caution |
| `mods_order` | Mod names, top first, separated by `\|`; the top mod wins a file, a byte of game data or an instruction of game code that two mods change. | Changes which mod's file, data or code the game gets, at the next start; unlisted mods go below the listed ones, by name. | Safe |
| `mods_without_code` (default `0`) | `1` uses every mod without its code part, as if `mods_no_code` named them all. | See `mods_no_code`. | Caution |
| `pipeline_cache` | Path of the Vulkan pipeline cache file (default `pipeline-cache.bin` beside `totk.exe`). | Moves the cache; a new path starts empty and pipelines are built again. | Caution |
| `profile_dir` | Folder of the game profile, which holds the user account id that save data is named after; the default is a `profile` folder beside `totk.exe`, else the build-time path. | Another folder means a different set of saves. | Save risk |
| `romfs` | Folder of the game's RomFS (with `romfs.bin`); a relative path is relative to `totk.exe`'s folder. | Without it, a `romfs` folder next to `totk.exe` is used, else the build-time path; a missing image stops the start with a message. | Save risk |
@@ -120,10 +138,20 @@ Many rows below are developer tools that only act together with another setting
| Setting | What it does | Effect of changing it | Safety |
| --- | --- | --- | --- |
| `bind_inc` (default `0`) | `1` (or `on`) prepares a draw from what changed since the draw before (the bind ops mark the slots whose bytes they changed) instead of from the whole bound state; `check` prepares every draw as before, takes every decision of `on` beside it, logs each kind of difference once and counts them in a `bind_inc:` line every 300 frames; `0` or `off`: as before. `check` also counts what changed between draws in that line. | Less work per draw on the render thread; a change the marks missed would leave a stale descriptor, a wrong picture or a lost device, which `check` would show first. Off by default: with it on, a GTX 1050 Ti lost the device at one place, after the validation layer reported a descriptor pool reset while a command buffer still used its sets; the cause is not found yet. | Caution |
| `block_views_3d` (default `0`) | `1` gives 3D block-compressed images block views too. | On some AMD cards a GPU write past the end of the image's memory loses the Vulkan device, and the game stops. | Risky |
| `deswizzle` (default `auto`) | Where block-linear textures are deswizzled: `auto` or `gpu` uses a compute pass where the texture's storage is an imported pool and the CPU elsewhere, `cpu` always uses the CPU, `check` uses the GPU and also deswizzles every upload on the CPU and compares the two. | `cpu` brings back the long frames on entering new areas (the replay thread deswizzles every texture); `check` waits for the GPU at every upload and is for testing only. The log names the mode in use. | Caution |
| `dyn_delta` (default `1`) | Records only the pipeline dynamic states (cull mode, depth and stencil tests, vertex input, blend enables, equations and write masks, ...) whose values changed since the last draw in the command buffer, also across pipeline changes; `0` records the full set at every change of pipeline state, as before; `ab` alternates with the `ab` blocks. | Fewer commands per pipeline change on the render and recorder threads; a driver that loses dynamic state across pipeline binds would draw with stale state. `TOTK_TRACE=perf` prints the calls and commands per submission. | Caution |
| `feedback` | `0` samples a target that an earlier draw of the same pass wrote with no barrier; `restart` ends and restarts the pass behind a full barrier; otherwise the feedback-loop layout is used when the GPU supports it. | `0` brings back the old behaviour that the barrier fixed, so the picture can break in passes that read a target they draw into; `restart` costs extra passes. | Risky |
| `flush_span` (default `0`) | `1` copies one span from the lowest to the highest flushed address of a pool, as an older version did. | Copies far more data to the GPU in crowded towns: an estimated 30-50 ms of GPU time per large copy over PCIe 3.0 x8. | Caution |
| `frame_gen` (default `off`) | The frame generator: `off`, or `fsr3`, which brings up AMD FSR 3 frame interpolation and optical flow (FidelityFX SDK 1.1.4) at start; with DLSS off the replay follows the scene and records the motion vectors (the camera's and the moving objects', `fg_objects`), the picture before the HUD and the interpolation of a frame between each two the game draws (`runtime/vk_fg.cpp`). Each frame then goes out as two presents: the generated picture once the GPU has drawn the frame (a timeline wait, not before the pacer's time), the game's half the smoothed interval later (`runtime/vk_backend.c` `present_pair`); `fps_limit` counts the pictures shown and the game draws half, 30 at least (`runtime/frame_rate.c` `frame_step_cap_ns`). Off with DLSS or FSR 3.1 (`scene_upscaler`), `replay_workers` above 0, `sync_ahead = 1` or HDR output, and while a menu background or a loading or event fade is open; the game then draws at the whole limit. The swapchain gets one image more. Applies at once: turned on in the menu, the contexts are made at the next frame (a hitch of about 0.1 s once); turned off, they stay until exit. | The controls answer at the drawn rate, about half a frame later. Costs about 1.5 ms of GPU and 0.6 ms of the replay thread per drawn frame at 1080p (RX 9070, 7900X on 4 cores: 94 drawn without it, 86 drawn and 169 shown with it, no limit). For displays of 120 Hz and more. | Caution |
| `fg_test` | Frame generation checks: `1` presents the generated frame in place of the game's, `2` the picture before the HUD. Read at start. | Shows the frames out of their order: for checks only. | Caution |
| `fg_debug` | `1`: the generated frames hold the SDK's debug view (motion fields, optical flow, disocclusion). Read at start. | For checks only. | Caution |
| `fg_objects` (default `1`) | Frame generation's motion vectors get the per-object pass DLSS uses over the camera's: the moving scene draws (characters, enemies, objects) are drawn again with last frame's blocks (`runtime/vk_exec_draw.c` `vk_mvobj_execute`, `runtime/vk_mvprev.c`). `0`: the camera's motion alone; Link, whom the camera follows, then carries the world's motion and the generated pictures show him twice. Read at start. `dlaa_objmv = 0` also turns the object pass off. | About 0.04 ms of GPU and 0.8 ms of the replay thread per drawn frame (RX 9070, 7900X on 4 cores, field, 1080p: 85.6 drawn with `0`, 80.0 with `1`), half of it the host copy of the uniform snapshot the object pass reads. | Safe |
| `fg_shot` | Frame generation shots: a present number, or `w<seconds>` of world time; the window texture, the generated frame and the picture before the HUD of three frames from there go to `fg_shot_dir` as `fg_<present>_<real\|gen\|hudless>.png`. | Writes PNGs. | Safe |
| `fg_shot_dir` | Folder for the `fg_shot` PNGs (default the working folder). | Only moves the output. | Safe |
| `fg_times` (default `1`) | `0` turns off the GPU timestamps of frame generation's steps; every 600 generated frames a log line gives their GPU times and the replay thread's recording time (median, p99). | Timestamps cost next to nothing. | Safe |
| `shadow_snap` (default `1`) | Shadow storage (Linux, Wine): `1` syncs the pools from per-submission write-watch snapshots, each 2 MiB region queried at most once per submission and shared with the texture checks; `0` queries each pool at every part of a submission, as before. | `1` cut the replay thread's write tracking from about 4.4 to 1.3 ms a frame on a Steam Deck; `0` is for comparison runs. Under Wine/Proton the default is `0` until it has been measured there; `1` turns it on. No effect where shadow storage is off (Windows by default). | Caution |
| `freeze_idle` (default `60`) | Number of submissions a 2 MiB region stays unwritten before it is made read-only; `0` turns the freeze off. | A larger value keeps more regions writable and costs more write tracking; a write to a frozen region costs about 60 microseconds. | Caution |
| `gpl_draw_build` (default `1`) | `0` leaves the missing shader libraries of a waiting draw to its background job instead of building them in parallel at once. | Draws whose pipeline is not ready are skipped meanwhile, until the job finishes. | Caution |
| `lib_prebuild_keep` (default `0`) | Number of recorded graphics shader library variants that stay in memory after the boot prebuild. | Each kept library costs 140-460 KB of memory; the driver cache already makes a rebuild cheap. | Caution |
@@ -134,7 +162,9 @@ Many rows below are developer tools that only act together with another setting
| `pcss_k` (default `0.5`) | Depth-to-penumbra factor of soft shadows at 100 percent, for tuning. | Changes how wide soft shadows blur; has no effect while `pcss` is `0`. | Caution |
| `pipe_sync` | Any value other than `0` or empty stops graphics pipelines from being built in the background. | Pipelines are built on the render path, which causes stutter when new effects appear. | Caution |
| `push_stage` | `fs` pushes the descriptor set from the fragment stage instead of the vertex stage. | The log names the stage in use; the code does not say what changes in the picture. | Unknown |
| `rec_async` (default `1`) | `0` makes the submitting thread wait until the recorder thread has recorded and submitted each part; `ab` alternates with the `ab` blocks. | With `0` the submitting thread waits for every part (about 0.3 ms a frame in a town on a Ryzen 7900X). | Caution |
| `rec_end` (default `1`) | `0` lets the submitting thread begin, end and submit a recorded part again, as older versions did. | On some AMD cards the GPU hangs or the scene turns green and then white when a submission is split. | Risky |
| `rec_spin_us` (default `60`) | Microseconds the recorder thread polls for the next packets before it sleeps; `0` polls 4096 pauses instead; `ab` polls only in the B blocks of `ab`. With fewer than 6 logical processors it always polls 4096 pauses. | A longer poll saves an OS wake-up per packet and takes more CPU time; a shorter one sleeps sooner. | Caution |
| `tex_vram_pressure` (default `90`) | Percent of the device-local memory budget above which released textures are dropped, 0 to 100; `0` is off. First those the game has overwritten with a later texture and left alone for 30 s, then those that can be uploaded again. | A low value drops textures sooner and re-uploads them; `0` keeps them and lets the card spill into system memory. Also a slider in the menu. | Caution |
| `txd_transpose` (default `1`) | `0` turns off the swap of gradient components for gradient texture samples. | Terrain textures turned across the screen show crawling patches again. | Caution |
| `ub_overlay` (default `1`) | `0` copies each uniform update inside a pass into its buffer at once, ending the pass with a full barrier; `ab` alternates with the `ab` blocks. | With `0` scenes with many updated blocks (the terrain, the sky islands) take longer on the GPU; `TOTK_TRACE=perf` prints how many updates stayed in their pass. | Caution |
@@ -143,15 +173,18 @@ Many rows below are developer tools that only act together with another setting
| `vk_no_float64` (default `0`) | `1` clears the 64-bit float feature, so the translator lowers FP64 to FP32. | Shaders change, so the shader cache entries for it are made again; precision of FP64 shaders drops. | Caution |
| `vk_ssbo_align` (default unset) | Power of two that storage buffer offsets are treated as needing, to test the unaligned path. | The translator and the draw code round storage offsets down to it; shaders are translated again. | Caution |
| `vk_subgroup` (default `32`) | Subgroup size to pin where the driver allows it. | A value other than 32 changes what the translator is told about the GPU, and shaders are translated again. | Caution |
| `volume_mask_bias` (default `1`) | `0` leaves the game's water volume mask draws (a volume's front faces tested LEQUAL without depth writes, blended ONE/ONE with reverse subtract) without the depth bias toward the viewer that `vk_pipeline.c` gives them; `ab` alternates with `TOTK_AB`. | Puddles and still water then flicker again where the volume's top face lies on the water surface; a test setting. | Caution |
| `vram_headroom` (default `1`) | `0` turns off the spare half-block of video memory that a background thread keeps per memory type. | Texture allocations on the render thread can wait for a new block again. | Caution |
| `vs_outs` | `all` declares all 32 vertex shader output locations; otherwise only the union of the paired fragment inputs. | Larger vertex shaders and new pipelines; unwritten outputs read the same as before. | Caution |
| `wb_eager` (default `1`) | With `sync_ahead` on, `1` copies small GPU-drawn targets that the game reads back to CPU-readable memory at the end of the frame that drew them, so the write-back at a fence wait does not wait for the GPU; `0` waits as before; `check` reads both ways and compares. Without `sync_ahead` it does nothing. | With `0` the game thread stalls about every ninth frame while the copy queues behind the frame on the GPU, which takes back part of the frame-ahead gain. `check` is slow and for testing. | Caution |
| `wb_exact` (default `1`) | `0` decides write-back of GPU-written textures by page only. | A target that shares a page with data the CPU writes can go unwritten, so a name label next to the reticle can blink. | Caution |
| `wb_merge` (default `1`) | `0` copies GPU-written ranges back as plain copies instead of writing word by word the words that changed. | In mirror memory mode the GPU's copy can overwrite words the CPU wrote, which breaks effects such as falling rain and waterfall splashes. | Caution |
| `wb_merge` (default `1`) | `0` copies GPU-written ranges back as plain copies instead of writing word by word the words that changed; with `shadow = 1` it also leaves ranges the GPU has yet to write back out of the copy into the shadow. | In mirror memory mode, and with `shadow = 1`, the GPU's copy can overwrite words the CPU wrote, which breaks effects such as falling rain and waterfall splashes. | Caution |
## Motion vectors and DLSS
| Setting | What it does | Effect of changing it | Safety |
| --- | --- | --- | --- |
| `dlaa_cam_jitter` (default `1`) | Game 1.4.3: `1` puts the jitter fed to DLSS into the game's camera (the projection's centre terms and the view-projection, where the game copies them into its camera blocks); `0` moves the viewport of the scene's draws instead, as on the other game versions. Needs `ubo_snapshot`. | With `0`, water seen at a low angle flickers with DLAA: the game's full-screen passes rebuild positions with a camera the scene was not drawn with; a test setting. | Caution |
| `dlaa_jitter` (default `1`) | `0` turns off the camera jitter fed to DLSS. | DLSS gets no jitter between frames; a test setting. | Caution |
| `dlaa_maskdebug` (default `0`) | `1` shows the reactive mask in place of the picture. | The frame shows a debug image while it is set. | Caution |
| `dlaa_mv` (default `1`) | `0` sends zero motion vectors to DLSS. | DLSS sees no motion, so moving content can smear; a test setting. | Caution |
@@ -159,6 +192,8 @@ Many rows below are developer tools that only act together with another setting
| `dlaa_survey` (default `0`) | `1` logs what is drawn into the light target that DLSS reads. | Adds log output and per-draw work. | Caution |
| `dlaa_times` (default `0`) | `1` times the DLSS passes on the GPU. | Adds GPU timestamps and log lines. | Caution |
| `dlss_reactive` (default `0`) | `1` builds a reactive mask for DLSS where it ran. | Changes how DLSS blends moving areas; a test setting. | Caution |
| `fsr3_debug` (default `0`) | With `scene_upscaler = fsr3`: `1` creates the FSR 3.1 context with the SDK's input checks, whose warnings go to the log (the first 32). | Adds checks to every FSR 3.1 dispatch and log lines. | Caution |
| `fsr3_view` (default `0`) | With `scene_upscaler = fsr3`: `1` shows FSR 3.1's own debug view of its inputs and state in place of the picture. | The frame shows a debug image while it is set. | Caution |
| `mv_check` | Frame interval; every that many DLSS frames copies the light target and motion images to host memory and logs how well the vectors explain the picture. | Costs a GPU-to-host copy and a comparison on the completion thread at each interval. | Caution |
| `mv_survey` (default `0`) | `1` notes the uniform blocks of each scene draw and compares them with those of earlier frames. | Adds per-draw work and log output. | Caution |
| `mvobj_all` (default `0`) | `1` also lists draws for object motion that read no object blocks (terrain and grass). | More draws are checked and listed, which costs time. | Caution |
@@ -173,6 +208,7 @@ Many rows below are developer tools that only act together with another setting
| `mvprev_grow` (default `1`) | `0` keeps only three banks in the previous-frame tables. | Object motion that depends on the other banks is no longer tracked. | Caution |
| `mvprev_skip` | Hex bank mask of banks left out of the previous-frame copy, replacing the default. | Different banks are tracked, which changes object motion. | Caution |
| `mvprev_trust` | Hex bank mask of banks whose found previous-frame copy is taken without the check. | A copy that does not match is used anyway, which can give wrong motion. | Caution |
| `reflex` (default `off`) | `off`, `on`, or `boost`; enables NVIDIA Reflex Low Latency (`VK_NV_low_latency2`) to reduce system input latency. Read at start. | On NVIDIA GPUs supporting the extension, coordinates simulation and presentation cadence to lower latency, holding frames to the frame limit the pacer uses (`fps_limit`, the monitor's rate for `display`); `boost` keeps GPU clocks high in CPU-bound scenes. Has no effect on non-NVIDIA GPUs. | Safe |
## Scheduling and host
@@ -180,11 +216,21 @@ Many rows below are developer tools that only act together with another setting
| --- | --- | --- | --- |
| `app_pool` | Size in bytes of the guest application memory pool; accepts decimal or `0x` hex. | The default depends on the resolution settings; `0` stops the start with a message, and too small a pool leaves the game without memory. | Risky |
| `audio_off` | Any value mixes audio without opening an output device. | The game runs in silence and reports two channels; same as `audio = none`. | Caution |
| `kspin_us` (default `20`) | Microseconds a guest wait or a wait for a virtual core polls before it sleeps; `0` turns the poll off; `ab` polls only in the B blocks of `ab`. Off with fewer than 6 logical processors. | A wake within the poll costs no OS wake-up; a longer poll takes more CPU time from other threads. | Caution |
| `mem_reserve_mib` (default `1536`) | MiB of system memory kept free for Windows, other programs and the game's own heap when the renderer sizes what it keeps in device memory, where device memory takes system memory (integrated GPUs, and discrete GPUs whose driver charges it to the process). | A larger value keeps fewer released textures and spare blocks when the system runs short; a smaller one lets the game use more before it holds back. | Caution |
| `one_per_core` (default `0`) | `1` keeps the process on the first logical processor of each physical core; `ab` switches it with the `ab` blocks. | Busy threads stop sharing a core with a sibling thread, which can help or hurt on the CPU; it only applies when the CPU has hyperthreads. | Caution |
| `pcore` (default `1`) | On a hybrid CPU (performance and efficiency cores), the game's main and render threads and the replay, recorder and present threads prefer the performance cores; `0` turns that off. | With `0` Windows may run those threads on efficiency cores; no effect on a CPU with one kind of core. The log says which cores were found. | Caution |
| `reexec` | Counter of address-space retries that the runtime sets itself when it starts the process again. | The counter is cleared when the window is recreated; a value of 20 or more stops the start with a fatal error. | Risky |
| `replay_chunks` (default `0`) | Most chunks a submission is cut into when `replay_workers` is set; `0` uses twice the number of recording threads. | Fewer chunks leave threads idle at the end of a submission, more add scan and submit work per chunk; no effect while `replay_workers` is `0`. | Caution |
| `replay_chunk_draws` (default `128`) | Least draws a chunk of the chunked replay holds before it may end at a pass. | Small values make many short chunks, large ones leave big submissions on few threads; no effect while `replay_workers` is `0`. | Caution |
| `replay_state_check` (default `0`) | `1` compares the replay state after the last chunk of a chunked submission with the state of the scan and logs differences. | Adds a comparison per submission and log lines on a mismatch; no effect while `replay_workers` is `0`. | Caution |
| `replay_skew_us` (default `0`) | Debug: the even chunks of a chunked submission wait this many microseconds before they record, so the chunk after each one records first. | Shows a recording that depends on which thread gets to a chunk first in every submission; slows the replay; no effect with fewer than 2 `replay_workers`. | Caution |
| `restart_wait` | Set by the runtime when it restarts itself; names the old process by id and creation time so the new process waits for it to exit. | Meant for the runtime's own use; the code does not describe a manual value. | Unknown |
| `spin` (default `1`) | `0` makes a guest thread that polls memory keep its virtual core. | Polling threads can starve the thread whose item they wait for, so frames can stall. | Caution |
| `spin_handoff_us` (default `50`) | Microseconds a polling wait lasts before it gives its virtual core to a waiting thread. | A shorter value hands cores over sooner; a longer one keeps them longer. | Caution |
| `tex_block_mib` (default `64`) | Block size in MiB of the pool that holds the game's textures; images of a quarter block or more get memory of their own. `0` puts textures in the default pools with the buffers. | Larger blocks hold more memory that no texture uses; smaller ones mean more allocations from the driver. | Caution |
| `tex_released_mib` (default `256`) | MiB of textures the game released that are kept for reuse; older ones beyond it are dropped. `0` keeps up to 2048 of them, whatever their size. | A larger value keeps more device memory and process commit; a smaller one makes the game create more textures again. | Caution |
| `vma_block_mib` (default `64`) | Block size in MiB that the Vulkan memory allocator takes from the driver for buffers and other images on heaps over 1 GiB; larger allocations than half a block get memory of their own. `0` uses the allocator's 256. | Larger blocks hold more memory that nothing uses; smaller ones mean more allocations from the driver. | Caution |
## Generated-code patches
@@ -192,8 +238,15 @@ These names are code patch sets built into the generated game code (`recomp/patc
| Setting | What it does | Effect of changing it | Safety |
| --- | --- | --- | --- |
| `ability_guard` (default `1`) | Patch set that checks the target a Recall or Ultrahand pick hands to the game (1.4.3 main+0x1bd01c4, 1.2.1 main+0x1622bf0) and drops it for that frame where the game's own code would fault on it: the holder, the actor or its component unreadable, or the word the game's reference writes not writable (`runtime/ov_ability.c`). Every other target goes on unchanged; a target that fails UltraTears' live-actor test is only logged (`ability: target kept although ...`). | `0` runs the game's code as shipped: the random crash reading `0xffffffffffffffff` during an ability pick can return. | Risky |
| `aspect_patch` (default `0`) | Patch set that feeds the camera the output's aspect ratio when it is not 16:9. | The resolution code switches this set on or off itself at start, so a value here is replaced; the code does not settle what a manual value does. | Unknown |
| `audio_drain_fix` (default `1`) | Patch set that sends the game's audio thread back to its command ring after each list (1.2.1 main+0x883780, 1.4.3 main+0x149244), so it takes every queued list per 5 ms audio frame instead of one (#337). Game 1.1.0 has no site and keeps the game's code. | `0` runs the game's code as shipped: above about 200 game updates a second the ring fills, and the game's guard (1.2.1 main+0x9bcdc4) switches the sound commands off until the game is restarted once 300 updates in a row find it full. The guard starts over whenever two audio frames fall between two updates, so by the code it fires only while the audio frames come evenly, 5 ms apart: with `audio = none`, or while the audio device takes nothing and the mixer keeps time by its own timer. The guard's count and the switch have not been read in a run. With a device playing the game kept its sound in every run on Linux with PipeWire and 1024-frame device periods, where the frames come in bursts after each period; on Windows the bursts are read from the code (`gap_ns = 0` in `runtime/audren.c`), not measured; a device with periods of 240 frames or less was not tried and may pace as evenly as the timer. The set acts only when more than one list is queued, so below that rate it seldom changes anything. Measured at `fps_limit = 240` (Linux, PipeWire), seconds with sound with `0` and with `1`. On 1.2.1: without a device 6 of 119 and 111 of 119; with a device 111 of 119 and 112 of 119; with the game's stream paused for 5 s from outside (`pw-cli`, not a real device stalling) 4 of 120 (silent from the pause on, also after the device resumed) and 113 of 119; a pause of 2 s silenced the game with `0`, a pause of 1 s did not. On 1.4.3: without a device 3 of 119 and 113 of 120; with a device 111 of 119 with `0`; with the stream paused for 5 s, in 60 s runs, 3 of 59 and 51 of 59; a pause of 2 s with `0`, 4 of 59. | Safe |
| `fixed_res_patch` (default `0`) | Patch set that holds the game's dynamic resolution at 100 percent (the scene tier). | The resolution code switches this set from `dynamic_res` (on at `0`); a manual value is replaced. | Unknown |
| `freecam_patch` (default `0`) | Patch set of the hook in the camera component update behind the free camera (`freecam_pad`, `freecam_key`) on game 1.4.3; the *Free camera* row of the Controls tab. Read at start. | `1` puts the hook in the camera update: while the free camera is off it runs the game's own load and one compare. `0` runs the game's code as shipped: the combo and the key do nothing and the game gets the combo's buttons. | Safe |
| `fov_patch` (default `0`) | Patch set that scales the camera's vertical view angle by the field-of-view setting. | The resolution code switches this set itself whenever the field of view is not 100 percent; a manual value is replaced. | Unknown |
| `mouse_direct_patch` (default `1`) | Patch set of the hooks in the game's camera code behind `mouse_mode = direct` on game 1.4.3. | `0` stops `mouse_mode = direct` from taking effect; other mouse modes are unaffected. | Safe |
| `optref_guard` (default `1`) | Patch set that treats a negative value in the optional reference at object +0x6b0 (1.4.3 main+0x1bd01c0, 1.2.1 main+0x1622bec) as absent instead of loading through it (#1005). | `0` runs the game's code as shipped: the random crash reading `0xffffffffffffffff` after minutes to hours of play can return. | Risky |
| `patch_output` (default `0`) | Patch set that makes the game use the configured output size for its swapchain and display configuration. | The resolution code switches this set whenever the output differs from the base size; a manual value is replaced. | Unknown |
| `patch_scene` (default `0`) | Patch set that makes the game use the configured scene render size. | The resolution code switches this set from the render size setting; a manual value is replaced. | Unknown |
| `report_guard` (default `1`) | Patch set on 1.4.3 only: in the model scene's report loop (main+0xa22d8, main+0xa2310) an object whose report handle is negative or whose row index is 0x8000 or more gets coverage 0 for that frame and its handle reset, the path the game takes after every read, instead of reading past the report rows. On valid rows the game's code runs unchanged. | `0` runs the game's code as shipped: a bad row index reads far past the rows and crashes, the class Weeping of the Empire met while using Ultrahand and aiming. | Risky |
| `shutter_fix` (default `1`) | Patch set on 1.4.3 only (set `shutter`, main+0x25e55d0): the speed the AI node QueryBlackboardGetF32FromActorForOunce returns is scaled by 1 + 0.065 x (1 - frame ratio)^2 when the actor's shouldUseOunceSpeed flag is set, which only the two launchers of Tenbez Shrine (Dungeon034) set (#1215). Every other actor gets its value unchanged; 1.0 at 30 fps and below. | `0` runs the game's code: above about 45 fps the ball leaves the launcher too slowly and stays on the rim of the other launcher or falls into the pit. Measured: on dev at 60 fps the ball stuck from the first shots; with the set at 60 and 120 fps it went back and forth as at 30. | Safe |
+2
View File
@@ -42,6 +42,8 @@ do one run with it and one without (`set TOTK_VK_VALIDATION=`).
If the game stops with a lost device (the log says `device lost` or `VK_ERROR_DEVICE_LOST`), the lines starting with
`vk: pass marks` name the render pass or dispatch the GPU was running. AMD GPUs write them by default. On an NVIDIA GPU,
`set TOTK_PASS_CRUMBS=1` (or GPU pass marks: On in the Advanced tab) before the run that reproduces the crash.
`set TOTK_ADDR_REPORT=1` adds `vk: fault address` lines naming the image or buffer at the faulting address; it slows
the game down over a session, so use it only for that run.
The game keeps running behind other windows (`assume_focus = 0` in `totk.ini` pauses it instead). Shaders the preparation did not cover compile on first use, so
the first minutes of play can stutter.
+7 -17
View File
@@ -12,7 +12,6 @@ line, 3 cancelled (Ctrl+C or Ctrl+Break).
Windows with an NVIDIA RTX GPU (steps.py, Dlss).
"""
import argparse
import hashlib
import signal
import sys
import time
@@ -22,7 +21,7 @@ from . import layout as layouts
from . import state as statefile
from .events import Reporter
from .runner import Context, run_steps
from .steps import all_steps, migrate_state
from .steps import adopt_old_temp, all_steps, migrate_state
EXIT = {'ok': 0, 'failed': 1, 'cancelled': 3}
@@ -33,17 +32,6 @@ class Parser(argparse.ArgumentParser):
sys.exit(2)
# The temp folder inside the install folder when the layout names none (the Linux release); the check step does not
# count it when it requires an empty install folder
TEMP_IN_DEST = '.setup-temp'
def temp_folder(base, dest):
"""One temp folder per install folder, so two installs never share generated files."""
tag = hashlib.sha256(str(dest).lower().encode()).hexdigest()[:8]
return base / f'{dest.name or "root"}-{tag}'
def cancel(signum, frame):
raise KeyboardInterrupt
@@ -58,8 +46,8 @@ def main(argv=None):
ap.add_argument('--lang', help='game language, a Switch language code (en-US, en-GB, ja, de, ru, ...)')
ap.add_argument('--dest', type=Path, required=True, help='install folder')
ap.add_argument('--root', type=Path, help='release folder or repository (default: the folder above installer/)')
ap.add_argument('--temp', type=Path, help='temp folder (default: temp/ of the release on Windows, .setup-temp in '
'the install folder on Linux, build/install-temp in a repository)')
ap.add_argument('--temp', type=Path, help='temp folder (default: build-cache/work in the install folder on Windows, '
'.setup-temp there on Linux, build/install-temp in a repository)')
ap.add_argument('--verify', action='store_true', help='hash every kept file, also those this release made')
ap.add_argument('--dlss', action='store_true', help="download NVIDIA's nvngx_dlss.dll (NVIDIA RTX SDK license) next "
'to the game, for dlaa and the DLSS modes')
@@ -72,10 +60,12 @@ def main(argv=None):
signal.signal(getattr(signal, name), cancel)
layout = layouts.find(args.root)
dest = args.dest.resolve()
base = args.temp or layout.temp
temp = temp_folder(base.resolve(), dest) if base else dest / TEMP_IN_DEST
temp = layouts.temp_for(layout, dest, args.temp)
adopted = adopt_old_temp(layout, dest, temp)
log = temp / 'logs' / time.strftime('install-%Y%m%d-%H%M%S.log')
rep = Reporter(log_path=log)
if adopted:
rep.log(adopted)
t0 = time.monotonic()
try:
state = statefile.load(dest)
+136 -39
View File
@@ -3,11 +3,11 @@
A front end over the CLI (docs/installer.md): it collects the game files, the keys file path, the optional firmware
folder, the game language and the install folder, runs `python -m installer ...` as a subprocess and shows its JSON
events. Decisions live in guilogic.py; this file only draws. The window text is in
installer/text/<en|ru|pt-BR|zh-Hans>.json under "ui.*" and "launcher.*" ids. On Windows the window follows the
installer/text/<lang>.json under "ui.*" and "launcher.*" ids. On Windows the window follows the
display's DPI (installer/dpi.py): fonts and paddings grow with the scale, so Windows does not stretch it.
--selftest [--shots DIR] build every screen in every language and close by itself (PNG per screen with --shots)
--lang en|ru|pt-BR|zh-Hans window language (default: the Windows display language)
--lang en|ru|pt-BR|zh-Hans|de|fr|es|it|nl|ja|ko window language (default: the Windows display language)
--rebuild DIR rebuild the install folder DIR for its mods (totk.exe starts this, build-cache/rebuild.txt):
the run starts at once with that folder, and the game starts again when it succeeds
"""
@@ -28,6 +28,7 @@ dpi.enable()
import tkinter as tk # noqa: E402 (after dpi.enable, see above)
from tkinter import filedialog, messagebox, ttk # noqa: E402
from tkinter import font as tkfont # noqa: E402
try:
from PIL import ImageGrab # only the screenshots of --selftest --shots need it; the release has no PIL
@@ -43,11 +44,15 @@ from .guilogic import (DONE, FAILED, PENDING, RUNNING, SKIPPED, UI_LANGUAGE_LABE
POLL_MS = 100
GLYPH = {PENDING: '\u25cb', RUNNING: '\u25b6', DONE: '\u2714', SKIPPED: '\u2013', FAILED: '\u2716'}
COLOR = {PENDING: '#808080', RUNNING: '#1a5fb4', DONE: '#26a269', SKIPPED: '#808080', FAILED: '#c01c28'}
HEADING = '#303030' # section titles, the details link and the update line: dark grey, no accent colour
MUTED = '#6b6b6b' # secondary text: the details and the footer notice
# The window's pixels at 100%: Tk scales the fonts by itself (tk scaling), these through installer/dpi.py.
PAD = dpi.px(14) # padding of the window and its frames
WRAP = dpi.px(620) # wrap width of the long labels
RECENT_WAIT = 1.5 # seconds the window waits for the recorded paths
# Sun Valley, the Windows 11 look for ttk (sv-ttk 2.6.1, MIT, unmodified; THIRD_PARTY_NOTICES.md)
SUN_VALLEY = Path(__file__).resolve().parent / 'vendor' / 'sv_ttk' / 'sv.tcl'
def load_recent(wait=RECENT_WAIT):
@@ -69,6 +74,46 @@ def fix_tcl_paths():
os.environ[var] = str(tcl / lib)
def use_sun_valley(root, ui_font):
"""Switch the window to the light Sun Valley theme; False leaves the platform theme when it does not load.
The theme sizes its fonts in pixels, which Tk does not scale with the display; they are turned into points (96 DPI
pixels * 0.75) so they grow with tk scaling like the rest of the window. Its Segoe UI Variable families exist on
Windows 11 only; elsewhere the fonts take `ui_font`, bold where the theme asked for Semibold. The theme's images
(check boxes, button and field borders) stay at their 100% pixel size.
sv.tcl answers <<ThemeChanged>> with configure_colors, whose tk_setPalette writes the theme's text and background
colour into every widget and into the option database, over the colours of our label styles (errors, notices,
muted text). The binding is dropped before the switch and the ttk half of configure_colors is done here."""
try:
root.tk.call('source', str(SUN_VALLEY))
root.bind_class('Tk', '<<ThemeChanged>>', '')
style = ttk.Style(root)
style.theme_use('sun-valley-light')
c = {k: root.tk.call('set', f'ttk::theme::sv_light::colors(-{k})') for k in ('fg', 'bg', 'disfg', 'selfg', 'selbg')}
style.configure('.', background=c['bg'], foreground=c['fg'], troughcolor=c['bg'], focuscolor=c['selbg'],
selectbackground=c['selbg'], selectforeground=c['selfg'], insertwidth=1, insertcolor=c['fg'],
fieldbackground=c['bg'], font='SunValleyBodyFont', borderwidth=0, relief='flat')
style.map('.', foreground=[('disabled', c['disfg'])])
root.configure(background=c['bg'])
for cls in ('TEntry', 'TCombobox'): # config_entry_font sets this only on fields that exist at the switch
root.option_add(f'*{cls}.font', 'SunValleyBodyFont')
except (tk.TclError, OSError):
return False
families = set(root.tk.splitlist(root.tk.call('font', 'families')))
for name in root.tk.splitlist(root.tk.call('font', 'names')):
if not str(name).startswith('SunValley'):
continue
f = tkfont.nametofont(str(name), root=root)
size = int(f.cget('size'))
if size < 0:
f.configure(size=round(-size * 0.75))
family = f.cget('family')
if family not in families:
f.configure(family=ui_font, weight='bold' if 'Semibold' in family else 'normal')
return True
class App:
def __init__(self, root, ui_lang, layout, run_args=None, rebuild=None):
self.root, self.layout = root, layout
@@ -102,11 +147,21 @@ class App:
root.protocol('WM_DELETE_WINDOW', self.on_close)
self.ui_font = 'Segoe UI' if os.name == 'nt' else 'DejaVu Sans'
self.mono_font = 'Consolas' if os.name == 'nt' else 'DejaVu Sans Mono'
self.sun_valley = use_sun_valley(root, self.ui_font)
# A read-only combobox selects its text when a value is picked (ttk::combobox::SelectEntry), which draws the
# value as highlighted text; the pick clears that selection once ttk has made it
root.bind_class('TCombobox', '<<ComboboxSelected>>',
lambda e: e.widget.after_idle(e.widget.selection_clear), add='+')
style = ttk.Style(root)
style.configure('Title.TLabel', font=(self.ui_font, 15, 'bold'))
style.configure('Notice.TLabel', background='#fff3cd', foreground='#664d03', padding=dpi.px(8))
style.configure('Err.TLabel', foreground='#c01c28')
style.configure('Version.TLabel', foreground='#808080')
style.configure('Section.TLabel', foreground=HEADING, font=(self.ui_font, 10, 'bold'))
style.configure('Muted.TLabel', foreground=MUTED)
style.configure('Link.TLabel', foreground=HEADING)
style.configure('Status.TLabel', foreground=HEADING)
style.configure('Main.TButton', padding=(dpi.px(16), dpi.px(4))) # Start: the native button, larger
top = ttk.Frame(root, padding=(PAD, PAD, PAD, 0))
top.pack(fill='x')
@@ -179,7 +234,7 @@ class App:
code = self.selected_lang()
self.retext()
self.vars['lang'].set(self.lang_label(code))
self.fit()
self.fit(shrink=True)
def lang_label(self, code):
return self.cat('lang.' + code)
@@ -205,81 +260,117 @@ class App:
f.pack_forget()
self.frames[name].pack(fill='both', expand=True)
self.screen = name
self.fit()
self.fit(shrink=True)
def fit(self):
"""Size the window to its largest screen (an unpacked frame still reports the size its children ask for), so
a screen or language switch neither cuts text nor moves the buttons. The window only grows: opening the log
makes it taller, and a size the user dragged it to stays. Every text change that can add lines calls it again,
or pack takes the missing height from the button bars."""
def fit(self, shrink=False):
"""Size the window: the width of the widest screen (an unpacked frame still reports the size its children ask
for), so a screen or language switch does not move the buttons sideways, and the height of the shown screen,
so no screen carries the empty band of a taller one. Every text change that can add lines calls it again, or
pack takes the missing height from the button bars. Without `shrink` the window only grows and a size the user
dragged it to stays; a screen or language switch and closing the details or the log shrink it to fit."""
self.root.update_idletasks()
sizes = [(f.winfo_reqwidth(), f.winfo_reqheight()) for f in self.frames.values()]
widths = [f.winfo_reqwidth() for f in self.frames.values()]
shown = self.frames[self.screen] if self.screen else max(self.frames.values(), key=lambda f: f.winfo_reqheight())
chrome = self.root.winfo_reqheight() - self.body.winfo_reqheight() # the title row above the body
w = max(self.root.winfo_reqwidth(), max(s[0] for s in sizes) + 2 * PAD)
h = chrome + max(s[1] for s in sizes) + 2 * PAD
if (w, h) == self.fitted: # refresh_run calls it on every poll: leave the window alone while nothing grew
w = max(self.root.winfo_reqwidth(), max(widths) + 2 * PAD)
h = chrome + shown.winfo_reqheight() + 2 * PAD
# refresh_run calls it on every poll: leave the window alone while nothing grew
if (w, h) == self.fitted and (not shrink or self.root.winfo_height() == h):
return
self.fitted = (w, h)
self.root.minsize(w, h)
self.root.geometry(f'{max(w, self.root.winfo_width())}x{max(h, self.root.winfo_height())}')
self.root.geometry(f'{max(w, self.root.winfo_width())}x{h if shrink else max(h, self.root.winfo_height())}')
def notice(self, parent):
w = ttk.Label(parent, style='Notice.TLabel', wraplength=WRAP, justify='left')
self.bind_text(w, 'text', 'ui.notice')
return w
def section(self, grid, row, id, top):
"""A section title across the form grid with a rule after it."""
head = ttk.Frame(grid)
head.grid(row=row, column=0, columnspan=3, sticky='ew', pady=(top, dpi.px(2)))
self.label(head, id, style='Section.TLabel').pack(side='left')
ttk.Separator(head).pack(side='left', fill='x', expand=True, padx=(dpi.px(8), 0), pady=(dpi.px(2), 0))
def build_form(self):
f = ttk.Frame(self.body)
gap = dpi.px(4) # between the form's rows
bar = ttk.Frame(f) # packed first so pack shrinks the text above it, never the buttons
# The footer goes first so pack shrinks the text above it, never the button. The notice sits next to Start,
# where the player looks before the build begins, in quiet text instead of a banner over the form.
bar = ttk.Frame(f)
bar.pack(side='bottom', fill='x', pady=(dpi.px(12), 0))
self.start_button = self.button(bar, 'ui.start', self.start)
self.start_button.pack(side='right')
self.start_button = self.button(bar, 'ui.start', self.start, style='Main.TButton')
self.start_button.pack(side='right', anchor='s')
self.label(bar, 'ui.notice', style='Muted.TLabel', wraplength=dpi.px(470),
justify='left').pack(side='left', anchor='w', padx=(0, dpi.px(12)))
ttk.Separator(f).pack(side='bottom', fill='x', pady=(dpi.px(10), 0))
# The status lines sit on the footer: a window taller than the form leaves its spare height above them
self.form_error = ttk.Label(f, style='Err.TLabel', wraplength=WRAP, justify='left')
self.form_error.pack(side='bottom', anchor='w', pady=(dpi.px(4), 0))
self.update_hint = ttk.Label(f, style='Status.TLabel', wraplength=WRAP, justify='left')
self.update_hint.pack(side='bottom', anchor='w', pady=(dpi.px(8), 0))
self.form_intro = self.label(f, 'ui.intro', wraplength=WRAP, justify='left')
self.form_intro.pack(anchor='w', pady=(0, dpi.px(8)))
self.notice(f).pack(fill='x', pady=(0, dpi.px(10)))
self.form_intro.pack(anchor='w', pady=(0, dpi.px(4)))
grid = ttk.Frame(f)
grid.pack(fill='x')
grid.columnconfigure(1, weight=1)
self.section(grid, 0, 'ui.section_files', dpi.px(6))
rows = (('base', 'ui.base', 'ui.pick_game'), ('update', 'ui.update', 'ui.pick_update'),
('keys', 'ui.keys', 'ui.pick_keys'))
self.form_rows = {}
for i, (name, label_id, pick_id) in enumerate(rows):
for i, (name, label_id, pick_id) in enumerate(rows, start=1):
lab = self.label(grid, label_id)
lab.grid(row=i, column=0, sticky='w', pady=gap, padx=(0, dpi.px(10)))
lab.grid(row=i, column=0, sticky='w', pady=gap, padx=(0, dpi.px(12)))
ttk.Entry(grid, textvariable=self.vars[name]).grid(row=i, column=1, sticky='ew', pady=gap)
b = self.button(grid, 'ui.browse', lambda n=name, p=pick_id: self.pick_file(n, p))
b.grid(row=i, column=2, padx=(dpi.px(8), 0))
self.form_rows[name] = lab
i = len(rows)
self.label(grid, 'ui.firmware').grid(row=i, column=0, sticky='w', pady=gap)
i = len(rows) + 1
self.label(grid, 'ui.firmware').grid(row=i, column=0, sticky='w', pady=gap, padx=(0, dpi.px(12)))
ttk.Entry(grid, textvariable=self.vars['firmware']).grid(row=i, column=1, sticky='ew', pady=gap)
self.button(grid, 'ui.browse', self.pick_firmware).grid(row=i, column=2, padx=(dpi.px(8), 0))
i += 1
self.label(grid, 'ui.game_language').grid(row=i, column=0, sticky='w', pady=gap)
self.section(grid, i + 1, 'ui.section_install', dpi.px(12))
i += 2
self.label(grid, 'ui.game_language').grid(row=i, column=0, sticky='w', pady=gap, padx=(0, dpi.px(12)))
self.lang_box = ttk.Combobox(grid, textvariable=self.vars['lang'], state='readonly', width=30)
self.lang_box.grid(row=i, column=1, sticky='w', pady=gap)
self.lang_touched = False
self.lang_box.bind('<<ComboboxSelected>>', lambda _e: setattr(self, 'lang_touched', True))
self.fill_languages()
self.label(grid, 'ui.dest').grid(row=i + 1, column=0, sticky='w', pady=gap)
self.label(grid, 'ui.dest').grid(row=i + 1, column=0, sticky='w', pady=gap, padx=(0, dpi.px(12)))
ttk.Entry(grid, textvariable=self.vars['dest']).grid(row=i + 1, column=1, sticky='ew', pady=gap)
self.button(grid, 'ui.browse', self.pick_dest).grid(row=i + 1, column=2, padx=(dpi.px(8), 0))
self.label(f, 'ui.compressed_help', wraplength=WRAP, justify='left').pack(anchor='w', pady=(dpi.px(8), 0))
self.label(f, 'ui.firmware_help', wraplength=WRAP, justify='left').pack(anchor='w', pady=(dpi.px(8), 0))
# On by default and named with its source and licence: the player sees what is downloaded and can untick it
# On by default and named with its source and licence: the player sees what is downloaded and can untick it.
# The source and licence line is the first one under More details.
self.dlss_var = tk.BooleanVar(value=True)
dlss = ttk.Checkbutton(f, variable=self.dlss_var)
self.bind_text(dlss, 'text', 'ui.dlss')
dlss.pack(anchor='w', pady=(dpi.px(8), 0))
self.label(f, 'ui.dlss_help', wraplength=WRAP, justify='left').pack(anchor='w', padx=(dpi.px(22), 0))
self.update_hint = ttk.Label(f, wraplength=WRAP, justify='left')
self.update_hint.pack(anchor='w', pady=(dpi.px(8), 0))
self.form_error = ttk.Label(f, style='Err.TLabel', wraplength=WRAP, justify='left')
self.form_error.pack(anchor='w', pady=(dpi.px(8), 0))
self.label(f, 'ui.keys_private', wraplength=WRAP, justify='left').pack(anchor='w', pady=(dpi.px(8), 0))
dlss.pack(anchor='w', pady=(dpi.px(12), 0))
# The explanations stay out of the way until asked for: a link opens them under it
self.details_toggle = ttk.Label(f, style='Link.TLabel', cursor='hand2', takefocus=True)
self.bind_text(self.details_toggle, 'text', 'ui.more_details')
for seq in ('<Button-1>', '<Return>', '<space>'):
self.details_toggle.bind(seq, lambda _e: self.toggle_details())
self.details_toggle.pack(anchor='w', pady=(dpi.px(8), 0))
self.details = ttk.Frame(f) # packed after the link when open; no holder frame, as an emptied Tk frame keeps
# the height its last child gave it
for id in ('ui.dlss_help', 'ui.formats_help', 'ui.compressed_help', 'ui.firmware_help', 'ui.keys_private'):
self.label(self.details, id, style='Muted.TLabel', wraplength=WRAP - dpi.px(16),
justify='left').pack(anchor='w', pady=(dpi.px(6), 0))
self.details_open = False
return f
def toggle_details(self):
self.details_open = not self.details_open
if self.details_open:
self.details.pack(after=self.details_toggle, fill='x', padx=(dpi.px(16), 0))
else:
self.details.pack_forget()
self.bound = [b for b in self.bound if b[0] is not self.details_toggle]
self.bind_text(self.details_toggle, 'text', 'ui.fewer_details' if self.details_open else 'ui.more_details')
self.fit(shrink=not self.details_open)
def build_run(self):
f = ttk.Frame(self.body)
bar = ttk.Frame(f)
@@ -530,7 +621,7 @@ class App:
self.log_frame.pack_forget()
self.bound = [b for b in self.bound if b[0] is not self.log_toggle]
self.bind_text(self.log_toggle, 'text', 'ui.hide_log' if self.log_open else 'ui.show_log')
self.fit()
self.fit(shrink=not self.log_open)
def clear_log(self):
self.log_entries = []
@@ -596,6 +687,7 @@ class App:
self.open_button.state(['!disabled'])
else:
self.open_button.state(['disabled' if not Path(m.dest or '.').is_dir() else '!disabled'])
self.fit() # an error text can be longer than the screen it replaces
def start_game(self):
"""Starts the game of the install folder and closes the window."""
@@ -619,7 +711,7 @@ class App:
# ---- self test ---------------------------------------------------------------------------------------------------
SAMPLE_START = {'type': 'start', 'release': 'selftest', 'mode': 'install', 'dest': 'Z:/selftest/TotK', 'log': 'D:\\log.txt',
'steps': ['check', 'fonts', 'extract', 'lift', 'compile', 'prepare', 'dlss', 'cleanup']}
'steps': ['check', 'fonts', 'extract', 'lift', 'compile', 'prepare', 'pc_prompts', 'shapes', 'dlss', 'cleanup']}
SAMPLE_RUN = [
SAMPLE_START,
{'type': 'plan', 'run': ['check', 'fonts', 'extract'], 'skip': {}},
@@ -687,6 +779,9 @@ def selftest(layout, shots=None):
app.start() # missing files: shows the problems
steps.append(app.form_error.cget('text'))
shot(f'form-{tag}')
app.toggle_details()
shot(f'form-details-{tag}')
app.toggle_details()
app.model = Model()
app.clear_log()
app.build_step_rows(app.model.steps)
@@ -746,7 +841,9 @@ def main(argv=None):
return selftest(layout, args.shots)
fix_tcl_paths()
root = tk.Tk()
App(root, args.lang or windows_ui_language(), layout, rebuild=args.rebuild)
# resolved now: the game starts the build kit's rebuild with the install folder as '.' and the working folder
rebuild = args.rebuild.resolve() if args.rebuild else None
App(root, args.lang or windows_ui_language(), layout, rebuild=rebuild)
root.mainloop()
return 0
+35 -22
View File
@@ -24,17 +24,22 @@ from . import state as statefile
from .events import render
TEXT = Path(__file__).resolve().parent / 'text'
UI_LANGUAGES = ('en', 'ru', 'pt-BR', 'zh-Hans')
UI_LANGUAGES = ('en', 'ru', 'pt-BR', 'zh-Hans', 'de', 'fr', 'es', 'it', 'nl', 'ja', 'ko')
# what the language switch in the window's corner shows for each
UI_LANGUAGE_LABELS = {'en': 'English', 'ru': 'Русский', 'pt-BR': 'Português (Brasil)', 'zh-Hans': '简体中文'}
STEP_ORDER = ('check', 'fonts', 'extract', 'lift', 'compile', 'prepare', 'dlss', 'cleanup')
UI_LANGUAGE_LABELS = {'en': 'English', 'ru': 'Русский', 'pt-BR': 'Português (Brasil)', 'zh-Hans': '简体中文',
'de': 'Deutsch', 'fr': 'Français', 'es': 'Español', 'it': 'Italiano', 'nl': 'Nederlands',
'ja': '日本語', 'ko': '한국어'}
STEP_ORDER = ('check', 'kit', 'fonts', 'extract', 'lift', 'compile', 'prepare', 'pc_prompts', 'shapes', 'dlss',
'cleanup')
# message parameter -> catalog id prefix of the names that replace its raw values
PARAM_NAMES = {'lang': 'lang.', 'known': 'lang.', 'step': 'step.', 'input': 'param.input.'}
LANG_RU = 0x19 # primary language id of Russian in a Windows LANGID
LANG_PT_BR = 0x0416 # Portuguese (Brazil), the whole LANGID: Portugal's Portuguese stays English
# Windows LANGIDs that write Simplified Chinese: zh-CN, zh-SG. zh-TW, zh-HK and zh-MO write Traditional Chinese, which
# the window does not have.
LANGIDS_ZH_HANS = (0x0804, 0x1004)
# primary language id in a Windows LANGID -> window language, for the languages whose every region gets the same text.
# Every Chinese gets Simplified Chinese: the setup has no Traditional Chinese text, as the in-game menu has none.
PRIMARY_LANGS = {0x04: 'zh-Hans', 0x19: 'ru', 0x07: 'de', 0x0c: 'fr', 0x0a: 'es', 0x10: 'it', 0x13: 'nl', 0x11: 'ja',
0x12: 'ko'}
# window language -> the game language the form starts with (default_game_language)
GAME_LANGUAGE_FOR_UI = {'ru': 'ru', 'de': 'de', 'fr': 'fr', 'es': 'es', 'it': 'it', 'nl': 'nl', 'ja': 'ja'}
def load_texts(lang):
@@ -83,11 +88,10 @@ def flat(value):
def windows_ui_language():
"""The window language for the display language: the Windows one (ui_language_for_langid); elsewhere LC_ALL,
LC_MESSAGES or LANG ('ru', 'pt_BR', 'zh_CN' or 'zh_SG', else English)."""
LC_MESSAGES or LANG (ui_language_for_locale)."""
if os.name != 'nt':
loc = (os.environ.get('LC_ALL') or os.environ.get('LC_MESSAGES') or os.environ.get('LANG') or '').lower()
return ('ru' if loc.startswith('ru') else 'pt-BR' if loc.startswith(('pt_br', 'pt-br'))
else 'zh-Hans' if loc.startswith(('zh_cn', 'zh-cn', 'zh_sg', 'zh-sg', 'zh_hans', 'zh-hans')) else 'en')
return ui_language_for_locale(os.environ.get('LC_ALL') or os.environ.get('LC_MESSAGES')
or os.environ.get('LANG') or '')
try:
langid = ctypes.windll.kernel32.GetUserDefaultUILanguage()
except (AttributeError, OSError):
@@ -95,23 +99,32 @@ def windows_ui_language():
return ui_language_for_langid(langid)
def ui_language_for_locale(loc):
"""The window language for a POSIX locale such as 'de_AT.UTF-8': its language, Brazilian Portuguese only for
pt_BR, Simplified Chinese for every Chinese, else English."""
loc = loc.lower().replace('-', '_')
if loc.startswith('pt_br'):
return 'pt-BR'
lang = loc.split('_')[0].split('.')[0]
if lang == 'zh':
return 'zh-Hans'
return lang if lang in PRIMARY_LANGS.values() else 'en'
def ui_language_for_langid(langid):
"""'ru' for a Russian Windows LANGID, 'pt-BR' for Brazilian Portuguese, 'zh-Hans' for a Simplified Chinese one,
else 'en'."""
if langid & 0x3ff == LANG_RU:
return 'ru'
"""The window language for a Windows LANGID: by its primary language (PRIMARY_LANGS), Brazilian Portuguese only
for pt-BR (Portugal's stays English), else 'en'."""
if langid == LANG_PT_BR:
return 'pt-BR'
if langid in LANGIDS_ZH_HANS:
return 'zh-Hans'
return 'en'
return PRIMARY_LANGS.get(langid & 0x3ff, 'en')
def default_game_language(ui):
"""The game language the form starts with. A Chinese window still starts with English: Chinese game text needs
the Switch shared fonts (ini.NEED_SHARED_FONTS), which the setup extracts only from a firmware folder, and the game
stops when they are missing; the player can still pick Chinese."""
return 'ru' if ui == 'ru' else 'en-US'
"""The game language the form starts with: the window's own when the game has it. A Chinese or Korean window
still starts with English: that game text needs the Switch shared fonts (ini.NEED_SHARED_FONTS), which the setup
extracts only from a firmware folder, and the game stops when they are missing; the player can still pick it.
The game has no Brazilian Portuguese, so that window starts with English too."""
return GAME_LANGUAGE_FOR_UI.get(ui, 'en-US')
def gib(n):
+21 -14
View File
@@ -12,26 +12,33 @@
#include "launcher_text.h"
#define LANGID_RUSSIAN 0x19 /* primary language id */
#define LANGID_PT_BR 0x0416 /* the whole LANGID: Portugal's Portuguese stays English */
#define PATH_CHARS (MAX_PATH * 2)
/* The language of the window (installer/guilogic.py ui_language_for_langid): Russian, Simplified Chinese (zh-CN and
zh-SG; the Traditional Chinese regions get English, as the window has no Traditional Chinese), else English. */
/* The language of the window (installer/guilogic.py ui_language_for_langid): Brazilian Portuguese by the whole LANGID,
the rest by the primary language (every Chinese gets Simplified Chinese), else English. */
static void fail(void)
{
static const struct { WORD primary; const wchar_t *title, *text; } by_primary[] = {
{ LANG_RUSSIAN, LAUNCHER_TITLE_RU, LAUNCHER_PYTHON_MISSING_RU },
{ LANG_GERMAN, LAUNCHER_TITLE_DE, LAUNCHER_PYTHON_MISSING_DE },
{ LANG_FRENCH, LAUNCHER_TITLE_FR, LAUNCHER_PYTHON_MISSING_FR },
{ LANG_SPANISH, LAUNCHER_TITLE_ES, LAUNCHER_PYTHON_MISSING_ES },
{ LANG_ITALIAN, LAUNCHER_TITLE_IT, LAUNCHER_PYTHON_MISSING_IT },
{ LANG_DUTCH, LAUNCHER_TITLE_NL, LAUNCHER_PYTHON_MISSING_NL },
{ LANG_JAPANESE, LAUNCHER_TITLE_JA, LAUNCHER_PYTHON_MISSING_JA },
{ LANG_KOREAN, LAUNCHER_TITLE_KO, LAUNCHER_PYTHON_MISSING_KO },
{ LANG_CHINESE, LAUNCHER_TITLE_ZH_HANS, LAUNCHER_PYTHON_MISSING_ZH_HANS },
};
LANGID ui = GetUserDefaultUILanguage();
int russian = (ui & 0x3ff) == LANGID_RUSSIAN, brazilian = ui == LANGID_PT_BR;
int chinese = ui == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_SIMPLIFIED) ||
ui == MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_SINGAPORE);
MessageBoxW(NULL,
russian ? LAUNCHER_PYTHON_MISSING_RU
: brazilian ? LAUNCHER_PYTHON_MISSING_PT_BR
: chinese ? LAUNCHER_PYTHON_MISSING_ZH_HANS
: LAUNCHER_PYTHON_MISSING_EN,
russian ? LAUNCHER_TITLE_RU : brazilian ? LAUNCHER_TITLE_PT_BR : chinese ? LAUNCHER_TITLE_ZH_HANS
: LAUNCHER_TITLE_EN,
MB_OK | MB_ICONERROR);
const wchar_t *title = LAUNCHER_TITLE_EN, *text = LAUNCHER_PYTHON_MISSING_EN;
if (ui == LANGID_PT_BR) {
title = LAUNCHER_TITLE_PT_BR; text = LAUNCHER_PYTHON_MISSING_PT_BR;
} else {
for (size_t i = 0; i < sizeof by_primary / sizeof by_primary[0]; i++)
if (PRIMARYLANGID(ui) == by_primary[i].primary) { title = by_primary[i].title; text = by_primary[i].text; }
}
MessageBoxW(NULL, text, title, MB_OK | MB_ICONERROR);
}
int WINAPI WinMain(HINSTANCE instance, HINSTANCE previous, LPSTR command_line, int show)
+46 -6
View File
@@ -16,7 +16,13 @@ Release (docs/installer.md "Release layout"), root = the unpacked folder:
without one the game is built at -O1
totk.ini.example
VERSION the release version, one line
temp/ the default temp folder (created)
Build kit (Windows release): the setup copies the release folder without TotK-Setup.exe into <install>/build-kit
(KIT_ITEMS, steps.py Kit) and runs every later step from it, so the game's rebuild for its mods
(build-cache/rebuild.txt, relative to the install folder) needs neither the setup folder nor its path: the setup can be
deleted and the install folder moved. The kit is a release folder itself (release_layout). The temp folder with the
rebuild's working state (gen/, build/, the lift cache) is <install>/build-cache/work (TEMP_IN_DEST), so it moves
with the install and survives a newer setup's kit.
Linux release (the AppImage's folder, docs/installer.md "Linux release"): python/bin/python3 (python-build-standalone,
with tkinter), llvm/ with clang, lld and llvm-ar plus llvm/sysroot (the glibc headers and libraries the game links
@@ -26,9 +32,11 @@ Dev mode, root = a repository checkout (no python/python.exe): build/py314-embed
Python the release ships, with the same packages), else this Python; toolchain/llvm-mingw-*/ and toolchain/deps-mingw;
runtime/ as the sources with build/install-rtlib/libtotkrt.a and libtotkrt-v2.a (tools/build_game.py --make-runtime-lib
--out build/install-rtlib, once per --cpu); MSYS2 UCRT64 ninja.exe; toolchain/hactool; build/xlate/totk_xlate.exe; the shader list from
refs/MacNativeGames; build/pgo/pgo-<v>.profdata when there is one; build/install-temp. The version is VERSION with -dev and the commit: 0.1.0-dev+973c626. On Linux,
dev mode takes clang, lld and ninja from PATH and the system's libraries (no deps folder, no SDL3 copy).
refs/MacNativeGames; build/pgo/pgo-<v>.profdata when there is one; build/install-temp/<install name>-<hash>. The
version is VERSION with -dev and the commit: 0.1.0-dev+973c626. Dev mode and the Linux release install no build kit:
the repository, or the AppImage file, is what the rebuild runs. On Linux, dev mode takes clang, lld and ninja from PATH and the system's libraries (no deps folder, no SDL3 copy).
"""
import hashlib
import os
import shutil
import subprocess
@@ -40,6 +48,14 @@ WIN = os.name == 'nt'
EXE = '.exe' if WIN else ''
UCRT = Path(r'C:\msys64\ucrt64\bin')
SUPPORTED = ('1.2.1', '1.4.3', '1.1.0') # updates the installer builds; the check identifies the player's by hash
KIT = 'build-kit' # the build kit's folder in the install folder
# What the build kit holds of a release folder (tools/make_release.py writes them): all but TotK-Setup.exe. licenses/
# and THIRD_PARTY_NOTICES.md go along with the binaries they cover.
KIT_ITEMS = ('python', 'llvm', 'runtime', 'bin', 'recomp', 'tools', 'data', 'installer', 'licenses',
'THIRD_PARTY_NOTICES.md', 'totk.ini.example', 'VERSION')
# The temp folder inside the install folder, for a layout that names none (every release); the check step does not
# count it when it requires an empty install folder. Linux keeps the name its installs already use.
TEMP_IN_DEST = Path('build-cache', 'work') if WIN else Path('.setup-temp')
def version_tag(version):
@@ -139,9 +155,10 @@ def release_layout(root):
dlls=(root / 'bin' / 'SDL3.dll', root / 'bin' / 'libopus-0.dll') if WIN else (root / 'bin' / 'libSDL3.so.0',),
shader_list=root / 'data' / 'shader_list.tsv', ini_example=root / 'totk.ini.example',
pgo_dir=root / 'data' if WIN else None,
# Linux: None, the install folder's .setup-temp (installer/cli.py): the AppImage is mounted read-only, and on
# a Steam Deck /home is often too full for the generated C while the install folder is on the SD card
temp=root / 'temp' if WIN else None,
# None: the install folder's TEMP_IN_DEST (temp_for). Windows: the rebuild's working state stays with the install
# and its build kit. Linux: the AppImage is mounted read-only, and on a Steam Deck /home is often too full for
# the generated C while the install folder is on the SD card
temp=None,
sysroot=None if WIN else root / 'llvm' / 'sysroot')
@@ -191,3 +208,26 @@ def find(root=None):
"""The layout of root (default: the folder above this package)."""
root = Path(root or Path(__file__).resolve().parent.parent).resolve()
return release_layout(root) if is_release(root) else dev_layout(root)
def uses_kit(layout):
"""True when the setup installs a build kit (Windows release); dev mode and the Linux AppImage run from where they
are."""
return WIN and not layout.dev
def kit_folder(dest):
return Path(dest) / KIT
def temp_folder(base, dest):
"""One temp folder per install folder below a shared base (dev mode, --temp), so two installs never share
generated files."""
tag = hashlib.sha256(str(dest).lower().encode()).hexdigest()[:8]
return base / f'{dest.name or "root"}-{tag}'
def temp_for(layout, dest, override=None):
"""The temp folder of a run on dest: below --temp or the layout's, else TEMP_IN_DEST in the install folder."""
base = override or layout.temp
return temp_folder(Path(base).resolve(), dest) if base else dest / TEMP_IN_DEST
+6
View File
@@ -49,6 +49,10 @@ class Step:
"""Do the work. Returns fields to record with the step."""
return {}
def settle(self, ctx):
"""After the step ran or was skipped: a step whose output the later steps run from (the build kit) points the
context at it."""
class Context:
def __init__(self, layout, dest, temp, reporter, options, state=None, verify=False):
@@ -121,6 +125,7 @@ def run_steps(steps, ctx):
for s in steps:
if not ctx.runs[s.id]:
rep.step(s.id, 'skipped', reason=ctx.reasons[s.id])
s.settle(ctx)
continue
current = s.id
rep.step(s.id, 'started')
@@ -133,6 +138,7 @@ def run_steps(steps, ctx):
ctx.save() # the first save, after the check, creates the install folder
rep.step(s.id, 'done', seconds=seconds)
current = None
s.settle(ctx)
ctx.state['release'] = ctx.layout.release
ctx.save()
return 'ok'
+184
View File
@@ -0,0 +1,184 @@
"""The screen shapes and button prompts this player needs RomFS patch folders for (steps.Shapes).
A game resolution of another shape than 16:9 takes romfs-patches-<w>x<h>, the UI laid out for that shape
(tools/make_romfs_patches.py --aspect), and the prompts' folder of that shape (romfs-patches-<style>-<w>x<h>). The
layout depends only on the aspect ratio (tools/ultrawide_layout.py apply), so the setup writes one folder per shape,
named after the shape's size in ASPECT_SIZES (shape_size); runtime/romfs.c overlay_init maps the game resolution the
same way (cfg.c cfg_shape_size). It writes them only for the shapes of the connected displays and the totk.ini
output_res, and the prompts' ones only for the style totk.ini selects (prompts_style).
"""
import ctypes
import os
import re
import shutil
import subprocess
from pathlib import Path
# The game resolutions of another shape than 16:9 that runtime/ui/menu.cpp row_output_res lists, in the order of
# runtime/cfg.c SHAPED: 21:9 and 32:9 monitors, 16:10 screens (the Steam Deck's 1280x800, handhelds and laptops) and 3:2
# screens (Surface and Framework laptops and tablets)
ASPECT_SIZES = ('2560x1080', '3440x1440', '3840x1600', '5120x2160', '3840x1080', '5120x1440',
'1280x800', '1680x1050', '1920x1200', '2560x1600',
'1920x1280', '2160x1440', '2256x1504', '2880x1920', '3000x2000')
SHAPED = tuple(tuple(int(v) for v in s.split('x')) for s in ASPECT_SIZES)
TOLERANCE = 0.01 # cfg.c and resolution.c res_is_16x9: shapes within 1% are the same
def is_16x9(w, h):
return abs((w / h) / (16 / 9) - 1) <= TOLERANCE
def shape_size(w, h):
"""The folder size of w x h's shape: of ASPECT_SIZES within 1% of its aspect ratio, the closest, the first of equal
ones (5120x2160 is 2560x1080's shape). None for 16:9 and for a shape the setup has no layout for. The same rule as
runtime/cfg.c cfg_shape_size."""
if not w or not h or is_16x9(w, h):
return None
r, best, err = w / h, None, None
for sw, sh in SHAPED:
e = abs(sw / sh / r - 1)
if e <= TOLERANCE and (err is None or e < err):
best, err = f'{sw}x{sh}', e
return best
def default_size(w, h):
"""The output_res the game picks on a display of w x h while totk.ini sets none (runtime/cfg.c screen_default): of
ASPECT_SIZES within 1% of its shape, the smallest at least 1080 high that fits, else the largest that fits."""
if not w or not h or is_16x9(w, h):
return None
r, best, fit = w / h, None, None
for sw, sh in SHAPED:
if abs(sw / sh / r - 1) > TOLERANCE or sw > w or sh > h:
continue
if fit is None or sw > fit[0]:
fit = (sw, sh)
if sh >= 1080 and (best is None or sw < best[0]):
best = (sw, sh)
best = best or fit
return f'{best[0]}x{best[1]}' if best else None
# ---- the connected displays, as (width, height) of their current mode, the long side first (a portrait monitor or
# the Steam Deck's panel reports its height first; the game window is landscape)
class DISPLAY_DEVICEW(ctypes.Structure):
_fields_ = [('cb', ctypes.c_uint32), ('DeviceName', ctypes.c_wchar * 32), ('DeviceString', ctypes.c_wchar * 128),
('StateFlags', ctypes.c_uint32), ('DeviceID', ctypes.c_wchar * 128), ('DeviceKey', ctypes.c_wchar * 128)]
ATTACHED_TO_DESKTOP = 0x1
ENUM_CURRENT_SETTINGS = -1
DEVMODEW_SIZE = 220 # DEVMODEW: dmSize at 68, dmPelsWidth at 172, dmPelsHeight at 176
DEVMODE_PELS = 172
def windows_displays():
"""Every display attached to the desktop: EnumDisplayDevicesW over the adapters, EnumDisplaySettingsW for the
current mode, which is in pixels whatever the DPI awareness of this process."""
user32 = ctypes.WinDLL('user32')
out, i = [], 0
while True:
dev = DISPLAY_DEVICEW()
dev.cb = ctypes.sizeof(dev)
if not user32.EnumDisplayDevicesW(None, i, ctypes.byref(dev), 0):
break
i += 1
if not dev.StateFlags & ATTACHED_TO_DESKTOP:
continue
mode = ctypes.create_string_buffer(DEVMODEW_SIZE)
ctypes.c_uint16.from_buffer(mode, 68).value = DEVMODEW_SIZE
if user32.EnumDisplaySettingsW(dev.DeviceName, ENUM_CURRENT_SETTINGS, mode):
out.append((ctypes.c_uint32.from_buffer(mode, DEVMODE_PELS).value,
ctypes.c_uint32.from_buffer(mode, DEVMODE_PELS + 4).value))
return out
XRANDR = re.compile(r'\sconnected\s+(?:primary\s+)?(\d+)x(\d+)\+')
def linux_displays():
"""xrandr's connected outputs (X11 and XWayland); without xrandr the preferred mode of each connected DRM
connector."""
if shutil.which('xrandr'):
try:
text = subprocess.run(['xrandr', '--current'], capture_output=True, text=True, timeout=10).stdout
found = [(int(w), int(h)) for w, h in XRANDR.findall(text)]
if found:
return found
except (OSError, subprocess.SubprocessError):
pass
out = []
for conn in sorted(Path('/sys/class/drm').glob('card*-*')):
try:
if (conn / 'status').read_text().strip() != 'connected':
continue
m = re.match(r'(\d+)x(\d+)', (conn / 'modes').read_text())
except OSError:
continue
if m:
out.append((int(m.group(1)), int(m.group(2))))
return out
def displays():
try:
found = windows_displays() if os.name == 'nt' else linux_displays()
except (OSError, AttributeError, ValueError):
found = []
return sorted({(max(w, h), min(w, h)) for w, h in found if w and h})
# ---- totk.ini (runtime/cfg.c reads the same keys, in any section, with or without the totk_ prefix)
def ini_value(text, name):
value = None
for line in text.splitlines():
m = re.match(rf'^\s*(?:totk_)?{name}\s*=\s*([^\s#;]*)', line, re.IGNORECASE)
if m:
value = m.group(1)
return value
# The pad prompts' folder suffixes (make_romfs_patches.py --prompts), each written at 16:9 on every install
# (steps.Prepare): the Xbox and PlayStation ones, for the Nintendo pad layout and for xbox and auto
PAD_PROMPTS = ('xbox', 'xbox-label', 'playstation', 'playstation-xbox')
# Every prompts folder suffix: the pad ones and the keyboard and mouse one (steps.PcPrompts)
PROMPTS_STYLES = PAD_PROMPTS + ('pc',)
def prompts_style(text):
"""The prompts' folder suffix the settings select, as runtime/input_map.c input_prompts_pick and
input_prompts_folder pick it at start: 'pc', 'xbox' or 'playstation' (Nintendo pad layout), 'xbox-label' or
'playstation-xbox' (any other), or None for the game's own prompts, the default without a totk.ini."""
p, layout = (ini_value(text, 'prompts') or '').lower(), (ini_value(text, 'pad_layout') or '').lower()
if p == 'pc':
return 'pc'
nintendo = layout in ('nintendo', 'xbox_prompts')
if p in ('playstation', 'ps'):
return 'playstation' if nintendo else 'playstation-xbox'
if not (p == 'xbox' if p else layout == 'xbox_prompts'):
return None
return 'xbox' if nintendo else 'xbox-label'
def wanted(dest, screens=None):
"""(sizes, style): the shape sizes to write layouts for, sorted, and the prompts style. A shape is wanted for each
display's own size and for the output_res the game defaults to there, and for the totk.ini output_res."""
screens = displays() if screens is None else screens
try:
text = (Path(dest) / 'totk.ini').read_text(encoding='utf-8-sig', errors='replace')
except OSError:
text = ''
sizes = set()
for w, h in screens:
w, h = max(w, h), min(w, h)
sizes.add(shape_size(w, h))
d = default_size(w, h)
if d:
sizes.add(shape_size(*(int(v) for v in d.split('x'))))
m = re.fullmatch(r'(\d+)x(\d+)', (ini_value(text, 'output_res') or '').lower())
if m:
sizes.add(shape_size(int(m.group(1)), int(m.group(2))))
sizes.discard(None)
return sorted(sizes, key=ASPECT_SIZES.index), prompts_style(text)
+455 -59
View File
@@ -1,4 +1,5 @@
"""The eight setup steps of docs/installer.md: check, fonts, extract, lift, compile, prepare, dlss, cleanup.
"""The eleven setup steps of docs/installer.md: check, kit, fonts, extract, lift, compile, prepare, pc_prompts, shapes,
dlss, cleanup.
Extraction runs in this process through tools/extract.py (the package's sibling tools/, which ships with it); fonts
runs the vendored extract_shared_fonts.py on the firmware folder; lift, compile and prepare run the bundled Python on
@@ -8,18 +9,23 @@ with the bundled clang (hostcheck.c).
Install folder: exefs/, romfs/ (romfs.bin, index.json), profile/, shared-fonts/ (Chinese and Korean text), totk.exe
and its DLLs, nvngx_dlss.dll (with --dlss), romfs-index.bin, romfs-patches/, romfs-patches-xbox/,
romfs-patches-xbox-label/, romfs-patches-pc/, totk_xlate.exe, the
shader state of totk.exe --prepare-shaders, totk.ini, totk-install.json.
Temp folder (<temp>/<dest name>-<hash>): check/ (ExeFS of both inputs, the host check), unpacked/ (the NSP of an NSZ
or XCZ input until the extraction is done), gen/ (C), build/ (objects), logs/. The cleanup keeps gen/, build/ and
logs/: the next run lifts into the same gen/, where recomp/gen.py rewrites only the chunks whose C changed, and Ninja
in build/ recompiles only those. A change of the mods' code cheats then costs the lift (about a minute) and the chunks
it touches, not a full compile.
romfs-patches-xbox-label/, romfs-patches-pc/, romfs-patches-<w>x<h>/ and romfs-patches-<style>-<w>x<h>/ (for the
screen shapes and the prompts style this player needs, installer/screens.py), totk_xlate.exe, the
shader state of totk.exe --prepare-shaders, totk.ini, totk-install.json, and on Windows build-kit/ (Kit): the release
folder the steps after the kit step run from, and the game's rebuild with them.
Temp folder (build-cache/work in the install folder on Windows, .setup-temp there on Linux, <temp>/<dest name>-<hash>
with --temp or in a repository; installer/layout.py temp_for): check/ (ExeFS of both inputs, the host check),
unpacked/ (the NSP of an NSZ or XCZ input until the extraction is done), gen/ (C), build/ (objects), logs/. The cleanup keeps gen/, build/ and
logs/: the next run lifts into the same gen/, where recomp/gen.py lifts again only the chunks whose inputs changed (its
lift cache, gen/<mod>/lift_cache.json) and rewrites only those whose C changed, and Ninja in build/ recompiles only
those. A change of the mods' code cheats then costs a few seconds of lift and the chunks holding its sites, not a full
lift or compile.
Install folder build-cache/: cheats.status (tools/cheats.py), exefs.status and exefs.data (tools/exefs_patches.py) and
Install folder build-cache/: cheats.status (tools/cheats.py), exefs.status and exefs.data (tools/exefs_patches.py),
plugins.status (tools/exefs_plugins.py; plugins.stale is the game's list of plugins whose start differed) and
rebuild.txt, the command that starts this setup in its rebuild mode on the install folder (installer/gui.py --rebuild),
one argument per line; totk.exe runs it at start when an enabled mod has code cheats the build lacks
(runtime/cheats.c).
one argument per line, relative to the install folder for the build kit; totk.exe runs it at start when an enabled mod
has code cheats the build lacks (runtime/cheats.c).
"""
import hashlib
import http.client
@@ -35,7 +41,8 @@ import time
import urllib.request
from pathlib import Path
from . import ini
from . import ini, screens
from . import layout as layouts
from .layout import EXE, SUPPORTED, version_tag
from .runner import InstallError, Step
@@ -49,6 +56,7 @@ from extract_exefs import (common_tickets, container_entries, load_keys, nca_ctr
GiB = 1 << 30
DEST_EXTRA = 4 * GiB # beside the RomFS: shader and pipeline caches (about 2 GB), exefs, totk.exe, seed files
TEMP_NEED = 3 * GiB # generated C (about 0.9 GB) and objects
KIT_NEED = 1 * GiB # the build kit (Kit), about 0.65 GB
HOSTCHECK = Path(__file__).resolve().parent / 'hostcheck.c'
STAMP = '.install-key'
@@ -139,6 +147,17 @@ def linux_kernel():
return (int(m.group(1)), int(m.group(2))) if m else None
def link_output_locked(log):
"""Whether a build failed because another program holds the exe the linker writes: ld.lld cannot write it and clang
cannot remove it (Permission denied). A game started from the temp build folder does that, and so does an
antivirus that flagged or quarantined the new totk.exe there (#1122)."""
try:
text = Path(log).read_text(encoding='utf-8', errors='replace')
except OSError:
return False
return 'failed to write output' in text and 'Permission denied' in text
def run_tool(ctx, step, script, args, parse=None, cwd=None):
"""Run a tool script with the bundled Python. Its output goes to <temp>/logs/<step>-<script>.log and, line by line,
to parse(line). Returns (exit code, log path)."""
@@ -168,7 +187,8 @@ def run_tool(ctx, step, script, args, parse=None, cwd=None):
def free_bytes(path):
"""Free bytes on the disk of path (its nearest existing parent) and that parent's device."""
p = Path(path)
while not p.exists():
# An unavailable drive or share has no existing ancestor: let disk_usage report its OS error at the root.
while not p.exists() and p.parent != p:
p = p.parent
return shutil.disk_usage(p).free, os.stat(p).st_dev
@@ -582,6 +602,8 @@ class Check(Step):
dest_need -= romfs.stat().st_size
if ctx.will_run('fonts'):
dest_need += FONTS_NEED
if ctx.will_run('kit') and layouts.uses_kit(ctx.layout):
dest_need += KIT_NEED
if ctx.will_run('prepare') or ctx.will_run('extract'):
dest_need += DEST_EXTRA
if ctx.will_run('lift') or ctx.will_run('compile'):
@@ -634,6 +656,114 @@ class Check(Step):
ctx.state['version'] = found
# ---- 1b. build kit
class Kit(Step):
"""The build kit (installer/layout.py, Windows release): the release folder without TotK-Setup.exe, copied into
<install>/build-kit. Every step after this one runs its tools from there (settle), and the game's rebuild for its
mods starts the setup window from there, so the setup folder can go once the install is done and the install
folder can move. A newer setup replaces the kit; the kit's own rebuild keeps it. The steps' keys fingerprint file
contents, not paths, so the kit, a copy of the setup's files, keeps every step the setup recorded."""
id = 'kit'
def key(self, ctx):
return fingerprint('kit-1', ctx.layout.release if layouts.uses_kit(ctx.layout) else 'none')
def current(self, ctx, record):
if not layouts.uses_kit(ctx.layout):
return True
kit = layouts.kit_folder(ctx.dest)
if not layouts.is_release(kit):
return False
found = layouts.release_layout(kit)
return found.release == ctx.layout.release and not found.missing(getattr(ctx, 'cpu', 'v3'))
def run(self, ctx):
layout, rep = ctx.layout, ctx.reporter
if not layouts.uses_kit(layout):
return {}
kit = layouts.kit_folder(ctx.dest)
if layout.root.resolve() == kit.resolve(): # the kit's own rebuild: it is in place
return {}
new, old = kit.with_name(layouts.KIT + '.new'), kit.with_name(layouts.KIT + '.old')
try:
remove(new) # what a cancelled or failed run left
remove(old)
except OSError as e:
raise InstallError('kit.in_use', path=str(e.filename or old)) from None
files = []
for name in layouts.KIT_ITEMS:
src = layout.root / name
if src.is_dir():
files += [f for f in sorted(src.rglob('*')) if f.is_file() and '__pycache__' not in f.parts]
elif src.is_file():
files.append(src)
total, done = size_of(files), 0
rep.progress('kit', 'copy', 0, total, 'bytes', force=True)
try:
for f in files:
dst = new / f.relative_to(layout.root)
dst.parent.mkdir(parents=True, exist_ok=True)
shutil.copy2(f, dst)
done += f.stat().st_size
rep.progress('kit', 'copy', done, total, 'bytes')
except OSError as e:
raise InstallError('kit.copy_failed', path=str(e.filename or new), detail=str(e)) from None
# An open rebuild window, or a layout generator the game's settings menu started, holds files of the old kit:
# then nothing is replaced, and the message asks to close the game and run the setup again
moved = False
try:
if kit.exists():
os.replace(kit, old)
moved = True
os.replace(new, kit)
except OSError:
if moved and not kit.exists():
os.replace(old, kit) # the game keeps the kit it had
raise InstallError('kit.in_use', path=str(kit)) from None
try:
remove(old)
except OSError as e:
rep.log(f'kit: the old kit stays until the next run: {e}')
rep.log(f'kit: {len(files)} files, {total / GiB:.2f} GiB in {kit}')
return {'bytes': total}
def settle(self, ctx):
if not layouts.uses_kit(ctx.layout):
return
kit = layouts.kit_folder(ctx.dest).resolve()
if ctx.layout.root.resolve() != kit:
ctx.layout = layouts.release_layout(kit)
ctx.reporter.log(f'kit: the next steps run from {kit}')
def adopt_old_temp(layout, dest, temp):
"""An install by a setup before the build kit has its temp folder (generated C, lift cache, objects) in that
setup's folder: <setup>/temp/<install name>-<hash>, the setup build-cache/rebuild.txt names. The first run of a
setup with the build kit moves it into the install folder when both are on one disk, and the steps' keys decide
what of it still holds. On another disk the new temp folder starts empty: an update recompiles everything anyway
(the compiler's path is in every compile command), so a copy would save only part of the lift.
Runs before the run's log opens in temp; returns the line for the log, None when there was nothing to move."""
if not layouts.uses_kit(layout) or temp != dest / layouts.TEMP_IN_DEST or temp.exists():
return None
try:
lines = (dest / 'build-cache' / 'rebuild.txt').read_text(encoding='utf-8').splitlines()
except OSError:
return None
if len(lines) < 4 or lines[1] != '-c' or not os.path.isabs(lines[3]):
return None
old = layouts.temp_folder(Path(lines[3]) / 'temp', dest)
if not (old / 'gen').is_dir():
return None
try:
temp.parent.mkdir(parents=True, exist_ok=True)
os.replace(old, temp)
return f'temp: moved the temp folder of the setup in {lines[3]} to {temp}'
except OSError as e:
return f'temp: the temp folder {old} stays where it is ({e}); {temp} starts empty'
# ---- 2. fonts
class Fonts(Step):
@@ -851,6 +981,43 @@ def exefs_files(ctx):
return sorted(out)
def plugin_files(ctx):
"""The exlaunch plugins of the mods folder (each mod's exefs/subsdk*, in the first ExeFS place, as
tools/exefs_plugins.py finds them), by mod name, for the lift key and the plugin stage."""
mods = ctx.dest / 'mods'
if not mods.is_dir():
return []
out = []
for mod in sorted((m for m in mods.iterdir() if m.is_dir()), key=lambda m: m.name):
exefs = next((mod / w for w in EXEFS_PLACES if (mod / w).is_dir()), None)
if exefs:
out += sorted((f for f in exefs.iterdir() if f.is_file() and f.name.lower().startswith('subsdk')),
key=lambda f: f.name.lower())
return out
def plugins_status(ctx):
"""The build's plugin status file (tools/exefs_plugins.py --status), which runtime/mods.c reads."""
return ctx.dest / 'build-cache' / 'plugins.status'
def built_plugins(status, files, mods):
"""The files of the plugins the status file lists as built (kind `plugin`), in the order of files. The key is
FNV-1a 32 of "<mod folder>/<path in the mod>", as tools/exefs_plugins.py and runtime/mods.c compute it."""
if not status.is_file():
return []
built = {line.split('\t')[0] for line in status.read_text(encoding='utf-8').splitlines()
if len(line.split('\t')) >= 3 and line.split('\t')[2] == 'plugin'}
def key(f):
rel = f.relative_to(mods).as_posix()
h = 0x811C9DC5
for b in rel.encode():
h = ((h ^ b) * 0x01000193) & 0xFFFFFFFF
return f'{h:08X}'
return [f for f in files if key(f) in built]
def exefs_status(ctx):
"""The build's ExeFS patch status file (tools/exefs_patches.py --status), which runtime/mods.c reads."""
return ctx.dest / 'build-cache' / 'exefs.status'
@@ -875,9 +1042,13 @@ class Lift(Step):
def key(self, ctx):
# fingerprint takes a file's name and content only; the paths under mods/ go in too, because tools/cheats.py
# and tools/exefs_patches.py name each patch set after its mod folder, so a renamed folder needs a lift
files = cheat_files(ctx) + exefs_files(ctx)
# A mod plugin is built by running its init on a totk.exe of this build (tools/exefs_plugins.py), so the
# runtime is in the key too when there is one, and this file, which runs that stage: a plugin stage that failed
# (warn.plugins_skipped, the game built without the plugins) runs again once a release changes it.
files = cheat_files(ctx) + exefs_files(ctx) + plugin_files(ctx)
extra = [ctx.layout.tools / 'exefs_plugins.py', Path(__file__), runtime_key(ctx)] if plugin_files(ctx) else []
return fingerprint('lift-5', ctx.keys['extract'], ctx.layout.recomp, ctx.layout.patches(game_version(ctx)),
ctx.layout.tools / 'cheats.py', ctx.layout.tools / 'exefs_patches.py', *files,
ctx.layout.tools / 'cheats.py', ctx.layout.tools / 'exefs_patches.py', *extra, *files,
*(f.relative_to(ctx.dest / 'mods').as_posix() for f in files))
def current(self, ctx, record):
@@ -886,8 +1057,9 @@ class Lift(Step):
return (gen / 'layout.json').is_file() and stamp.is_file() and stamp.read_text().strip() == ctx.keys['lift']
def run(self, ctx):
# gen/ of the last run stays: gen.py rewrites only the chunks whose C changed (and removes the ones a smaller
# partition no longer has), so Ninja recompiles only those
# gen/ of the last run stays: gen.py lifts again only the chunks whose inputs changed
# (gen/<mod>/lift_cache.json; TOTK_LIFT_CACHE=0 lifts all), rewrites only those whose C changed (and removes
# the ones a smaller partition no longer has), so Ninja recompiles only those
layout, rep, gen = ctx.layout, ctx.reporter, ctx.temp / 'gen'
(gen / STAMP).unlink(missing_ok=True)
rep.progress('lift', 'discover', force=True)
@@ -927,12 +1099,50 @@ class Lift(Step):
else:
patches = ctx.temp / out
args = ['--exefs', ctx.dest / 'exefs', '--out', gen]
# The mods' exlaunch plugins (tools/exefs_plugins.py, after the design in #845 by itaskaev2): a lift with the
# plugins in the layout, a totk.exe of it in build/ (the compile step's folder, so it recompiles only what
# the hook sites change after), the plugin service run, and the plugins' patch sets for the lift below. A
# refused plugin gets its reason in plugins.status; a failed stage costs the plugins, not the install.
plugins = plugin_files(ctx)
drop([plugins_status(ctx), ctx.dest / 'build-cache' / 'plugins.stale'])
lift_plugins = []
if plugins:
listed = ['--plugins', ','.join(str(f) for f in plugins)]
code, log = run_tool(ctx, 'lift', layout.recomp / 'gen.py', args + ['--patches', patches] + listed, parse)
if not code:
code, log = run_tool(ctx, 'lift', layout.tools / 'build_game.py', build_args(ctx, gen))
if not code:
# the service run's totk.exe loads its DLLs from its own folder, as the installed one does
for dll in layout.dlls:
replace_file(dll, ctx.temp / 'build' / dll.name)
code, log = run_tool(ctx, 'lift', layout.tools / 'exefs_plugins.py', [
'--exe', ctx.temp / 'build' / ('totk' + EXE), '--out', ctx.temp / 'plugins', '--mods',
ctx.dest / 'mods', '--patches', patches, '--patches-out', ctx.temp / 'patches-plugins.txt',
'--status', plugins_status(ctx)])
# exit 1 with a status file: refused plugins, their reasons in it; the rest goes on
if plugins_status(ctx).is_file() and (ctx.temp / 'patches-plugins.txt').is_file():
code = 0
if code:
drop([plugins_status(ctx)])
skipped['warn.plugins_skipped'] = log
else:
patches = ctx.temp / 'patches-plugins.txt'
# With one plugin built, the layout keeps every plugin of the service runs: the records hold addresses
# of that layout. A refused plugin stays loaded at play, its init never runs (no patch set).
if built_plugins(plugins_status(ctx), plugins, ctx.dest / 'mods'):
lift_plugins = plugins
if lift_plugins:
args += ['--plugins', ','.join(str(f) for f in lift_plugins)]
code, log = run_tool(ctx, 'lift', layout.recomp / 'gen.py', args + ['--patches', patches], parse)
if code and patches != plain:
for tool, out, outputs, inputs, warn in stages:
if inputs and warn not in skipped:
drop(outputs)
skipped[warn] = log
if lift_plugins:
drop([plugins_status(ctx)])
skipped.setdefault('warn.plugins_skipped', log)
args = ['--exefs', ctx.dest / 'exefs', '--out', gen]
code, log = run_tool(ctx, 'lift', layout.recomp / 'gen.py', args + ['--patches', plain], parse)
if code:
raise InstallError('lift.failed', code=code, log=str(log))
@@ -960,17 +1170,40 @@ def runtime_key(ctx):
"""Fingerprint of what totk.exe is built from besides the lifted code: the runtime, the toolchain and the build
tools. Shader preparation depends on these, not on the code cheats a lift adds."""
layout, cpu = ctx.layout, getattr(ctx, 'cpu', 'v3')
clang = subprocess.run([str(layout.clang), '--version'], capture_output=True, text=True).stdout
# without the lines that name clang's folder: the build kit of a moved install folder is the same toolchain
clang = '\n'.join(line for line in subprocess.run([str(layout.clang), '--version'], capture_output=True,
text=True).stdout.splitlines()
if not line.startswith(('InstalledDir:', 'Configuration file:')))
tools = [layout.tools / n for n in ('build_game.py', 'romfs_index.py', 'check_content.py', 'check_isa.py')]
return fingerprint('runtime-1', cpu, layout.runtime_lib_for(cpu), layout.runtime, layout.deps or 'system',
layout.sysroot or 'host', *tools, clang, *[d.name for d in layout.dlls])
def build_args(ctx, gen):
"""tools/build_game.py's arguments for a totk.exe of the lifted C in gen, built in <temp>/build."""
layout, dest = ctx.layout, ctx.dest
cpu = getattr(ctx, 'cpu', 'v3')
lib = layout.runtime_lib_for(cpu)
pgo = layout.pgo(game_version(ctx))
return ['--gen', gen, '--out', ctx.temp / 'build', '--toolchain', layout.llvm, '--cpu', cpu,
*(['--deps', layout.deps] if layout.deps else []), *(['--sysroot', layout.sysroot] if layout.sysroot else []),
'--runtime', layout.runtime, *(['--runtime-lib', lib] if lib else ()), *(['--pgo', pgo] if pgo else ()),
'--ninja', layout.ninja,
'--version', version_tag(game_version(ctx)), '--expected', layout.expected(game_version(ctx)),
'--exefs', dest / 'exefs', '--romfs', dest / 'romfs',
'--profile', dest / 'profile',
# the build kit and the temp folder move with the install folder: Ninja's paths relative to the kit
*(['--portable'] if layouts.uses_kit(layout) else [])]
class Compile(Step):
id = 'compile'
def key(self, ctx):
return fingerprint('compile-3', ctx.keys['lift'], runtime_key(ctx),
# The release string too: build_game.py bakes the VERSION of the tools' folder into totk.exe (the menu's title
# line), and a release that leaves the lift and the runtime alone would otherwise keep the old exe and its
# old version.
return fingerprint('compile-4', ctx.keys['lift'], runtime_key(ctx), ctx.layout.release,
ctx.layout.pgo(game_version(ctx)) or 'no profile')
def current(self, ctx, record):
@@ -996,17 +1229,10 @@ class Compile(Step):
rep.progress('compile', 'compile', force=True)
cpu = getattr(ctx, 'cpu', 'v3')
lib = layout.runtime_lib_for(cpu)
pgo = layout.pgo(game_version(ctx))
code, log = run_tool(ctx, 'compile', layout.tools / 'build_game.py', [
'--gen', ctx.temp / 'gen', '--out', build, '--toolchain', layout.llvm, '--cpu', cpu,
*(['--deps', layout.deps] if layout.deps else []), *(['--sysroot', layout.sysroot] if layout.sysroot else []),
'--runtime', layout.runtime, *(['--runtime-lib', lib] if lib else ()), *(['--pgo', pgo] if pgo else ()),
'--ninja', layout.ninja,
'--version', version_tag(game_version(ctx)), '--expected', layout.expected(game_version(ctx)),
'--exefs', dest / 'exefs', '--romfs', dest / 'romfs',
'--profile', dest / 'profile'], parse)
code, log = run_tool(ctx, 'compile', layout.tools / 'build_game.py', build_args(ctx, ctx.temp / 'gen'), parse)
exe = build / ('totk' + EXE)
if code and link_output_locked(log):
raise InstallError('compile.exe_locked', path=str(exe), log=str(log))
if code or not exe.is_file():
raise InstallError('compile.failed', code=code, log=str(log))
try:
@@ -1027,12 +1253,7 @@ TRANSLATED = re.compile(r'gfx_shader: prepare: (\d+) of (\d+) pairs')
SKIPPED = re.compile(r'prepare-shaders: (\d+) variants skipped: the graphics driver crashed')
# The game resolutions of another shape than 16:9 that runtime/ui/menu.cpp row_output_res lists: 21:9 and 32:9 monitors,
# 16:10 screens (the Steam Deck's 1280x800, handhelds and laptops) and 3:2 screens (Surface and Framework laptops and
# tablets)
ASPECT_SIZES = ('2560x1080', '3440x1440', '3840x1600', '5120x2160', '3840x1080', '5120x1440',
'1280x800', '1680x1050', '1920x1200', '2560x1600',
'1920x1280', '2160x1440', '2256x1504', '2880x1920', '3000x2000')
ASPECT_SIZES = screens.ASPECT_SIZES
class Prepare(Step):
@@ -1082,24 +1303,15 @@ class Prepare(Step):
dest / 'romfs-patches'])
if code:
raise InstallError('prepare.romfs_patches_failed', code=code, log=str(log))
# The same overlay with the UI laid out for each game resolution of another shape the settings menu offers
# (runtime/romfs.c overlay_init picks the one that matches; the camera's side is the patch set aspect,
# recomp/patches-v<ver>.txt).
for size in ASPECT_SIZES:
remove(dest / f'romfs-patches-{size}')
code, log = run_tool(ctx, 'prepare', layout.tools / 'make_romfs_patches.py',
['--version', version_tag(game_version(ctx)), '--romfs', dest / 'romfs', '--out',
dest / f'romfs-patches-{size}', '--aspect', size])
if code:
raise InstallError('prepare.romfs_patches_failed', code=code, log=str(log))
# The same with Xbox button icons in the prompts, for prompts = xbox (make_romfs_patches.py --prompts):
# romfs-patches-xbox for the Nintendo pad layout, romfs-patches-xbox-label for xbox and auto (runtime/input_map.c
# input_prompts_folder). Both are written on every install, so the menu choices work without another run of
# The same with Xbox and PlayStation button icons in the prompts, for prompts = xbox and playstation
# (make_romfs_patches.py --prompts): romfs-patches-xbox for the Nintendo pad layout, romfs-patches-xbox-label
# for xbox and auto, and romfs-patches-playstation / -playstation-xbox likewise (runtime/input_map.c
# input_prompts_folder). All are written on every install, so the menu choices work without another run of
# the setup. Optional: when one fails, the game keeps the Switch prompts with that layout and the menu says the
# files are missing, so the setup warns once and goes on. romfs-patches-pc likewise, with keyboard and mouse
# prompts for prompts = pc (16:9 only: another shape takes make_romfs_patches.py --prompts pc --aspect).
# files are missing, so the setup warns once and goes on. The keyboard and mouse prompts are the PcPrompts
# step's: they follow totk.ini's bindings.
failed = None
for style in ('xbox', 'xbox-label', 'pc'):
for style in screens.PAD_PROMPTS:
out = dest / f'romfs-patches-{style}'
remove(out)
code, log = run_tool(ctx, f'prepare-{style}', layout.tools / 'make_romfs_patches.py',
@@ -1146,6 +1358,176 @@ class Prepare(Step):
return {'xlate_sha256': file_sha256(xlate)}
# ---- 6b. Keyboard and mouse prompts
def bind_lines(dest):
"""The bind_ lines of the install's totk.ini (the Controls tab writes them), '' without the file."""
try:
text = (dest / 'totk.ini').read_text(encoding='utf-8', errors='replace')
except OSError:
return ''
return '\n'.join(s for s in (line.split('#')[0].split(';')[0].strip() for line in text.splitlines())
if s.lower().startswith('bind_'))
def pc_binds(dest):
"""make_romfs_patches.py's --binds argument for the keyboard and mouse prompts: totk.ini when it has bind_ lines."""
return ['--binds', dest / 'totk.ini'] if bind_lines(dest) else []
class PcPrompts(Step):
"""romfs-patches-pc (16:9), for prompts = pc: the prompts drawn as the keys and mouse buttons of totk.ini's bind_
lines (make_romfs_patches.py --prompts pc --binds), the keyboard defaults without them. Its own step, keyed by those
lines, so running the setup again after a change of the bindings draws the prompts again and leaves the shaders
alone. The shaped romfs-patches-pc-<w>x<h> are the Shapes step's, which follows this key. Optional like the Xbox
prompts: a failure warns, and the game keeps the Switch prompts."""
id = 'pc_prompts'
def key(self, ctx):
layout = ctx.layout
tools = [layout.tools / n for n in ('make_romfs_patches.py', 'ultrawide_layout.py', 'button_icons.py')]
return fingerprint('pc-prompts-1', ctx.keys['extract'], *tools, bind_lines(ctx.dest))
def current(self, ctx, record):
return record.get('failed') or (ctx.dest / 'romfs-patches-pc' / 'manifest.tsv').is_file()
def run(self, ctx):
layout, rep, dest = ctx.layout, ctx.reporter, ctx.dest
rep.progress('pc_prompts', 'draw', force=True)
plain = dest / 'romfs-patches-pc'
remove(plain)
code, log = run_tool(ctx, 'prepare-pc', layout.tools / 'make_romfs_patches.py',
['--version', version_tag(game_version(ctx)), '--romfs', dest / 'romfs', '--out', plain,
'--prompts', 'pc', *pc_binds(dest)])
if code:
remove(plain)
rep.warning('warn.xbox_prompts_failed', code=code, log=str(log))
return {'failed': True}
return {}
# ---- 6b. screen shapes
SHAPED_FOLDER = re.compile(r'^romfs-patches(?:-(?:%s))?-\d+x\d+(?:-hud(?:16|21)x9)?$'
% '|'.join(map(re.escape, screens.PROMPTS_STYLES)))
# make_romfs_patches.py writes <folder>.part-<pid> and renames it to <folder> when it is complete. A run that was
# stopped (the PC turned off under a generator the game started, runtime/romfs.c romfs_folders_prepare) leaves its
# folder behind: one whose files did not change for PART_STALE_S is such a leftover, a younger one may belong to a
# generator running now. SHAPED_FOLDER matches neither.
PART_FOLDER = re.compile(r'^romfs-patches[\w.-]*\.part-[\w-]+$')
PART_STALE_S = 3600
def stale_parts(dest, now=None):
"""The leftover .part folders of make_romfs_patches.py runs in dest."""
now = time.time() if now is None else now
found = []
for folder in dest.iterdir() if dest.is_dir() else ():
if not (folder.is_dir() and not folder.is_symlink() and PART_FOLDER.match(folder.name)):
continue
try:
newest = max([folder.stat().st_mtime] + [f.stat().st_mtime for f in folder.rglob('*')])
except OSError:
continue
if now - newest > PART_STALE_S:
found.append(folder)
return found
def hud_width(dest):
"""The selected HUD cap, with the same default as runtime/cfg.c."""
try:
text = (dest / 'totk.ini').read_text(encoding='utf-8-sig', errors='replace')
except OSError:
text = ''
value = (screens.ini_value(text, 'hud_width') or 'full').lower()
return value if value in ('16:9', '21:9') else 'full'
def shape_hud(size, hud):
"""The selected cap when at least 1% narrower than the shape, as make_romfs_patches.py requires."""
w, h = (int(v) for v in size.split('x'))
cap = {'16:9': 16 / 9, '21:9': 21 / 9}.get(hud)
return hud if cap and cap < w / h * 0.99 else None
class Shapes(Step):
"""romfs-patches-<w>x<h> (the UI laid out for a shape, make_romfs_patches.py --aspect) and, with Xbox, PlayStation or
PC prompts
in totk.ini, romfs-patches-<style>-<w>x<h> (that layout with those prompts), for the shapes this player needs:
those of the connected displays and of the totk.ini output_res, one folder per shape (installer/screens.py; the
game maps its resolution to the folder in runtime/romfs.c overlay_init). A setup before this step wrote all 15
sizes for every prompts style, 64 folders. The key holds the shapes, prompts style and selected HUD width, so a run after a
monitor or settings change (or its rebuild mode) writes only these again; the game also starts the generator for a
folder its settings need and the install lacks, at start and from its menu (runtime/romfs.c romfs_folders_prepare,
make_romfs_patches.py --background), whose unfinished .part folders the clean-up below leaves alone."""
id = 'shapes'
def wanted(self, ctx):
if not hasattr(ctx, 'shapes_wanted'):
ctx.shapes_wanted = screens.wanted(ctx.dest)
return ctx.shapes_wanted
def key(self, ctx):
sizes, style = self.wanted(ctx)
# The pc prompts' shaped folders are drawn from the same bindings as romfs-patches-pc, so they follow its key
prompts = ctx.keys.get('pc_prompts', '') if style == 'pc' else ''
# Without a capped folder to write (hud_width full, or no shape wider than the cap) the key stays the one a
# setup before hud_width wrote, so an existing install does not prepare its shaped folders again
hud = hud_width(ctx.dest)
if not any(shape_hud(size, hud) for size in sizes):
return fingerprint('shapes-2', ctx.keys.get('prepare', ''), prompts, style or 'nintendo', *sizes)
return fingerprint('shapes-3', ctx.keys.get('prepare', ''), prompts, style or 'nintendo', hud, *sizes)
def current(self, ctx, record):
return not record.get('failed') and all((ctx.dest / name / 'manifest.tsv').is_file()
for name in record.get('folders', []))
def run(self, ctx):
layout, rep, dest = ctx.layout, ctx.reporter, ctx.dest
sizes, style = self.wanted(ctx)
rep.log(f'shapes: displays {screens.displays()}, layouts for {sizes or "none"}, prompts {style or "nintendo"}')
for old in dest.iterdir() if dest.is_dir() else ():
if old.is_dir() and SHAPED_FOLDER.match(old.name):
remove(old)
version = version_tag(game_version(ctx))
plain = dest / f'romfs-patches-{style}' if style else None
folders, failed = [], None
hud = hud_width(dest)
for i, size in enumerate(sizes):
rep.progress('shapes', 'layouts', i, len(sizes), 'shapes', force=True)
cap = shape_hud(size, hud)
# Keep the full layout as a fallback, plus only the cap this player selected for this shape.
for variant in (None, cap) if cap else (None,):
suffix = '-hud' + variant.replace(':', 'x') if variant else ''
hud_args = ['--hud', variant] if variant else []
out = dest / f'romfs-patches-{size}{suffix}'
code, log = run_tool(ctx, 'shapes', layout.tools / 'make_romfs_patches.py',
['--version', version, '--romfs', dest / 'romfs', '--out', out, '--aspect', size,
*hud_args])
if code:
raise InstallError('prepare.romfs_patches_failed', code=code, log=str(log))
folders.append(out.name)
# Reuse the selected prompts' fonts/messages/table; PC layouts retain the player's bindings.
if not plain or not (plain / 'manifest.tsv').is_file():
continue
out = dest / f'romfs-patches-{style}-{size}{suffix}'
code, log = run_tool(ctx, f'shapes-{style}', layout.tools / 'make_romfs_patches.py',
['--version', version, '--romfs', dest / 'romfs', '--out', out, '--prompts', style,
'--aspect', size, *hud_args, '--reuse', plain,
*(pc_binds(dest) if style == 'pc' else ())])
if code:
remove(out)
failed = failed or (code, log)
else:
folders.append(out.name)
rep.progress('shapes', 'layouts', len(sizes), len(sizes), 'shapes', force=True)
if failed:
rep.warning('warn.xbox_prompts_failed', code=failed[0], log=str(failed[1]))
return {'folders': folders, 'sizes': sizes, 'style': style, 'hud': hud, 'failed': bool(failed)}
# ---- 7. NVIDIA DLSS
# NVIDIA's DLSS library, which NGX loads from the folder of totk.exe (runtime/vk_dlaa.c). The setup does not ship it:
@@ -1237,7 +1619,7 @@ class Cleanup(Step):
ctx.state['lang'] = ctx.lang
(dest / 'profile').mkdir(exist_ok=True)
rep.progress('cleanup', 'temp', force=True)
for stale in dest.glob('update-merge-*'):
for stale in [*dest.glob('update-merge-*'), *stale_parts(dest)]:
remove(stale)
for name in ('check', 'unpacked', 'shader_list.tsv', 'shared-fonts'): # gen/ and build/ stay for the next rebuild
remove(ctx.temp / name)
@@ -1246,22 +1628,36 @@ class Cleanup(Step):
return {}
# Puts the release folder (the argument after -c) on sys.path and runs installer.gui with the rest. `-m installer.gui`
# finds the package only through the release Python's ._pth: the Linux release's Python and the dev-mode embeddable one
# lack that entry, and totk.exe starts the command in the install folder.
REBUILD_BOOT = ('import runpy, sys; sys.path.insert(0, sys.argv.pop(1)); '
# Puts the release folder or the build kit (the argument after -c, made absolute: the kit's is relative to the install
# folder) on sys.path and runs installer.gui with the rest. `-m installer.gui` finds the package only through the
# release Python's ._pth: the Linux release's Python and the dev-mode embeddable one lack that entry, and totk.exe
# starts the command in the install folder.
REBUILD_BOOT = ('import os, runpy, sys; sys.path.insert(0, os.path.abspath(sys.argv.pop(1))); '
"runpy.run_module('installer.gui', run_name='__main__', alter_sys=True)")
def rebuild_command(ctx):
"""The command that starts the setup window in its rebuild mode on this install folder (installer/gui.py
--rebuild): pythonw beside the setup's Python on Windows, so no console opens. In a repository that is the Python
running this setup: the tools' embeddable Python there has no tkinter."""
running this setup: the tools' embeddable Python there has no tkinter.
In the Linux AppImage the release folder is the AppImage's mount (/tmp/.mount_*), which goes away when the setup
exits, so a path into it would fail to start later and the game would keep its old code. The command starts the
AppImage file itself instead ($APPIMAGE, set by the AppImage runtime); its AppRun passes the arguments to
installer.gui."""
layout = ctx.layout
appimage = os.environ.get('APPIMAGE', '')
if not layout.dev and appimage and Path(appimage).is_file():
return [str(Path(appimage).resolve()), '--rebuild', str(ctx.dest)]
python = Path(sys.executable) if layout.dev else layout.python
if os.name == 'nt' and python.with_name('pythonw.exe').is_file():
python = python.with_name('pythonw.exe')
return [str(python), '-c', REBUILD_BOOT, str(layout.root), '--root', str(layout.root), '--rebuild', str(ctx.dest)]
root, dest = str(layout.root), str(ctx.dest)
if layouts.uses_kit(layout) and layout.root.resolve() == layouts.kit_folder(ctx.dest).resolve():
# the build kit: paths relative to the install folder, which totk.exe resolves against its own folder and
# starts the command in, so a moved install folder keeps its rebuild
python = Path(layouts.KIT) / python.relative_to(layout.root)
root, dest = layouts.KIT, '.'
return [str(python), '-c', REBUILD_BOOT, root, '--root', root, '--rebuild', dest]
def write_rebuild_command(ctx):
@@ -1289,4 +1685,4 @@ def romfs_problem(romfs, expected):
def all_steps():
return [Check(), Fonts(), Extract(), Lift(), Compile(), Prepare(), Dlss(), Cleanup()]
return [Check(), Kit(), Fonts(), Extract(), Lift(), Compile(), Prepare(), PcPrompts(), Shapes(), Dlss(), Cleanup()]
+215
View File
@@ -0,0 +1,215 @@
{
"step.check": "Computer und Spieldateien prüfen",
"step.kit": "Build-Kit in den Spielordner kopieren",
"step.fonts": "Systemschriften extrahieren",
"step.extract": "Spiel entpacken",
"step.lift": "Spielcode nach C übersetzen",
"step.compile": "{game_exe} kompilieren",
"step.prepare": "Shader vorbereiten",
"step.pc_prompts": "Tastatur- und Maussymbole zeichnen",
"step.shapes": "Spielbildschirme für deine Monitore anordnen",
"step.dlss": "NVIDIA DLSS herunterladen",
"step.cleanup": "Aufräumen",
"phase.check.host": "Prozessor und Grafikkarte prüfen",
"phase.check.verify": "Bereits installierte Dateien prüfen",
"phase.check.verify_romfs": "Installierte Spieldaten prüfen",
"phase.check.inputs": "Spieldateien mit den Schlüsseln öffnen",
"phase.check.unpack_base": "Komprimiertes Basisspiel entpacken",
"phase.check.unpack_update": "Komprimiertes Update entpacken",
"phase.check.versions": "Spielversionen prüfen",
"phase.kit.copy": "Die Werkzeuge kopieren, mit denen sich das Spiel für Code-Mods neu baut",
"phase.fonts.extract": "Gemeinsame Schriften aus der Firmware extrahieren",
"phase.fonts.copy": "Gemeinsame Schriften in den Installationsordner kopieren",
"phase.extract.hash_base": "Prüfsumme des Hauptspiels berechnen",
"phase.extract.hash_update": "Prüfsumme des Updates berechnen",
"phase.extract.exefs": "Spielcode extrahieren",
"phase.extract.copy": "Spieldaten kopieren",
"phase.extract.merge": "Update auf die Spieldaten anwenden",
"phase.extract.diagnose": "Beschädigte Spieldatei suchen",
"phase.extract.index": "Spieldaten überprüfen",
"phase.lift.discover": "Funktionen suchen",
"phase.lift.emit": "C-Code schreiben",
"phase.compile.compile": "Kompilieren",
"phase.compile.link": "{game_exe} linken",
"phase.prepare.romfs_patches": "Spieldaten-Patches für 60 fps schreiben",
"phase.pc_prompts.draw": "Tastatur- und Maustastensymbole nach den Belegungen in totk.ini zeichnen",
"phase.prepare.seed": "Shader aus den Spieldaten lesen",
"phase.prepare.translate": "Shader übersetzen",
"phase.prepare.libraries": "Shader für den Grafiktreiber erstellen",
"phase.prepare.pack": "Shader-Cache in eine Datei packen",
"phase.shapes.layouts": "Bildschirmlayouts und Tastensymbole für jedes Bildschirmformat schreiben",
"phase.dlss.download": "nvngx_dlss.dll aus NVIDIAs DLSS SDK herunterladen",
"phase.cleanup.ini": "totk.ini schreiben",
"phase.cleanup.temp": "Temporäre Dateien entfernen",
"cli.usage": "Ungültige Befehlszeile: {detail}",
"internal": "Unerwarteter Fehler ({exception}): {detail}",
"state.unreadable": "{path} kann nicht gelesen werden. Wähle einen anderen Ordner oder lösche diese Datei.",
"state.newer_format": "{path} wurde von einem neueren Installationsprogramm geschrieben. Verwende dieses oder einen anderen Ordner.",
"state.output_changed": "Installierte Dateien des Schritts „{step}“ haben sich seit ihrer Erstellung geändert; dieser Schritt läuft erneut.",
"check.release_incomplete": "Der Ordner des Installationsprogramms ist unvollständig; es fehlt: {paths}. Entpacke das Release erneut.",
"check.dest_not_folder": "Der Installationsort {path} ist eine Datei, kein Ordner.",
"check.dest_not_empty": "Der Installationsordner {path} ist nicht leer und enthält keine frühere Installation. Wähle einen leeren Ordner.",
"check.lang_missing": "Wähle die Spielsprache.",
"check.lang_unknown": "Unbekannte Sprache „{lang}“. Bekannt: {known}.",
"check.toolchain_broken": "Der mitgelieferte Compiler funktioniert nicht: {detail}",
"check.glibc_old": "Die C-Bibliothek dieses Systems ist glibc {version}; der Compiler des Setups braucht {need} oder neuer (Ubuntu 22.04, Debian 12, Fedora 35, SteamOS 3 und neuer haben sie). Ein Systemupdate behebt das.",
"check.host_probe_failed": "Die Computerprüfung ist nicht gelaufen (Exit-Code {code}).",
"check.cpu_too_old": "Diesem Prozessor fehlt x86-64-v2 (SSE4.2, POPCNT und CMPXCHG16B), die älteste Stufe, für die das Spiel gebaut wird. Intel Nehalem (2008) oder AMD Bulldozer (2011) und neuer haben sie.",
"check.vulkan_missing": "Es ist kein Vulkan-Treiber installiert. Installiere den neuesten Treiber für deine Grafikkarte.",
"check.vulkan_no_device": "Vulkan findet keine Grafikkarte. Installiere den neuesten Treiber für deine Grafikkarte.",
"check.vulkan_too_old": "Das Spiel braucht eine Grafikkarte mit Vulkan 1.3; gefunden: {devices}. Aktualisiere den Grafiktreiber.",
"check.no_display": "Zum Vorbereiten der Shader wird ein Bildschirm gebraucht. Starte das Setup aus der Desktop-Sitzung oder setze DISPLAY=:0 (auf einem Steam Deck im Spielmodus zusätzlich XDG_RUNTIME_DIR=/run/user/1000).",
"check.inputs_needed": "Die Spieldateien werden gebraucht: wähle das Hauptspiel, das Update 1.1.0, 1.2.1 oder 1.4.3 und prod.keys.",
"check.input_missing": "Datei nicht gefunden ({input}): {path}",
"check.keys_unreadable": "Die Schlüsseldatei kann nicht gelesen werden. Wähle eine prod.keys-Datei.",
"check.keys_no_header_key": "Die Schlüsseldatei enthält keinen header_key. Lies prod.keys erneut von deiner Konsole aus.",
"check.keys_wrong": "Die Schlüssel können die Datei ({input}) nicht öffnen. Verwende die prod.keys deiner Konsole.",
"check.keys_too_old": "Die Schlüsseldatei ist zu alt für die Datei ({input}) (braucht Schlüsselgeneration {generation}). Lies prod.keys von einer Konsole mit neuerer Firmware aus.",
"check.not_game_file": "Die Datei ({input}) ist keine XCI-, NSP-, XCZ- oder NSZ-Spieldatei.",
"check.file_unreadable": "Die Datei ({input}) kann nicht gelesen werden: {detail}",
"check.unpack_failed": "Die komprimierte Datei {input} konnte nicht entpackt werden: {detail}",
"check.ticket_personalized": "Die Datei ({input}) enthält ein personalisiertes Ticket; ein allgemeines Ticket wird gebraucht.",
"check.ticket_missing": "Der Datei ({input}) fehlt das Ticket, das ihr Inhalt braucht.",
"check.base_not_totk": "Die Hauptspieldatei ist nicht The Legend of Zelda: Tears of the Kingdom ({detail}).",
"check.base_is_update": "Die Hauptspieldatei ist ein Update. Wähle hier das Hauptspiel als NSP oder XCI (Version 1.0.0) und diese Datei als Update.",
"check.base_combined": "Die Hauptspieldatei enthält mehrere Pakete (Hauptspiel, Update oder DLC in einer Datei). Wähle einen Dump des Hauptspiels, der nur das Spiel enthält.",
"check.update_not_nsp": "Das Update muss eine NSP- oder NSZ-Datei sein.",
"check.update_is_base": "Die Update-Datei enthält ein Hauptspiel. Wähle die NSP des Updates 1.1.0, 1.2.1 oder 1.4.3.",
"check.update_not_totk": "Die Update-Datei ist kein Update von Tears of the Kingdom ({detail}).",
"check.exefs_failed": "Der Spielcode der Datei ({input}) hat die Prüfungen nicht bestanden; siehe {log}.",
"check.input_damaged": "Die Datei ({input}) ist beschädigt oder unvollständig: {path} ({detail}). Kopiere diese Datei erneut von ihrer Quelle oder erstelle den Dump neu und starte das Setup dann erneut.",
"check.base_wrong_version": "Das Hauptspiel ist nicht Version 1.0.0 ({modules} weichen ab).",
"check.update_wrong_version": "Das Update hat Version {found}; dieses Release verwendet {wanted}.",
"check.disk_space": "Nicht genug freier Speicher für {path}: {need_gb} GB nötig, {free_gb} GB frei.",
"check.firmware_missing": "Der Firmware-Ordner {path} existiert nicht. Wähle den Ordner Contents/registered der Firmware.",
"check.firmware_empty": "Der Firmware-Ordner {path} enthält keine NCA-Dateien. Wähle den Ordner Contents/registered der Firmware.",
"check.fonts_keys_needed": "Die gemeinsamen Schriften für diese Sprache sind noch nicht installiert; wähle prod.keys, damit das Setup sie aus der Firmware extrahieren kann.",
"extract.exefs_mismatch": "Der extrahierte Spielcode passt nicht zu Version {version} ({modules}).",
"extract.romfs_merge_failed": "Das Anwenden des Updates auf die Spieldaten ist fehlgeschlagen: {detail}. Details: {log}",
"extract.romfs_mismatch": "Die extrahierten Spieldaten passen nicht zu Version {version} (Größe {size}, Prüfsumme {sha256}...).",
"fonts.failed": "Das Extrahieren der gemeinsamen Schriften ist fehlgeschlagen (Exit-Code {code}): {detail}. Details: {log}",
"fonts.incomplete": "Beim Extrahieren der gemeinsamen Schriften wurden nicht alle Dateien geschrieben ({files}).",
"fonts.copy_failed": "Die gemeinsamen Schriften können nicht nach {path} kopiert werden: {detail}",
"lift.failed": "Das Übersetzen des Spielcodes ist fehlgeschlagen (Exit-Code {code}). Details: {log}",
"compile.failed": "Das Kompilieren von {game_exe} ist fehlgeschlagen (Exit-Code {code}). Details: {log}",
"compile.exe_in_use": "{path} wird verwendet. Schließe das Spiel und starte das Installationsprogramm erneut.",
"kit.in_use": "{path} wird gerade verwendet. Schließe das Spiel und jedes offene Setup- oder Neubau-Fenster und starte das Setup dann erneut.",
"kit.copy_failed": "Das Build-Kit kann nicht nach {path} kopiert werden: {detail}",
"compile.exe_locked": "{path} kann nicht geschrieben werden: Ein anderes Programm hält die Datei, etwa ein aus diesem Ordner gestartetes Spiel oder ein Virenscanner, der die Datei gemeldet hat. Schließe das Spiel, nimm den Ordner des Setups und den Installationsordner in die Ausnahmen des Virenscanners auf, starte Windows neu und starte das Setup dann erneut. Details: {log}",
"prepare.xlate_in_use": "{path} wird verwendet. Schließe das Spiel, beende jeden von einem früheren Lauf übrigen totk_xlate-Prozess und starte das Installationsprogramm erneut.",
"prepare.shader_list_missing": "Die Shader-Liste fehlt.",
"prepare.romfs_patches_failed": "Das Schreiben der Spieldaten-Patches ist fehlgeschlagen (Exit-Code {code}). Details: {log}",
"prepare.shaders_failed": "Das Vorbereiten der Shader ist fehlgeschlagen (Exit-Code {code}). Details: {log}",
"cleanup.romfs_unreadable": "Die Spieldaten in {path} fehlen nach der Installation oder können nicht gelesen werden. Starte Windows neu und führe das Installationsprogramm erneut auf demselben Ordner aus: Es entpackt die Spieldaten erneut und behält den Rest.",
"prepare.pack_failed": "Das Packen des Shader-Caches ist fehlgeschlagen (Exit-Code {code}). Details: {log}",
"cleanup.ini_failed": "totk.ini kann nicht geschrieben werden: {detail}",
"warn.lang_needs_fonts": "Text auf {lang} braucht die Systemschriften der Switch, und es wurden keine angegeben. Das Spiel startet in dieser Sprache erst, wenn sie hinzugefügt sind. Wähle den Firmware-Ordner (Contents/registered) oder lies „Switch system fonts“ in docs/installer.md.",
"warn.npdm_differs": "main.npdm weicht vom Referenz-Dump {version} ab; nur die Codemodule werden verwendet.",
"warn.cheats_skipped": "Die Cheats des Mods-Ordners, die den Spielcode ändern, konnten nicht gebaut werden; das Spiel wird ohne sie installiert. Details: {log}",
"warn.exefs_skipped": "Die ExeFS-Patches der Mods (.ips, .pchtxt) konnten nicht gebaut werden; das Spiel wird ohne sie installiert. Details: {log}",
"warn.plugins_skipped": "Die Code-Plugins der Mods (exefs subsdk) konnten nicht gebaut werden; das Spiel wird ohne sie installiert. Details: {log}",
"warn.xbox_prompts_failed": "Die Xbox-, PlayStation- oder PC-Tastensymbole konnten nicht vorbereitet werden (Exit-Code {code}); das Spiel behält die Switch-Symbole. Details: {log}",
"warn.shaders_skipped": "Der Grafiktreiber ist beim Erstellen einiger Shader abgestürzt, daher wurden {count} bei der Vorbereitung ausgelassen. Das Spiel erstellt sie, wenn es sie zum ersten Mal braucht, und der Treiber kann dort ebenfalls abstürzen; ein Treiberupdate kann das beheben. Details: {log}",
"warn.kernel_old": "Linux {version} fehlt das Schreib-Tracking, auf das das Spiel angewiesen ist (6.7 oder neuer); das Spiel kann sehr langsam laufen. Ein Systemupdate behebt das.",
"warn.dlss_kept": "Im Installationsordner liegt bereits eine DLSS-Bibliothek ({path}); das Setup behält sie.",
"warn.dlss_download_failed": "NVIDIA DLSS konnte nicht von {url} heruntergeladen werden: {detail}. Das Spiel läuft ohne; der nächste Setup-Lauf versucht es erneut.",
"ui.title": "TotK-Setup",
"ui.rebuild_title": "Spiel für deine Mods neu bauen",
"ui.start_game": "Spiel starten",
"ui.version": "Version {version}",
"ui.intro": "Erstellt aus deinen eigenen Spieldateien einen spielbaren Ordner von Tears of the Kingdom. Das dauert eine Weile und läuft einmal.",
"ui.notice": "Der Ordner, den dieses Setup erstellt, enthält das Spiel. Er ist nur für deinen eigenen Gebrauch; teile ihn nicht und lade ihn nicht hoch.",
"ui.keys_private": "Die Schlüsseldatei wird an Ort und Stelle gelesen. Ihr Inhalt wird nie angezeigt, kopiert oder gespeichert.",
"ui.base": "Hauptspiel",
"ui.update": "Update",
"ui.keys": "prod.keys",
"ui.firmware": "Firmware (optional)",
"ui.game_language": "Spielsprache",
"ui.dest": "Installationsordner",
"ui.browse": "Durchsuchen...",
"ui.pick_game": "Hauptspieldatei wählen",
"ui.pick_update": "Datei des Updates 1.1.0, 1.2.1 oder 1.4.3 wählen",
"ui.pick_keys": "prod.keys wählen",
"ui.pick_firmware": "Ordner der Switch-Firmware wählen (Contents/registered)",
"ui.pick_dest": "Installationsordner wählen",
"ui.firmware_help": "Für chinesischen, koreanischen und traditionell chinesischen Text: der Ordner Contents/registered der Firmware, zum Beispiel aus Ryujinx oder Yuzu. Das Setup kopiert daraus die Systemschriften der Switch in den Installationsordner.",
"ui.dlss": "NVIDIA DLSS (nvngx_dlss.dll) für NVIDIA-RTX-Grafikkarten herunterladen",
"ui.dlss_help": "Aus NVIDIAs DLSS SDK auf GitHub, unter NVIDIAs RTX-SDK-Lizenz (github.com/NVIDIA/DLSS). Damit funktionieren die Einstellungen dlaa und DLSS; ohne die Datei bewirken sie nichts.",
"ui.compressed_help": "Komprimierte NSZ- und XCZ-Dateien funktionieren direkt: Das Setup entpackt sie selbst (bis die Spieldaten extrahiert sind, braucht das so viel freien Speicher, wie die entpackten Dateien belegen).",
"ui.section_files": "Spieldateien",
"ui.section_install": "Installation",
"ui.more_details": "▸ Weitere Details",
"ui.fewer_details": "▾ Details ausblenden",
"ui.formats_help": "Hauptspiel: NSP, XCI, NSZ oder XCZ. Update: 1.1.0, 1.2.1 oder 1.4.3, als NSP oder NSZ.",
"ui.type_game": "Spieldateien (NSP, XCI, NSZ, XCZ)",
"ui.type_keys": "Schlüsseldateien (*.keys)",
"ui.type_all": "Alle Dateien",
"ui.start": "Starten",
"ui.cancel": "Abbrechen",
"ui.cancelling": "Wird abgebrochen...",
"ui.show_log": "Protokoll zeigen",
"ui.hide_log": "Protokoll ausblenden",
"ui.close": "Schließen",
"ui.back": "Zurück",
"ui.open_folder": "Ordner öffnen",
"ui.update_mode": "Dieser Ordner enthält eine frühere Installation. Das Setup setzt sie fort oder aktualisiert sie; die Spieldateien werden nur verlangt, wenn sie erneut gebraucht werden.",
"ui.need_dest": "Wähle den Installationsordner.",
"ui.need_base": "Wähle die Hauptspieldatei.",
"ui.need_update": "Wähle die Datei des Updates 1.1.0, 1.2.1 oder 1.4.3.",
"ui.need_keys": "Wähle die Datei prod.keys.",
"ui.need_lang": "Wähle die Spielsprache.",
"ui.missing_base": "Die Hauptspieldatei existiert nicht.",
"ui.missing_update": "Die Update-Datei existiert nicht.",
"ui.missing_keys": "Die Schlüsseldatei existiert nicht.",
"ui.missing_firmware": "Der Firmware-Ordner existiert nicht.",
"ui.running_install": "Installation",
"ui.running_resume": "Früheres Setup wird fortgesetzt",
"ui.running_update": "Installation wird aktualisiert",
"ui.state_started": "gestartet",
"ui.state_done": "fertig",
"ui.state_skipped": "übersprungen",
"ui.state_pending": "wartet",
"ui.state_running": "läuft",
"ui.state_failed": "fehlgeschlagen",
"ui.log_warning": "Warnung",
"ui.log_error": "Fehler",
"ui.log_space": "Benötigter Speicher: {need} GB, frei: {free} GB",
"ui.log_end": "Beendet",
"ui.result_ok": "Das Spiel ist bereit",
"ui.result_failed": "Das Setup ist fehlgeschlagen",
"ui.result_cancelled": "Das Setup wurde abgebrochen",
"ui.done_text": "Starte {game_exe} aus {dest}. Das Setup-Programm und die gewählten Spieldateien werden nicht mehr gebraucht.",
"ui.cancelled_text": "Die fertigen Schritte bleiben erhalten. Starte das Setup erneut mit demselben Ordner, um fortzufahren.",
"ui.log_file": "Protokolldatei: {path}",
"ui.process_died": "Das Setup wurde unerwartet beendet (Exit-Code {code}).",
"ui.confirm_cancel": "Das Setup läuft. Abbrechen und das Fenster schließen?",
"ui.space_one": "Benötigter freier Speicher auf {path}: {need} GB (frei: {free} GB).",
"ui.space_two": "Benötigter freier Speicher auf {path}: {need} GB (frei: {free} GB); auf {temp}: {temp_need} GB (frei: {temp_free} GB).",
"ui.amount_bytes": "{done} / {total} GB",
"ui.amount_chunks": "{done} / {total} Teile",
"ui.amount_objects": "{done} / {total} Dateien",
"ui.amount_shaders": "{done} / {total} Shader",
"ui.amount_other": "{done} / {total} {unit}",
"ui.seconds": "{n} s",
"param.input.base": "Hauptspiel",
"param.input.update": "Update",
"param.input.keys": "Schlüssel",
"launcher.title": "TotK-Setup",
"launcher.python_missing": "Die Setup-Dateien sind unvollständig: Der Ordner python neben TotK-Setup.exe fehlt. Entpacke das ganze Archiv erneut und starte TotK-Setup.exe aus dem entpackten Ordner.",
"lang.ja": "Japanisch",
"lang.en-US": "Englisch (USA)",
"lang.en-GB": "Englisch (UK)",
"lang.fr": "Französisch",
"lang.fr-CA": "Französisch (Kanada)",
"lang.de": "Deutsch",
"lang.it": "Italienisch",
"lang.es": "Spanisch",
"lang.es-419": "Spanisch (Lateinamerika)",
"lang.nl": "Niederländisch",
"lang.pt": "Portugiesisch",
"lang.pt-BR": "Portugiesisch (Brasilien)",
"lang.ru": "Russisch",
"lang.ko": "Koreanisch",
"lang.zh-Hans": "Chinesisch (vereinfacht)",
"lang.zh-Hant": "Chinesisch (traditionell)"
}
+19 -4
View File
@@ -1,10 +1,13 @@
{
"step.check": "Checking the computer and the game files",
"step.kit": "Copying the build kit into the game folder",
"step.fonts": "Extracting the system fonts",
"step.extract": "Extracting the game",
"step.lift": "Translating the game code to C",
"step.compile": "Compiling {game_exe}",
"step.prepare": "Preparing the shaders",
"step.pc_prompts": "Drawing the keyboard and mouse prompts",
"step.shapes": "Laying out the game screens for your displays",
"step.dlss": "Downloading NVIDIA DLSS",
"step.cleanup": "Cleaning up",
@@ -15,6 +18,7 @@
"phase.check.unpack_base": "Unpacking the compressed base game",
"phase.check.unpack_update": "Unpacking the compressed update",
"phase.check.versions": "Checking the game versions",
"phase.kit.copy": "Copying the tools the game rebuilds itself with for code mods",
"phase.fonts.extract": "Extracting the shared fonts from the firmware",
"phase.fonts.copy": "Copying the shared fonts into the install folder",
"phase.extract.hash_base": "Computing the checksum of the base game",
@@ -29,10 +33,12 @@
"phase.compile.compile": "Compiling",
"phase.compile.link": "Linking {game_exe}",
"phase.prepare.romfs_patches": "Writing the 60 fps game data patches",
"phase.pc_prompts.draw": "Drawing the keyboard and mouse button prompts from totk.ini's bindings",
"phase.prepare.seed": "Reading the shaders from the game data",
"phase.prepare.translate": "Translating the shaders",
"phase.prepare.libraries": "Building the shaders for the graphics driver",
"phase.prepare.pack": "Packing the shader cache into one file",
"phase.shapes.layouts": "Writing the screen layouts and button prompts for each display shape",
"phase.dlss.download": "Downloading nvngx_dlss.dll from NVIDIA's DLSS SDK",
"phase.cleanup.ini": "Writing totk.ini",
"phase.cleanup.temp": "Removing temporary files",
@@ -91,6 +97,9 @@
"lift.failed": "Translating the game code failed (exit code {code}). Details: {log}",
"compile.failed": "Compiling {game_exe} failed (exit code {code}). Details: {log}",
"compile.exe_in_use": "{path} is in use. Close the game and run the installer again.",
"kit.in_use": "{path} is in use. Close the game and any open setup or rebuild window, then run the installer again.",
"kit.copy_failed": "The build kit cannot be copied to {path}: {detail}",
"compile.exe_locked": "{path} cannot be written: another program holds it, a game started from that folder or an antivirus that flagged the file. Close the game, add the setup's folder and the install folder to the antivirus exclusions, restart Windows, then run the installer again. Details: {log}",
"prepare.xlate_in_use": "{path} is in use. Close the game, end any totk_xlate process left from an earlier run, then run the installer again.",
"prepare.shader_list_missing": "The shader list is missing.",
"prepare.romfs_patches_failed": "Writing the game data patches failed (exit code {code}). Details: {log}",
@@ -103,7 +112,8 @@
"warn.npdm_differs": "main.npdm differs from the reference {version} dump; only the code modules are used.",
"warn.cheats_skipped": "The cheats of the mods folder that change the game's code could not be built; the game installs without them. Details: {log}",
"warn.exefs_skipped": "The mods' ExeFS patches (.ips, .pchtxt) could not be built; the game installs without them. Details: {log}",
"warn.xbox_prompts_failed": "The Xbox or PC button prompts could not be prepared (exit code {code}); the game keeps the Switch prompts. Details: {log}",
"warn.plugins_skipped": "The mods' code plugins (exefs subsdk) could not be built; the game installs without them. Details: {log}",
"warn.xbox_prompts_failed": "The Xbox, PlayStation or PC button prompts could not be prepared (exit code {code}); the game keeps the Switch prompts. Details: {log}",
"warn.shaders_skipped": "The graphics driver crashed while building some shaders, so {count} were left out of the preparation. The game builds them when it first needs them, and the driver may crash there too; a driver update may fix it. Details: {log}",
"warn.kernel_old": "Linux {version} lacks the write tracking the game relies on (6.7 or later); the game may run very slowly. Updating the system fixes this.",
"warn.dlss_kept": "A DLSS library is already in the install folder ({path}); the setup keeps it.",
@@ -116,10 +126,10 @@
"ui.intro": "Builds a playable Tears of the Kingdom folder from your own game files. This takes a while and runs once.",
"ui.notice": "The folder this setup builds contains the game. It is for your own use only; do not share or upload it.",
"ui.keys_private": "The keys file is read in place. Its contents are never shown, copied or stored.",
"ui.base": "Base game (NSP, XCI, NSZ or XCZ)",
"ui.update": "Update 1.1.0 or 1.2.1 or 1.4.3 (NSP or NSZ)",
"ui.base": "Base game",
"ui.update": "Update",
"ui.keys": "prod.keys",
"ui.firmware": "Firmware folder (optional)",
"ui.firmware": "Firmware (optional)",
"ui.game_language": "Game language",
"ui.dest": "Install folder",
"ui.browse": "Browse...",
@@ -132,6 +142,11 @@
"ui.dlss": "Download NVIDIA DLSS (nvngx_dlss.dll) for NVIDIA RTX graphics cards",
"ui.dlss_help": "From NVIDIA's DLSS SDK on GitHub, under NVIDIA's RTX SDK license (github.com/NVIDIA/DLSS). It makes the dlaa and DLSS settings work; without it they do nothing.",
"ui.compressed_help": "Compressed NSZ and XCZ files work as they are: the setup unpacks them by itself (until the game data is extracted, that needs as much free space as the unpacked files take).",
"ui.section_files": "Game files",
"ui.section_install": "Install",
"ui.more_details": "▸ More details",
"ui.fewer_details": "▾ Hide details",
"ui.formats_help": "Base game: NSP, XCI, NSZ or XCZ. Update: 1.1.0, 1.2.1 or 1.4.3, as NSP or NSZ.",
"ui.type_game": "Game files (NSP, XCI, NSZ, XCZ)",
"ui.type_keys": "Key files (*.keys)",
"ui.type_all": "All files",
+215
View File
@@ -0,0 +1,215 @@
{
"step.check": "Comprobando el equipo y los archivos del juego",
"step.kit": "Copiando el kit de compilación en la carpeta del juego",
"step.fonts": "Extrayendo las fuentes del sistema",
"step.extract": "Extrayendo el juego",
"step.lift": "Traduciendo el código del juego a C",
"step.compile": "Compilando {game_exe}",
"step.prepare": "Preparando los shaders",
"step.pc_prompts": "Dibujando los iconos de teclado y ratón",
"step.shapes": "Ajustando las pantallas del juego a tus monitores",
"step.dlss": "Descargando NVIDIA DLSS",
"step.cleanup": "Limpiando",
"phase.check.host": "Comprobando el procesador y la tarjeta gráfica",
"phase.check.verify": "Comprobando los archivos ya instalados",
"phase.check.verify_romfs": "Comprobando los datos del juego instalados",
"phase.check.inputs": "Abriendo los archivos del juego con las claves",
"phase.check.unpack_base": "Descomprimiendo el juego base comprimido",
"phase.check.unpack_update": "Descomprimiendo la actualización comprimida",
"phase.check.versions": "Comprobando las versiones del juego",
"phase.kit.copy": "Copiando las herramientas con las que el juego se recompila para los mods de código",
"phase.fonts.extract": "Extrayendo las fuentes compartidas del firmware",
"phase.fonts.copy": "Copiando las fuentes compartidas a la carpeta de instalación",
"phase.extract.hash_base": "Calculando la suma de comprobación del juego base",
"phase.extract.hash_update": "Calculando la suma de comprobación de la actualización",
"phase.extract.exefs": "Extrayendo el código del juego",
"phase.extract.copy": "Copiando los datos del juego",
"phase.extract.merge": "Aplicando la actualización a los datos del juego",
"phase.extract.diagnose": "Buscando el archivo del juego dañado",
"phase.extract.index": "Verificando los datos del juego",
"phase.lift.discover": "Buscando las funciones",
"phase.lift.emit": "Escribiendo código C",
"phase.compile.compile": "Compilando",
"phase.compile.link": "Enlazando {game_exe}",
"phase.prepare.romfs_patches": "Escribiendo los parches de datos para 60 fps",
"phase.pc_prompts.draw": "Dibujando los iconos de teclas y botones del ratón según las asignaciones de totk.ini",
"phase.prepare.seed": "Leyendo los shaders de los datos del juego",
"phase.prepare.translate": "Traduciendo los shaders",
"phase.prepare.libraries": "Creando los shaders para el controlador gráfico",
"phase.prepare.pack": "Empaquetando la caché de shaders en un archivo",
"phase.shapes.layouts": "Escribiendo las disposiciones de pantalla y los iconos de botones para cada formato de pantalla",
"phase.dlss.download": "Descargando nvngx_dlss.dll del DLSS SDK de NVIDIA",
"phase.cleanup.ini": "Escribiendo totk.ini",
"phase.cleanup.temp": "Eliminando los archivos temporales",
"cli.usage": "Línea de comandos no válida: {detail}",
"internal": "Error inesperado ({exception}): {detail}",
"state.unreadable": "No se puede leer {path}. Elige otra carpeta o elimina ese archivo.",
"state.newer_format": "{path} lo escribió un instalador más reciente. Usa ese instalador u otra carpeta.",
"state.output_changed": "Los archivos instalados del paso '{step}' cambiaron desde que se crearon; ese paso se ejecuta de nuevo.",
"check.release_incomplete": "La carpeta del instalador está incompleta; falta: {paths}. Descomprime la versión de nuevo.",
"check.dest_not_folder": "La ubicación de instalación {path} es un archivo, no una carpeta.",
"check.dest_not_empty": "La carpeta de instalación {path} no está vacía y no contiene ninguna instalación anterior. Elige una carpeta vacía.",
"check.lang_missing": "Elige el idioma del juego.",
"check.lang_unknown": "Idioma desconocido '{lang}'. Conocidos: {known}.",
"check.toolchain_broken": "El compilador incluido no funciona: {detail}",
"check.glibc_old": "La biblioteca C de este sistema es glibc {version}; el compilador del instalador necesita {need} o posterior (Ubuntu 22.04, Debian 12, Fedora 35, SteamOS 3 y posteriores la tienen). Actualizar el sistema lo soluciona.",
"check.host_probe_failed": "La comprobación del equipo no se ejecutó (código de salida {code}).",
"check.cpu_too_old": "Este procesador no tiene x86-64-v2 (SSE4.2, POPCNT y CMPXCHG16B), el nivel más antiguo para el que se compila el juego. Intel Nehalem (2008) o AMD Bulldozer (2011) y posteriores lo tienen.",
"check.vulkan_missing": "No hay ningún controlador Vulkan instalado. Instala el controlador más reciente de tu tarjeta gráfica.",
"check.vulkan_no_device": "Vulkan no encuentra ninguna tarjeta gráfica. Instala el controlador más reciente de tu tarjeta gráfica.",
"check.vulkan_too_old": "El juego necesita una tarjeta gráfica con Vulkan 1.3; encontrado: {devices}. Actualiza el controlador gráfico.",
"check.no_display": "Preparar los shaders necesita una pantalla. Ejecuta el instalador desde la sesión de escritorio o exporta DISPLAY=:0 (en una Steam Deck en modo Juego, también XDG_RUNTIME_DIR=/run/user/1000).",
"check.inputs_needed": "Se necesitan los archivos del juego: elige el juego base, la actualización 1.1.0, 1.2.1 o 1.4.3 y prod.keys.",
"check.input_missing": "Archivo no encontrado ({input}): {path}",
"check.keys_unreadable": "No se puede leer el archivo de claves. Elige un archivo prod.keys.",
"check.keys_no_header_key": "El archivo de claves no tiene header_key. Vuelve a extraer prod.keys de tu consola.",
"check.keys_wrong": "Las claves no pueden abrir el archivo ({input}). Usa el prod.keys de tu consola.",
"check.keys_too_old": "El archivo de claves es demasiado antiguo para el archivo ({input}) (necesita la generación de claves {generation}). Extrae prod.keys de una consola con un firmware más reciente.",
"check.not_game_file": "El archivo ({input}) no es un archivo de juego XCI, NSP, XCZ o NSZ.",
"check.file_unreadable": "No se puede leer el archivo ({input}): {detail}",
"check.unpack_failed": "No se pudo descomprimir el archivo comprimido {input}: {detail}",
"check.ticket_personalized": "El archivo ({input}) lleva un ticket personalizado; se necesita un ticket común.",
"check.ticket_missing": "Al archivo ({input}) le falta el ticket que necesita su contenido.",
"check.base_not_totk": "El archivo del juego base no es The Legend of Zelda: Tears of the Kingdom ({detail}).",
"check.base_is_update": "El archivo del juego base es una actualización. Elige aquí el juego base en NSP o XCI (versión 1.0.0) y este archivo como actualización.",
"check.base_combined": "El archivo del juego base contiene varios paquetes (juego base, actualización o DLC en un solo archivo). Elige un volcado del juego base que contenga solo el juego.",
"check.update_not_nsp": "La actualización debe ser un archivo NSP o NSZ.",
"check.update_is_base": "El archivo de actualización contiene un juego base. Elige el NSP de la actualización 1.1.0, 1.2.1 o 1.4.3.",
"check.update_not_totk": "El archivo de actualización no es una actualización de Tears of the Kingdom ({detail}).",
"check.exefs_failed": "El código del juego del archivo ({input}) no superó las comprobaciones; consulta {log}.",
"check.input_damaged": "El archivo ({input}) está dañado o incompleto: {path} ({detail}). Vuelve a copiar ese archivo desde su origen o vuelve a volcarlo y ejecuta el instalador de nuevo.",
"check.base_wrong_version": "El juego base no es la versión 1.0.0 ({modules} difieren).",
"check.update_wrong_version": "La actualización es la versión {found}; esta versión usa {wanted}.",
"check.disk_space": "No hay suficiente espacio libre para {path}: se necesitan {need_gb} GB, hay {free_gb} GB libres.",
"check.firmware_missing": "La carpeta del firmware {path} no existe. Elige la carpeta Contents/registered del firmware.",
"check.firmware_empty": "La carpeta del firmware {path} no contiene archivos NCA. Elige la carpeta Contents/registered del firmware.",
"check.fonts_keys_needed": "Las fuentes compartidas de este idioma aún no están instaladas; elige prod.keys para que el instalador pueda extraerlas del firmware.",
"extract.exefs_mismatch": "El código del juego extraído no coincide con la versión {version} ({modules}).",
"extract.romfs_merge_failed": "Falló la aplicación de la actualización a los datos del juego: {detail}. Detalles: {log}",
"extract.romfs_mismatch": "Los datos del juego extraídos no coinciden con la versión {version} (tamaño {size}, suma de comprobación {sha256}...).",
"fonts.failed": "Falló la extracción de las fuentes compartidas (código de salida {code}): {detail}. Detalles: {log}",
"fonts.incomplete": "La extracción de las fuentes compartidas no escribió todos los archivos ({files}).",
"fonts.copy_failed": "No se pueden copiar las fuentes compartidas a {path}: {detail}",
"lift.failed": "Falló la traducción del código del juego (código de salida {code}). Detalles: {log}",
"compile.failed": "Falló la compilación de {game_exe} (código de salida {code}). Detalles: {log}",
"compile.exe_in_use": "{path} está en uso. Cierra el juego y vuelve a ejecutar el instalador.",
"kit.in_use": "{path} está en uso. Cierra el juego y cualquier ventana de instalación o recompilación abierta, y vuelve a ejecutar el instalador.",
"kit.copy_failed": "No se puede copiar el kit de compilación en {path}: {detail}",
"compile.exe_locked": "No se puede escribir {path}: otro programa lo retiene, un juego iniciado desde esa carpeta o un antivirus que marcó el archivo. Cierra el juego, añade la carpeta del instalador y la carpeta de instalación a las exclusiones del antivirus, reinicia Windows y vuelve a ejecutar el instalador. Detalles: {log}",
"prepare.xlate_in_use": "{path} está en uso. Cierra el juego, termina cualquier proceso totk_xlate que haya quedado de una ejecución anterior y vuelve a ejecutar el instalador.",
"prepare.shader_list_missing": "Falta la lista de shaders.",
"prepare.romfs_patches_failed": "Falló la escritura de los parches de datos del juego (código de salida {code}). Detalles: {log}",
"prepare.shaders_failed": "Falló la preparación de los shaders (código de salida {code}). Detalles: {log}",
"cleanup.romfs_unreadable": "Los datos del juego en {path} faltan o no se pueden leer tras la instalación. Reinicia Windows y vuelve a ejecutar el instalador en la misma carpeta: extrae de nuevo los datos del juego y conserva el resto.",
"prepare.pack_failed": "Falló el empaquetado de la caché de shaders (código de salida {code}). Detalles: {log}",
"cleanup.ini_failed": "No se puede escribir totk.ini: {detail}",
"warn.lang_needs_fonts": "El texto en {lang} necesita las fuentes del sistema de Switch y no se indicó ninguna. El juego no se iniciará en este idioma hasta que se añadan. Elige la carpeta del firmware (Contents/registered) o consulta «Switch system fonts» en docs/installer.md.",
"warn.npdm_differs": "main.npdm difiere del volcado de referencia {version}; solo se usan los módulos de código.",
"warn.cheats_skipped": "No se pudieron crear los trucos de la carpeta mods que cambian el código del juego; el juego se instala sin ellos. Detalles: {log}",
"warn.exefs_skipped": "No se pudieron crear los parches ExeFS de los mods (.ips, .pchtxt); el juego se instala sin ellos. Detalles: {log}",
"warn.plugins_skipped": "No se pudieron compilar los plugins de código de los mods (exefs subsdk); el juego se instala sin ellos. Detalles: {log}",
"warn.xbox_prompts_failed": "No se pudieron preparar los iconos de botones de Xbox, PlayStation o PC (código de salida {code}); el juego mantiene los iconos de Switch. Detalles: {log}",
"warn.shaders_skipped": "El controlador gráfico falló al crear algunos shaders, así que {count} quedaron fuera de la preparación. El juego los crea cuando los necesita por primera vez, y el controlador también puede fallar ahí; una actualización del controlador puede solucionarlo. Detalles: {log}",
"warn.kernel_old": "Linux {version} no tiene el seguimiento de escrituras del que depende el juego (6.7 o posterior); el juego puede ir muy lento. Actualizar el sistema lo soluciona.",
"warn.dlss_kept": "Ya hay una biblioteca DLSS en la carpeta de instalación ({path}); el instalador la conserva.",
"warn.dlss_download_failed": "No se pudo descargar NVIDIA DLSS desde {url}: {detail}. El juego funciona sin él; la próxima ejecución del instalador lo intentará de nuevo.",
"ui.title": "Instalador de TotK",
"ui.rebuild_title": "Reconstruyendo el juego para tus mods",
"ui.start_game": "Iniciar el juego",
"ui.version": "versión {version}",
"ui.intro": "Crea una carpeta jugable de Tears of the Kingdom a partir de tus propios archivos del juego. Tarda un rato y se ejecuta una sola vez.",
"ui.notice": "La carpeta que crea este instalador contiene el juego. Es solo para tu uso personal; no la compartas ni la subas.",
"ui.keys_private": "El archivo de claves se lee en su sitio. Su contenido nunca se muestra, copia ni guarda.",
"ui.base": "Juego base",
"ui.update": "Actualización",
"ui.keys": "prod.keys",
"ui.firmware": "Firmware (opcional)",
"ui.game_language": "Idioma del juego",
"ui.dest": "Carpeta de instalación",
"ui.browse": "Examinar...",
"ui.pick_game": "Elige el archivo del juego base",
"ui.pick_update": "Elige el archivo de la actualización 1.1.0, 1.2.1 o 1.4.3",
"ui.pick_keys": "Elige prod.keys",
"ui.pick_firmware": "Elige la carpeta del firmware de Switch (Contents/registered)",
"ui.pick_dest": "Elige la carpeta de instalación",
"ui.firmware_help": "Para texto en chino, coreano y chino tradicional: la carpeta Contents/registered del firmware, por ejemplo de Ryujinx o Yuzu. El instalador copia de ella las fuentes del sistema de Switch a la carpeta de instalación.",
"ui.dlss": "Descargar NVIDIA DLSS (nvngx_dlss.dll) para tarjetas gráficas NVIDIA RTX",
"ui.dlss_help": "Del DLSS SDK de NVIDIA en GitHub, bajo la licencia RTX SDK de NVIDIA (github.com/NVIDIA/DLSS). Hace que funcionen los ajustes dlaa y DLSS; sin él no hacen nada.",
"ui.compressed_help": "Los archivos comprimidos NSZ y XCZ funcionan tal cual: el instalador los descomprime por sí mismo (hasta que se extraen los datos del juego, necesita tanto espacio libre como ocupan los archivos descomprimidos).",
"ui.section_files": "Archivos del juego",
"ui.section_install": "Instalación",
"ui.more_details": "▸ Más detalles",
"ui.fewer_details": "▾ Ocultar detalles",
"ui.formats_help": "Juego base: NSP, XCI, NSZ o XCZ. Actualización: 1.1.0, 1.2.1 o 1.4.3, en NSP o NSZ.",
"ui.type_game": "Archivos de juego (NSP, XCI, NSZ, XCZ)",
"ui.type_keys": "Archivos de claves (*.keys)",
"ui.type_all": "Todos los archivos",
"ui.start": "Iniciar",
"ui.cancel": "Cancelar",
"ui.cancelling": "Cancelando...",
"ui.show_log": "Mostrar registro",
"ui.hide_log": "Ocultar registro",
"ui.close": "Cerrar",
"ui.back": "Atrás",
"ui.open_folder": "Abrir carpeta",
"ui.update_mode": "Esta carpeta contiene una instalación anterior. El instalador la continúa o la actualiza; los archivos del juego solo se piden si vuelven a ser necesarios.",
"ui.need_dest": "Elige la carpeta de instalación.",
"ui.need_base": "Elige el archivo del juego base.",
"ui.need_update": "Elige el archivo de la actualización 1.1.0, 1.2.1 o 1.4.3.",
"ui.need_keys": "Elige el archivo prod.keys.",
"ui.need_lang": "Elige el idioma del juego.",
"ui.missing_base": "El archivo del juego base no existe.",
"ui.missing_update": "El archivo de actualización no existe.",
"ui.missing_keys": "El archivo de claves no existe.",
"ui.missing_firmware": "La carpeta del firmware no existe.",
"ui.running_install": "Instalando",
"ui.running_resume": "Continuando la instalación anterior",
"ui.running_update": "Actualizando la instalación",
"ui.state_started": "iniciado",
"ui.state_done": "hecho",
"ui.state_skipped": "omitido",
"ui.state_pending": "en espera",
"ui.state_running": "en curso",
"ui.state_failed": "fallido",
"ui.log_warning": "Advertencia",
"ui.log_error": "Error",
"ui.log_space": "Espacio necesario: {need} GB, libre: {free} GB",
"ui.log_end": "Terminado",
"ui.result_ok": "El juego está listo",
"ui.result_failed": "La instalación falló",
"ui.result_cancelled": "La instalación se canceló",
"ui.done_text": "Inicia {game_exe} desde {dest}. El instalador y los archivos del juego que elegiste ya no son necesarios.",
"ui.cancelled_text": "Los pasos terminados se conservan. Vuelve a iniciar el instalador con la misma carpeta para continuar.",
"ui.log_file": "Archivo de registro: {path}",
"ui.process_died": "El instalador se detuvo inesperadamente (código de salida {code}).",
"ui.confirm_cancel": "El instalador está en marcha. ¿Cancelarlo y cerrar la ventana?",
"ui.space_one": "Espacio libre necesario en {path}: {need} GB (libre: {free} GB).",
"ui.space_two": "Espacio libre necesario en {path}: {need} GB (libre: {free} GB); en {temp}: {temp_need} GB (libre: {temp_free} GB).",
"ui.amount_bytes": "{done} / {total} GB",
"ui.amount_chunks": "{done} / {total} partes",
"ui.amount_objects": "{done} / {total} archivos",
"ui.amount_shaders": "{done} / {total} shaders",
"ui.amount_other": "{done} / {total} {unit}",
"ui.seconds": "{n} s",
"param.input.base": "juego base",
"param.input.update": "actualización",
"param.input.keys": "claves",
"launcher.title": "Instalador de TotK",
"launcher.python_missing": "Los archivos del instalador están incompletos: falta la carpeta python junto a TotK-Setup.exe. Descomprime de nuevo todo el archivo e inicia TotK-Setup.exe desde la carpeta descomprimida.",
"lang.ja": "Japonés",
"lang.en-US": "Inglés (EE. UU.)",
"lang.en-GB": "Inglés (Reino Unido)",
"lang.fr": "Francés",
"lang.fr-CA": "Francés (Canadá)",
"lang.de": "Alemán",
"lang.it": "Italiano",
"lang.es": "Español",
"lang.es-419": "Español (Latinoamérica)",
"lang.nl": "Neerlandés",
"lang.pt": "Portugués",
"lang.pt-BR": "Portugués (Brasil)",
"lang.ru": "Ruso",
"lang.ko": "Coreano",
"lang.zh-Hans": "Chino (simplificado)",
"lang.zh-Hant": "Chino (tradicional)"
}
+215
View File
@@ -0,0 +1,215 @@
{
"step.check": "Vérification de l'ordinateur et des fichiers du jeu",
"step.kit": "Copie du kit de compilation dans le dossier du jeu",
"step.fonts": "Extraction des polices système",
"step.extract": "Extraction du jeu",
"step.lift": "Traduction du code du jeu en C",
"step.compile": "Compilation de {game_exe}",
"step.prepare": "Préparation des shaders",
"step.pc_prompts": "Dessin des icônes du clavier et de la souris",
"step.shapes": "Mise en page des écrans du jeu pour vos moniteurs",
"step.dlss": "Téléchargement de NVIDIA DLSS",
"step.cleanup": "Nettoyage",
"phase.check.host": "Vérification du processeur et de la carte graphique",
"phase.check.verify": "Vérification des fichiers déjà installés",
"phase.check.verify_romfs": "Vérification des données du jeu installées",
"phase.check.inputs": "Ouverture des fichiers du jeu avec les clés",
"phase.check.unpack_base": "Décompression du jeu de base compressé",
"phase.check.unpack_update": "Décompression de la mise à jour compressée",
"phase.check.versions": "Vérification des versions du jeu",
"phase.kit.copy": "Copie des outils avec lesquels le jeu se recompile pour les mods de code",
"phase.fonts.extract": "Extraction des polices partagées depuis le firmware",
"phase.fonts.copy": "Copie des polices partagées dans le dossier d'installation",
"phase.extract.hash_base": "Calcul de la somme de contrôle du jeu de base",
"phase.extract.hash_update": "Calcul de la somme de contrôle de la mise à jour",
"phase.extract.exefs": "Extraction du code du jeu",
"phase.extract.copy": "Copie des données du jeu",
"phase.extract.merge": "Application de la mise à jour aux données du jeu",
"phase.extract.diagnose": "Recherche du fichier du jeu endommagé",
"phase.extract.index": "Vérification des données du jeu",
"phase.lift.discover": "Recherche des fonctions",
"phase.lift.emit": "Écriture du code C",
"phase.compile.compile": "Compilation",
"phase.compile.link": "Édition des liens de {game_exe}",
"phase.prepare.romfs_patches": "Écriture des correctifs de données pour 60 fps",
"phase.pc_prompts.draw": "Dessin des icônes des touches du clavier et de la souris d’après les affectations de totk.ini",
"phase.prepare.seed": "Lecture des shaders dans les données du jeu",
"phase.prepare.translate": "Traduction des shaders",
"phase.prepare.libraries": "Construction des shaders pour le pilote graphique",
"phase.prepare.pack": "Regroupement du cache de shaders en un fichier",
"phase.shapes.layouts": "Écriture des mises en page et des icônes de boutons pour chaque format d’écran",
"phase.dlss.download": "Téléchargement de nvngx_dlss.dll depuis le DLSS SDK de NVIDIA",
"phase.cleanup.ini": "Écriture de totk.ini",
"phase.cleanup.temp": "Suppression des fichiers temporaires",
"cli.usage": "Ligne de commande invalide : {detail}",
"internal": "Erreur inattendue ({exception}) : {detail}",
"state.unreadable": "{path} est illisible. Choisissez un autre dossier ou supprimez ce fichier.",
"state.newer_format": "{path} a été écrit par un installateur plus récent. Utilisez cet installateur ou un autre dossier.",
"state.output_changed": "Les fichiers installés de l'étape « {step} » ont changé depuis leur création ; cette étape est relancée.",
"check.release_incomplete": "Le dossier de l'installateur est incomplet ; il manque : {paths}. Décompressez à nouveau la version.",
"check.dest_not_folder": "L'emplacement d'installation {path} est un fichier, pas un dossier.",
"check.dest_not_empty": "Le dossier d'installation {path} n'est pas vide et ne contient aucune installation antérieure. Choisissez un dossier vide.",
"check.lang_missing": "Choisissez la langue du jeu.",
"check.lang_unknown": "Langue inconnue « {lang} ». Langues connues : {known}.",
"check.toolchain_broken": "Le compilateur fourni ne fonctionne pas : {detail}",
"check.glibc_old": "La bibliothèque C de ce système est glibc {version} ; le compilateur de l'installation demande {need} ou plus récent (Ubuntu 22.04, Debian 12, Fedora 35, SteamOS 3 et plus récents l'ont). Mettre à jour le système corrige cela.",
"check.host_probe_failed": "La vérification de l'ordinateur ne s'est pas exécutée (code de sortie {code}).",
"check.cpu_too_old": "Ce processeur ne prend pas en charge x86-64-v2 (SSE4.2, POPCNT et CMPXCHG16B), le niveau le plus ancien pour lequel le jeu est compilé. Intel Nehalem (2008) ou AMD Bulldozer (2011) et plus récents l'ont.",
"check.vulkan_missing": "Aucun pilote Vulkan n'est installé. Installez le dernier pilote de votre carte graphique.",
"check.vulkan_no_device": "Vulkan ne trouve aucune carte graphique. Installez le dernier pilote de votre carte graphique.",
"check.vulkan_too_old": "Le jeu demande une carte graphique avec Vulkan 1.3 ; trouvé : {devices}. Mettez à jour le pilote graphique.",
"check.no_display": "La préparation des shaders a besoin d'un écran. Lancez l'installation depuis la session de bureau, ou exportez DISPLAY=:0 (sur un Steam Deck en mode Jeu, aussi XDG_RUNTIME_DIR=/run/user/1000).",
"check.inputs_needed": "Les fichiers du jeu sont nécessaires : choisissez le jeu de base, la mise à jour 1.1.0, 1.2.1 ou 1.4.3 et prod.keys.",
"check.input_missing": "Fichier introuvable ({input}) : {path}",
"check.keys_unreadable": "Le fichier de clés est illisible. Choisissez un fichier prod.keys.",
"check.keys_no_header_key": "Le fichier de clés ne contient pas de header_key. Extrayez à nouveau prod.keys de votre console.",
"check.keys_wrong": "Les clés ne peuvent pas ouvrir le fichier ({input}). Utilisez le prod.keys de votre console.",
"check.keys_too_old": "Le fichier de clés est trop ancien pour le fichier ({input}) (génération de clés {generation} requise). Extrayez prod.keys d'une console avec un firmware plus récent.",
"check.not_game_file": "Le fichier ({input}) n'est pas un fichier de jeu XCI, NSP, XCZ ou NSZ.",
"check.file_unreadable": "Le fichier ({input}) est illisible : {detail}",
"check.unpack_failed": "Le fichier compressé {input} n'a pas pu être décompressé : {detail}",
"check.ticket_personalized": "Le fichier ({input}) contient un ticket personnalisé ; un ticket commun est nécessaire.",
"check.ticket_missing": "Il manque au fichier ({input}) le ticket dont son contenu a besoin.",
"check.base_not_totk": "Le fichier du jeu de base n'est pas The Legend of Zelda: Tears of the Kingdom ({detail}).",
"check.base_is_update": "Le fichier du jeu de base est une mise à jour. Choisissez ici le jeu de base en NSP ou XCI (version 1.0.0) et ce fichier comme mise à jour.",
"check.base_combined": "Le fichier du jeu de base contient plusieurs paquets (jeu de base, mise à jour ou DLC dans un seul fichier). Choisissez un dump du jeu de base qui ne contient que le jeu.",
"check.update_not_nsp": "La mise à jour doit être un fichier NSP ou NSZ.",
"check.update_is_base": "Le fichier de mise à jour contient un jeu de base. Choisissez le NSP de la mise à jour 1.1.0, 1.2.1 ou 1.4.3.",
"check.update_not_totk": "Le fichier de mise à jour n'est pas une mise à jour de Tears of the Kingdom ({detail}).",
"check.exefs_failed": "Le code du jeu du fichier ({input}) n'a pas passé les vérifications ; voir {log}.",
"check.input_damaged": "Le fichier ({input}) est endommagé ou incomplet : {path} ({detail}). Copiez à nouveau ce fichier depuis sa source ou refaites le dump, puis relancez l'installation.",
"check.base_wrong_version": "Le jeu de base n'est pas en version 1.0.0 ({modules} diffèrent).",
"check.update_wrong_version": "La mise à jour est en version {found} ; cette version prend {wanted}.",
"check.disk_space": "Espace libre insuffisant pour {path} : {need_gb} Go nécessaires, {free_gb} Go libres.",
"check.firmware_missing": "Le dossier du firmware {path} n'existe pas. Choisissez le dossier Contents/registered du firmware.",
"check.firmware_empty": "Le dossier du firmware {path} ne contient aucun fichier NCA. Choisissez le dossier Contents/registered du firmware.",
"check.fonts_keys_needed": "Les polices partagées de cette langue ne sont pas encore installées ; choisissez prod.keys pour que l'installation puisse les extraire du firmware.",
"extract.exefs_mismatch": "Le code du jeu extrait ne correspond pas à la version {version} ({modules}).",
"extract.romfs_merge_failed": "L'application de la mise à jour aux données du jeu a échoué : {detail}. Détails : {log}",
"extract.romfs_mismatch": "Les données du jeu extraites ne correspondent pas à la version {version} (taille {size}, somme de contrôle {sha256}...).",
"fonts.failed": "L'extraction des polices partagées a échoué (code de sortie {code}) : {detail}. Détails : {log}",
"fonts.incomplete": "L'extraction des polices partagées n'a pas écrit tous les fichiers ({files}).",
"fonts.copy_failed": "Les polices partagées ne peuvent pas être copiées dans {path} : {detail}",
"lift.failed": "La traduction du code du jeu a échoué (code de sortie {code}). Détails : {log}",
"compile.failed": "La compilation de {game_exe} a échoué (code de sortie {code}). Détails : {log}",
"compile.exe_in_use": "{path} est en cours d'utilisation. Fermez le jeu et relancez l'installateur.",
"kit.in_use": "{path} est en cours d’utilisation. Fermez le jeu et toute fenêtre d’installation ou de recompilation ouverte, puis relancez l’installation.",
"kit.copy_failed": "Impossible de copier le kit de compilation dans {path} : {detail}",
"compile.exe_locked": "Impossible d’écrire {path} : un autre programme le retient, un jeu lancé depuis ce dossier ou un antivirus qui a signalé le fichier. Fermez le jeu, ajoutez le dossier du programme d’installation et le dossier d’installation aux exclusions de l’antivirus, redémarrez Windows, puis relancez l’installation. Détails : {log}",
"prepare.xlate_in_use": "{path} est en cours d'utilisation. Fermez le jeu, terminez tout processus totk_xlate restant d'une exécution précédente, puis relancez l'installateur.",
"prepare.shader_list_missing": "La liste des shaders est manquante.",
"prepare.romfs_patches_failed": "L'écriture des correctifs de données du jeu a échoué (code de sortie {code}). Détails : {log}",
"prepare.shaders_failed": "La préparation des shaders a échoué (code de sortie {code}). Détails : {log}",
"cleanup.romfs_unreadable": "Les données du jeu dans {path} sont manquantes ou illisibles après l'installation. Redémarrez Windows, puis relancez l'installateur sur le même dossier : il extrait à nouveau les données du jeu et conserve le reste.",
"prepare.pack_failed": "Le regroupement du cache de shaders a échoué (code de sortie {code}). Détails : {log}",
"cleanup.ini_failed": "totk.ini ne peut pas être écrit : {detail}",
"warn.lang_needs_fonts": "Le texte en {lang} nécessite les polices système de la Switch, et aucune n'a été fournie. Le jeu ne démarrera pas dans cette langue tant qu'elles ne sont pas ajoutées. Choisissez le dossier du firmware (Contents/registered), ou consultez « Switch system fonts » dans docs/installer.md.",
"warn.npdm_differs": "main.npdm diffère du dump de référence {version} ; seuls les modules de code sont utilisés.",
"warn.cheats_skipped": "Les codes de triche du dossier mods qui modifient le code du jeu n'ont pas pu être construits ; le jeu s'installe sans eux. Détails : {log}",
"warn.exefs_skipped": "Les correctifs ExeFS des mods (.ips, .pchtxt) n'ont pas pu être construits ; le jeu s'installe sans eux. Détails : {log}",
"warn.plugins_skipped": "Les plugins de code des mods (exefs subsdk) n’ont pas pu être compilés ; le jeu s’installe sans eux. Détails : {log}",
"warn.xbox_prompts_failed": "Les icônes de boutons Xbox, PlayStation ou PC n'ont pas pu être préparées (code de sortie {code}) ; le jeu garde les icônes Switch. Détails : {log}",
"warn.shaders_skipped": "Le pilote graphique a planté pendant la construction de certains shaders ; {count} ont donc été exclus de la préparation. Le jeu les construit quand il en a besoin pour la première fois, et le pilote peut y planter aussi ; une mise à jour du pilote peut corriger cela. Détails : {log}",
"warn.kernel_old": "Linux {version} ne dispose pas du suivi des écritures dont le jeu dépend (6.7 ou plus récent) ; le jeu peut être très lent. Mettre à jour le système corrige cela.",
"warn.dlss_kept": "Une bibliothèque DLSS se trouve déjà dans le dossier d'installation ({path}) ; l'installation la conserve.",
"warn.dlss_download_failed": "NVIDIA DLSS n'a pas pu être téléchargé depuis {url} : {detail}. Le jeu fonctionne sans ; la prochaine installation réessaiera.",
"ui.title": "Installation de TotK",
"ui.rebuild_title": "Reconstruction du jeu pour vos mods",
"ui.start_game": "Lancer le jeu",
"ui.version": "version {version}",
"ui.intro": "Construit un dossier jouable de Tears of the Kingdom à partir de vos propres fichiers du jeu. Cela prend du temps et ne s'exécute qu'une fois.",
"ui.notice": "Le dossier construit par cette installation contient le jeu. Il est réservé à votre usage personnel ; ne le partagez pas et ne le mettez pas en ligne.",
"ui.keys_private": "Le fichier de clés est lu sur place. Son contenu n'est jamais affiché, copié ni conservé.",
"ui.base": "Jeu de base",
"ui.update": "Mise à jour",
"ui.keys": "prod.keys",
"ui.firmware": "Firmware (facultatif)",
"ui.game_language": "Langue du jeu",
"ui.dest": "Dossier d'installation",
"ui.browse": "Parcourir...",
"ui.pick_game": "Choisissez le fichier du jeu de base",
"ui.pick_update": "Choisissez le fichier de la mise à jour 1.1.0, 1.2.1 ou 1.4.3",
"ui.pick_keys": "Choisissez prod.keys",
"ui.pick_firmware": "Choisissez le dossier du firmware Switch (Contents/registered)",
"ui.pick_dest": "Choisissez le dossier d'installation",
"ui.firmware_help": "Pour le texte en chinois, en coréen et en chinois traditionnel : le dossier Contents/registered du firmware, par exemple celui de Ryujinx ou de Yuzu. L'installation en copie les polices système de la Switch dans le dossier d'installation.",
"ui.dlss": "Télécharger NVIDIA DLSS (nvngx_dlss.dll) pour les cartes graphiques NVIDIA RTX",
"ui.dlss_help": "Depuis le DLSS SDK de NVIDIA sur GitHub, sous la licence RTX SDK de NVIDIA (github.com/NVIDIA/DLSS). Il fait fonctionner les réglages dlaa et DLSS ; sans lui, ils n'ont aucun effet.",
"ui.compressed_help": "Les fichiers compressés NSZ et XCZ fonctionnent tels quels : l'installation les décompresse elle-même (jusqu'à l'extraction des données du jeu, il faut autant d'espace libre que les fichiers décompressés).",
"ui.section_files": "Fichiers du jeu",
"ui.section_install": "Installation",
"ui.more_details": "▸ Plus de détails",
"ui.fewer_details": "▾ Masquer les détails",
"ui.formats_help": "Jeu de base : NSP, XCI, NSZ ou XCZ. Mise à jour : 1.1.0, 1.2.1 ou 1.4.3, en NSP ou NSZ.",
"ui.type_game": "Fichiers de jeu (NSP, XCI, NSZ, XCZ)",
"ui.type_keys": "Fichiers de clés (*.keys)",
"ui.type_all": "Tous les fichiers",
"ui.start": "Démarrer",
"ui.cancel": "Annuler",
"ui.cancelling": "Annulation...",
"ui.show_log": "Afficher le journal",
"ui.hide_log": "Masquer le journal",
"ui.close": "Fermer",
"ui.back": "Retour",
"ui.open_folder": "Ouvrir le dossier",
"ui.update_mode": "Ce dossier contient une installation antérieure. L'installation la poursuit ou la met à jour ; les fichiers du jeu ne sont demandés que s'ils sont de nouveau nécessaires.",
"ui.need_dest": "Choisissez le dossier d'installation.",
"ui.need_base": "Choisissez le fichier du jeu de base.",
"ui.need_update": "Choisissez le fichier de la mise à jour 1.1.0, 1.2.1 ou 1.4.3.",
"ui.need_keys": "Choisissez le fichier prod.keys.",
"ui.need_lang": "Choisissez la langue du jeu.",
"ui.missing_base": "Le fichier du jeu de base n'existe pas.",
"ui.missing_update": "Le fichier de mise à jour n'existe pas.",
"ui.missing_keys": "Le fichier de clés n'existe pas.",
"ui.missing_firmware": "Le dossier du firmware n'existe pas.",
"ui.running_install": "Installation",
"ui.running_resume": "Reprise de l'installation précédente",
"ui.running_update": "Mise à jour de l'installation",
"ui.state_started": "démarré",
"ui.state_done": "terminé",
"ui.state_skipped": "ignoré",
"ui.state_pending": "en attente",
"ui.state_running": "en cours",
"ui.state_failed": "échec",
"ui.log_warning": "Avertissement",
"ui.log_error": "Erreur",
"ui.log_space": "Espace nécessaire : {need} Go, libre : {free} Go",
"ui.log_end": "Terminé",
"ui.result_ok": "Le jeu est prêt",
"ui.result_failed": "L'installation a échoué",
"ui.result_cancelled": "L'installation a été annulée",
"ui.done_text": "Lancez {game_exe} depuis {dest}. Le programme d'installation et les fichiers du jeu choisis ne sont plus nécessaires.",
"ui.cancelled_text": "Les étapes terminées sont conservées. Relancez l'installation avec le même dossier pour continuer.",
"ui.log_file": "Fichier journal : {path}",
"ui.process_died": "L'installation s'est arrêtée de façon inattendue (code de sortie {code}).",
"ui.confirm_cancel": "L'installation est en cours. L'annuler et fermer la fenêtre ?",
"ui.space_one": "Espace libre nécessaire sur {path} : {need} Go (libre : {free} Go).",
"ui.space_two": "Espace libre nécessaire sur {path} : {need} Go (libre : {free} Go) ; sur {temp} : {temp_need} Go (libre : {temp_free} Go).",
"ui.amount_bytes": "{done} / {total} Go",
"ui.amount_chunks": "{done} / {total} parties",
"ui.amount_objects": "{done} / {total} fichiers",
"ui.amount_shaders": "{done} / {total} shaders",
"ui.amount_other": "{done} / {total} {unit}",
"ui.seconds": "{n} s",
"param.input.base": "jeu de base",
"param.input.update": "mise à jour",
"param.input.keys": "clés",
"launcher.title": "Installation de TotK",
"launcher.python_missing": "Les fichiers d'installation sont incomplets : le dossier python à côté de TotK-Setup.exe est manquant. Décompressez à nouveau toute l'archive et lancez TotK-Setup.exe depuis le dossier décompressé.",
"lang.ja": "Japonais",
"lang.en-US": "Anglais (États-Unis)",
"lang.en-GB": "Anglais (Royaume-Uni)",
"lang.fr": "Français",
"lang.fr-CA": "Français (Canada)",
"lang.de": "Allemand",
"lang.it": "Italien",
"lang.es": "Espagnol",
"lang.es-419": "Espagnol (Amérique latine)",
"lang.nl": "Néerlandais",
"lang.pt": "Portugais",
"lang.pt-BR": "Portugais (Brésil)",
"lang.ru": "Russe",
"lang.ko": "Coréen",
"lang.zh-Hans": "Chinois (simplifié)",
"lang.zh-Hant": "Chinois (traditionnel)"
}
+215
View File
@@ -0,0 +1,215 @@
{
"step.check": "Controllo del computer e dei file del gioco",
"step.kit": "Copia del kit di compilazione nella cartella del gioco",
"step.fonts": "Estrazione dei font di sistema",
"step.extract": "Estrazione del gioco",
"step.lift": "Traduzione del codice del gioco in C",
"step.compile": "Compilazione di {game_exe}",
"step.prepare": "Preparazione degli shader",
"step.pc_prompts": "Disegno delle icone di tastiera e mouse",
"step.shapes": "Impaginazione delle schermate del gioco per i tuoi monitor",
"step.dlss": "Download di NVIDIA DLSS",
"step.cleanup": "Pulizia",
"phase.check.host": "Controllo del processore e della scheda grafica",
"phase.check.verify": "Controllo dei file già installati",
"phase.check.verify_romfs": "Controllo dei dati di gioco installati",
"phase.check.inputs": "Apertura dei file del gioco con le chiavi",
"phase.check.unpack_base": "Decompressione del gioco base compresso",
"phase.check.unpack_update": "Decompressione dell'aggiornamento compresso",
"phase.check.versions": "Controllo delle versioni del gioco",
"phase.kit.copy": "Copia degli strumenti con cui il gioco si ricompila per le mod di codice",
"phase.fonts.extract": "Estrazione dei font condivisi dal firmware",
"phase.fonts.copy": "Copia dei font condivisi nella cartella di installazione",
"phase.extract.hash_base": "Calcolo del checksum del gioco base",
"phase.extract.hash_update": "Calcolo del checksum dell'aggiornamento",
"phase.extract.exefs": "Estrazione del codice del gioco",
"phase.extract.copy": "Copia dei dati di gioco",
"phase.extract.merge": "Applicazione dell'aggiornamento ai dati di gioco",
"phase.extract.diagnose": "Ricerca del file di gioco danneggiato",
"phase.extract.index": "Verifica dei dati di gioco",
"phase.lift.discover": "Ricerca delle funzioni",
"phase.lift.emit": "Scrittura del codice C",
"phase.compile.compile": "Compilazione",
"phase.compile.link": "Collegamento di {game_exe}",
"phase.prepare.romfs_patches": "Scrittura delle patch dei dati per i 60 fps",
"phase.pc_prompts.draw": "Disegno delle icone dei tasti e dei pulsanti del mouse dalle assegnazioni di totk.ini",
"phase.prepare.seed": "Lettura degli shader dai dati di gioco",
"phase.prepare.translate": "Traduzione degli shader",
"phase.prepare.libraries": "Creazione degli shader per il driver grafico",
"phase.prepare.pack": "Raccolta della cache degli shader in un file",
"phase.shapes.layouts": "Scrittura dei layout dello schermo e delle icone dei pulsanti per ogni formato di schermo",
"phase.dlss.download": "Download di nvngx_dlss.dll dal DLSS SDK di NVIDIA",
"phase.cleanup.ini": "Scrittura di totk.ini",
"phase.cleanup.temp": "Rimozione dei file temporanei",
"cli.usage": "Riga di comando non valida: {detail}",
"internal": "Errore imprevisto ({exception}): {detail}",
"state.unreadable": "Impossibile leggere {path}. Scegli un'altra cartella o elimina quel file.",
"state.newer_format": "{path} è stato scritto da un programma di installazione più recente. Usa quel programma o un'altra cartella.",
"state.output_changed": "I file installati del passaggio '{step}' sono cambiati da quando sono stati creati; quel passaggio viene ripetuto.",
"check.release_incomplete": "La cartella del programma di installazione è incompleta; manca: {paths}. Estrai di nuovo la release.",
"check.dest_not_folder": "Il percorso di installazione {path} è un file, non una cartella.",
"check.dest_not_empty": "La cartella di installazione {path} non è vuota e non contiene un'installazione precedente. Scegli una cartella vuota.",
"check.lang_missing": "Scegli la lingua del gioco.",
"check.lang_unknown": "Lingua sconosciuta '{lang}'. Lingue note: {known}.",
"check.toolchain_broken": "Il compilatore incluso non funziona: {detail}",
"check.glibc_old": "La libreria C di questo sistema è glibc {version}; il compilatore dell'installazione richiede {need} o successiva (Ubuntu 22.04, Debian 12, Fedora 35, SteamOS 3 e successivi la hanno). Aggiornare il sistema risolve il problema.",
"check.host_probe_failed": "Il controllo del computer non è stato eseguito (codice di uscita {code}).",
"check.cpu_too_old": "Questo processore non supporta x86-64-v2 (SSE4.2, POPCNT e CMPXCHG16B), il livello più vecchio per cui il gioco viene compilato. Intel Nehalem (2008) o AMD Bulldozer (2011) e successivi lo supportano.",
"check.vulkan_missing": "Non è installato alcun driver Vulkan. Installa il driver più recente della tua scheda grafica.",
"check.vulkan_no_device": "Vulkan non trova alcuna scheda grafica. Installa il driver più recente della tua scheda grafica.",
"check.vulkan_too_old": "Il gioco richiede una scheda grafica con Vulkan 1.3; trovato: {devices}. Aggiorna il driver grafico.",
"check.no_display": "La preparazione degli shader richiede uno schermo. Avvia l'installazione dalla sessione desktop oppure esporta DISPLAY=:0 (su uno Steam Deck in modalità Gioco anche XDG_RUNTIME_DIR=/run/user/1000).",
"check.inputs_needed": "Servono i file del gioco: scegli il gioco base, l'aggiornamento 1.1.0, 1.2.1 o 1.4.3 e prod.keys.",
"check.input_missing": "File non trovato ({input}): {path}",
"check.keys_unreadable": "Impossibile leggere il file delle chiavi. Scegli un file prod.keys.",
"check.keys_no_header_key": "Il file delle chiavi non contiene header_key. Estrai di nuovo prod.keys dalla tua console.",
"check.keys_wrong": "Le chiavi non riescono ad aprire il file ({input}). Usa il prod.keys della tua console.",
"check.keys_too_old": "Il file delle chiavi è troppo vecchio per il file ({input}) (richiede la generazione di chiavi {generation}). Estrai prod.keys da una console con un firmware più recente.",
"check.not_game_file": "Il file ({input}) non è un file di gioco XCI, NSP, XCZ o NSZ.",
"check.file_unreadable": "Impossibile leggere il file ({input}): {detail}",
"check.unpack_failed": "Impossibile decomprimere il file compresso {input}: {detail}",
"check.ticket_personalized": "Il file ({input}) contiene un ticket personalizzato; serve un ticket comune.",
"check.ticket_missing": "Al file ({input}) manca il ticket richiesto dal suo contenuto.",
"check.base_not_totk": "Il file del gioco base non è The Legend of Zelda: Tears of the Kingdom ({detail}).",
"check.base_is_update": "Il file del gioco base è un aggiornamento. Scegli qui il gioco base in NSP o XCI (versione 1.0.0) e questo file come aggiornamento.",
"check.base_combined": "Il file del gioco base contiene più pacchetti (gioco base, aggiornamento o DLC in un unico file). Scegli un dump del gioco base che contenga solo il gioco.",
"check.update_not_nsp": "L'aggiornamento deve essere un file NSP o NSZ.",
"check.update_is_base": "Il file dell'aggiornamento contiene un gioco base. Scegli l'NSP dell'aggiornamento 1.1.0, 1.2.1 o 1.4.3.",
"check.update_not_totk": "Il file dell'aggiornamento non è un aggiornamento di Tears of the Kingdom ({detail}).",
"check.exefs_failed": "Il codice del gioco del file ({input}) non ha superato i controlli; vedi {log}.",
"check.input_damaged": "Il file ({input}) è danneggiato o incompleto: {path} ({detail}). Copia di nuovo quel file dalla sua origine o rifai il dump, poi esegui di nuovo l'installazione.",
"check.base_wrong_version": "Il gioco base non è la versione 1.0.0 ({modules} diversi).",
"check.update_wrong_version": "L'aggiornamento è la versione {found}; questa release usa {wanted}.",
"check.disk_space": "Spazio libero insufficiente per {path}: servono {need_gb} GB, liberi {free_gb} GB.",
"check.firmware_missing": "La cartella del firmware {path} non esiste. Scegli la cartella Contents/registered del firmware.",
"check.firmware_empty": "La cartella del firmware {path} non contiene file NCA. Scegli la cartella Contents/registered del firmware.",
"check.fonts_keys_needed": "I font condivisi per questa lingua non sono ancora installati; scegli prod.keys perché l'installazione possa estrarli dal firmware.",
"extract.exefs_mismatch": "Il codice del gioco estratto non corrisponde alla versione {version} ({modules}).",
"extract.romfs_merge_failed": "L'applicazione dell'aggiornamento ai dati di gioco non è riuscita: {detail}. Dettagli: {log}",
"extract.romfs_mismatch": "I dati di gioco estratti non corrispondono alla versione {version} (dimensione {size}, checksum {sha256}...).",
"fonts.failed": "L'estrazione dei font condivisi non è riuscita (codice di uscita {code}): {detail}. Dettagli: {log}",
"fonts.incomplete": "L'estrazione dei font condivisi non ha scritto tutti i file ({files}).",
"fonts.copy_failed": "Impossibile copiare i font condivisi in {path}: {detail}",
"lift.failed": "La traduzione del codice del gioco non è riuscita (codice di uscita {code}). Dettagli: {log}",
"compile.failed": "La compilazione di {game_exe} non è riuscita (codice di uscita {code}). Dettagli: {log}",
"compile.exe_in_use": "{path} è in uso. Chiudi il gioco ed esegui di nuovo il programma di installazione.",
"kit.in_use": "{path} è in uso. Chiudi il gioco e ogni finestra di installazione o ricompilazione aperta, poi esegui di nuovo l'installazione.",
"kit.copy_failed": "Impossibile copiare il kit di compilazione in {path}: {detail}",
"compile.exe_locked": "Impossibile scrivere {path}: un altro programma lo tiene aperto, un gioco avviato da quella cartella o un antivirus che ha segnalato il file. Chiudi il gioco, aggiungi la cartella del programma di installazione e la cartella di installazione alle esclusioni dell'antivirus, riavvia Windows, poi esegui di nuovo l'installazione. Dettagli: {log}",
"prepare.xlate_in_use": "{path} è in uso. Chiudi il gioco, termina ogni processo totk_xlate rimasto da un'esecuzione precedente, poi esegui di nuovo il programma di installazione.",
"prepare.shader_list_missing": "Manca l'elenco degli shader.",
"prepare.romfs_patches_failed": "La scrittura delle patch dei dati di gioco non è riuscita (codice di uscita {code}). Dettagli: {log}",
"prepare.shaders_failed": "La preparazione degli shader non è riuscita (codice di uscita {code}). Dettagli: {log}",
"cleanup.romfs_unreadable": "I dati di gioco in {path} mancano o non sono leggibili dopo l'installazione. Riavvia Windows, poi esegui di nuovo il programma di installazione sulla stessa cartella: estrae di nuovo i dati di gioco e mantiene il resto.",
"prepare.pack_failed": "La raccolta della cache degli shader non è riuscita (codice di uscita {code}). Dettagli: {log}",
"cleanup.ini_failed": "Impossibile scrivere totk.ini: {detail}",
"warn.lang_needs_fonts": "Il testo in {lang} richiede i font di sistema di Switch e non ne è stato indicato nessuno. Il gioco non si avvierà in questa lingua finché non verranno aggiunti. Scegli la cartella del firmware (Contents/registered) o consulta \"Switch system fonts\" in docs/installer.md.",
"warn.npdm_differs": "main.npdm è diverso dal dump di riferimento {version}; vengono usati solo i moduli di codice.",
"warn.cheats_skipped": "Non è stato possibile creare i trucchi della cartella mods che modificano il codice del gioco; il gioco viene installato senza di essi. Dettagli: {log}",
"warn.exefs_skipped": "Non è stato possibile creare le patch ExeFS delle mod (.ips, .pchtxt); il gioco viene installato senza di esse. Dettagli: {log}",
"warn.plugins_skipped": "Non è stato possibile compilare i plugin di codice delle mod (exefs subsdk); il gioco si installa senza di essi. Dettagli: {log}",
"warn.xbox_prompts_failed": "Non è stato possibile preparare le icone dei pulsanti Xbox, PlayStation o PC (codice di uscita {code}); il gioco mantiene le icone di Switch. Dettagli: {log}",
"warn.shaders_skipped": "Il driver grafico si è bloccato durante la creazione di alcuni shader, quindi {count} sono stati esclusi dalla preparazione. Il gioco li crea quando servono per la prima volta, e anche lì il driver potrebbe bloccarsi; un aggiornamento del driver potrebbe risolvere. Dettagli: {log}",
"warn.kernel_old": "Linux {version} non ha il tracciamento delle scritture su cui si basa il gioco (6.7 o successivo); il gioco potrebbe essere molto lento. Aggiornare il sistema risolve il problema.",
"warn.dlss_kept": "Nella cartella di installazione c'è già una libreria DLSS ({path}); l'installazione la mantiene.",
"warn.dlss_download_failed": "Impossibile scaricare NVIDIA DLSS da {url}: {detail}. Il gioco funziona senza; la prossima esecuzione dell'installazione riproverà.",
"ui.title": "Installazione di TotK",
"ui.rebuild_title": "Ricostruzione del gioco per le tue mod",
"ui.start_game": "Avvia il gioco",
"ui.version": "versione {version}",
"ui.intro": "Crea una cartella giocabile di Tears of the Kingdom dai tuoi file del gioco. Richiede un po' di tempo e si esegue una sola volta.",
"ui.notice": "La cartella creata da questa installazione contiene il gioco. È solo per uso personale; non condividerla né caricarla online.",
"ui.keys_private": "Il file delle chiavi viene letto sul posto. Il suo contenuto non viene mai mostrato, copiato o salvato.",
"ui.base": "Gioco base",
"ui.update": "Aggiornamento",
"ui.keys": "prod.keys",
"ui.firmware": "Firmware (facoltativo)",
"ui.game_language": "Lingua del gioco",
"ui.dest": "Cartella di installazione",
"ui.browse": "Sfoglia...",
"ui.pick_game": "Scegli il file del gioco base",
"ui.pick_update": "Scegli il file dell'aggiornamento 1.1.0, 1.2.1 o 1.4.3",
"ui.pick_keys": "Scegli prod.keys",
"ui.pick_firmware": "Scegli la cartella del firmware di Switch (Contents/registered)",
"ui.pick_dest": "Scegli la cartella di installazione",
"ui.firmware_help": "Per il testo in cinese, coreano e cinese tradizionale: la cartella Contents/registered del firmware, ad esempio da Ryujinx o Yuzu. L'installazione ne copia i font di sistema di Switch nella cartella di installazione.",
"ui.dlss": "Scarica NVIDIA DLSS (nvngx_dlss.dll) per le schede grafiche NVIDIA RTX",
"ui.dlss_help": "Dal DLSS SDK di NVIDIA su GitHub, con la licenza RTX SDK di NVIDIA (github.com/NVIDIA/DLSS). Fa funzionare le impostazioni dlaa e DLSS; senza, non hanno effetto.",
"ui.compressed_help": "I file compressi NSZ e XCZ funzionano così come sono: l'installazione li decomprime da sé (finché i dati del gioco non sono estratti, serve tanto spazio libero quanto occupano i file decompressi).",
"ui.section_files": "File del gioco",
"ui.section_install": "Installazione",
"ui.more_details": "▸ Altri dettagli",
"ui.fewer_details": "▾ Nascondi dettagli",
"ui.formats_help": "Gioco base: NSP, XCI, NSZ o XCZ. Aggiornamento: 1.1.0, 1.2.1 o 1.4.3, in NSP o NSZ.",
"ui.type_game": "File di gioco (NSP, XCI, NSZ, XCZ)",
"ui.type_keys": "File di chiavi (*.keys)",
"ui.type_all": "Tutti i file",
"ui.start": "Avvia",
"ui.cancel": "Annulla",
"ui.cancelling": "Annullamento...",
"ui.show_log": "Mostra registro",
"ui.hide_log": "Nascondi registro",
"ui.close": "Chiudi",
"ui.back": "Indietro",
"ui.open_folder": "Apri cartella",
"ui.update_mode": "Questa cartella contiene un'installazione precedente. L'installazione la prosegue o la aggiorna; i file del gioco vengono chiesti solo se servono di nuovo.",
"ui.need_dest": "Scegli la cartella di installazione.",
"ui.need_base": "Scegli il file del gioco base.",
"ui.need_update": "Scegli il file dell'aggiornamento 1.1.0, 1.2.1 o 1.4.3.",
"ui.need_keys": "Scegli il file prod.keys.",
"ui.need_lang": "Scegli la lingua del gioco.",
"ui.missing_base": "Il file del gioco base non esiste.",
"ui.missing_update": "Il file dell'aggiornamento non esiste.",
"ui.missing_keys": "Il file delle chiavi non esiste.",
"ui.missing_firmware": "La cartella del firmware non esiste.",
"ui.running_install": "Installazione",
"ui.running_resume": "Ripresa dell'installazione precedente",
"ui.running_update": "Aggiornamento dell'installazione",
"ui.state_started": "avviato",
"ui.state_done": "fatto",
"ui.state_skipped": "saltato",
"ui.state_pending": "in attesa",
"ui.state_running": "in corso",
"ui.state_failed": "non riuscito",
"ui.log_warning": "Avviso",
"ui.log_error": "Errore",
"ui.log_space": "Spazio necessario: {need} GB, libero: {free} GB",
"ui.log_end": "Terminato",
"ui.result_ok": "Il gioco è pronto",
"ui.result_failed": "L'installazione non è riuscita",
"ui.result_cancelled": "L'installazione è stata annullata",
"ui.done_text": "Avvia {game_exe} da {dest}. Il programma di installazione e i file del gioco scelti non servono più.",
"ui.cancelled_text": "I passaggi completati vengono mantenuti. Avvia di nuovo l'installazione con la stessa cartella per continuare.",
"ui.log_file": "File di registro: {path}",
"ui.process_died": "L'installazione si è interrotta inaspettatamente (codice di uscita {code}).",
"ui.confirm_cancel": "L'installazione è in corso. Annullarla e chiudere la finestra?",
"ui.space_one": "Spazio libero necessario su {path}: {need} GB (libero: {free} GB).",
"ui.space_two": "Spazio libero necessario su {path}: {need} GB (libero: {free} GB); su {temp}: {temp_need} GB (libero: {temp_free} GB).",
"ui.amount_bytes": "{done} / {total} GB",
"ui.amount_chunks": "{done} / {total} parti",
"ui.amount_objects": "{done} / {total} file",
"ui.amount_shaders": "{done} / {total} shader",
"ui.amount_other": "{done} / {total} {unit}",
"ui.seconds": "{n} s",
"param.input.base": "gioco base",
"param.input.update": "aggiornamento",
"param.input.keys": "chiavi",
"launcher.title": "Installazione di TotK",
"launcher.python_missing": "I file di installazione sono incompleti: manca la cartella python accanto a TotK-Setup.exe. Estrai di nuovo l'intero archivio e avvia TotK-Setup.exe dalla cartella estratta.",
"lang.ja": "Giapponese",
"lang.en-US": "Inglese (USA)",
"lang.en-GB": "Inglese (Regno Unito)",
"lang.fr": "Francese",
"lang.fr-CA": "Francese (Canada)",
"lang.de": "Tedesco",
"lang.it": "Italiano",
"lang.es": "Spagnolo",
"lang.es-419": "Spagnolo (America Latina)",
"lang.nl": "Olandese",
"lang.pt": "Portoghese",
"lang.pt-BR": "Portoghese (Brasile)",
"lang.ru": "Russo",
"lang.ko": "Coreano",
"lang.zh-Hans": "Cinese (semplificato)",
"lang.zh-Hant": "Cinese (tradizionale)"
}
+215
View File
@@ -0,0 +1,215 @@
{
"step.check": "コンピューターとゲームファイルの確認",
"step.kit": "ビルドキットをゲームフォルダーにコピー",
"step.fonts": "システムフォントの抽出",
"step.extract": "ゲームの展開",
"step.lift": "ゲームコードの C への変換",
"step.compile": "{game_exe} のコンパイル",
"step.prepare": "シェーダーの準備",
"step.pc_prompts": "キーボードとマウスのボタン表示の作成",
"step.shapes": "ディスプレイに合わせたゲーム画面のレイアウト",
"step.dlss": "NVIDIA DLSS のダウンロード",
"step.cleanup": "後片付け",
"phase.check.host": "プロセッサーとグラフィックカードを確認しています",
"phase.check.verify": "インストール済みのファイルを確認しています",
"phase.check.verify_romfs": "インストール済みのゲームデータを確認しています",
"phase.check.inputs": "キーでゲームファイルを開いています",
"phase.check.unpack_base": "圧縮されたベースゲームを展開しています",
"phase.check.unpack_update": "圧縮されたアップデートを展開しています",
"phase.check.versions": "ゲームのバージョンを確認しています",
"phase.kit.copy": "コード MOD 用にゲームが自身を再ビルドするためのツールをコピーしています",
"phase.fonts.extract": "ファームウェアから共有フォントを抽出しています",
"phase.fonts.copy": "共有フォントをインストール先フォルダーにコピーしています",
"phase.extract.hash_base": "本編のチェックサムを計算しています",
"phase.extract.hash_update": "アップデートのチェックサムを計算しています",
"phase.extract.exefs": "ゲームコードを抽出しています",
"phase.extract.copy": "ゲームデータをコピーしています",
"phase.extract.merge": "ゲームデータにアップデートを適用しています",
"phase.extract.diagnose": "破損したゲームファイルを探しています",
"phase.extract.index": "ゲームデータを検証しています",
"phase.lift.discover": "関数を探しています",
"phase.lift.emit": "C コードを書き出しています",
"phase.compile.compile": "コンパイルしています",
"phase.compile.link": "{game_exe} をリンクしています",
"phase.prepare.romfs_patches": "60 fps 用のゲームデータパッチを書き出しています",
"phase.pc_prompts.draw": "totk.ini の割り当てからキーとマウスボタンの表示を作成しています",
"phase.prepare.seed": "ゲームデータからシェーダーを読み込んでいます",
"phase.prepare.translate": "シェーダーを変換しています",
"phase.prepare.libraries": "グラフィックドライバー用にシェーダーをビルドしています",
"phase.prepare.pack": "シェーダーキャッシュを 1 つのファイルにまとめています",
"phase.shapes.layouts": "画面の形ごとに画面レイアウトとボタン表示を書き込んでいます",
"phase.dlss.download": "NVIDIA の DLSS SDK から nvngx_dlss.dll をダウンロードしています",
"phase.cleanup.ini": "totk.ini を書き込んでいます",
"phase.cleanup.temp": "一時ファイルを削除しています",
"cli.usage": "コマンドラインが無効です: {detail}",
"internal": "予期しないエラー ({exception}): {detail}",
"state.unreadable": "{path} を読み取れません。別のフォルダーを選ぶか、そのファイルを削除してください。",
"state.newer_format": "{path} は新しいバージョンのインストーラーで書き込まれています。そのインストーラーか別のフォルダーを使ってください。",
"state.output_changed": "手順「{step}」でインストールしたファイルが作成後に変更されています。その手順をもう一度実行します。",
"check.release_incomplete": "インストーラーのフォルダーが不完全です。不足: {paths}。リリースをもう一度展開してください。",
"check.dest_not_folder": "インストール先 {path} はフォルダーではなくファイルです。",
"check.dest_not_empty": "インストール先フォルダー {path} は空ではなく、以前のインストールも含まれていません。空のフォルダーを選んでください。",
"check.lang_missing": "ゲームの言語を選んでください。",
"check.lang_unknown": "不明な言語「{lang}」です。使用できる言語: {known}。",
"check.toolchain_broken": "同梱のコンパイラーが動作しません: {detail}",
"check.glibc_old": "このシステムの C ライブラリは glibc {version} です。セットアップのコンパイラーには {need} 以降が必要です (Ubuntu 22.04、Debian 12、Fedora 35、SteamOS 3 以降にあります)。システムを更新すると解決します。",
"check.host_probe_failed": "コンピューターの確認を実行できませんでした (終了コード {code})。",
"check.cpu_too_old": "このプロセッサーは、ゲームのビルド対象となる最も古いレベルである x86-64-v2 (SSE4.2、POPCNT、CMPXCHG16B) に対応していません。Intel Nehalem (2008 年) または AMD Bulldozer (2011 年) 以降が対応しています。",
"check.vulkan_missing": "Vulkan ドライバーがインストールされていません。グラフィックカードの最新ドライバーをインストールしてください。",
"check.vulkan_no_device": "Vulkan がグラフィックカードを見つけられません。グラフィックカードの最新ドライバーをインストールしてください。",
"check.vulkan_too_old": "このゲームには Vulkan 1.3 対応のグラフィックカードが必要です。見つかったもの: {devices}。グラフィックドライバーを更新してください。",
"check.no_display": "シェーダーの準備にはディスプレイが必要です。デスクトップのセッションからセットアップを実行するか、DISPLAY=:0 を export してください(Steam Deck のゲームモードでは XDG_RUNTIME_DIR=/run/user/1000 も)。",
"check.inputs_needed": "ゲームファイルが必要です。本編、1.1.0・1.2.1・1.4.3 のいずれかのアップデート、prod.keys を選んでください。",
"check.input_missing": "ファイルが見つかりません ({input}): {path}",
"check.keys_unreadable": "キーファイルを読み取れません。prod.keys ファイルを選んでください。",
"check.keys_no_header_key": "キーファイルに header_key がありません。本体から prod.keys をもう一度吸い出してください。",
"check.keys_wrong": "このキーでは{input}のファイルを開けません。ご自分の本体の prod.keys を使ってください。",
"check.keys_too_old": "キーファイルが{input}のファイルには古すぎます (キー世代 {generation} が必要)。より新しいファームウェアの本体から prod.keys を吸い出してください。",
"check.not_game_file": "{input}のファイルは XCI、NSP、XCZ、NSZ のいずれのゲームファイルでもありません。",
"check.file_unreadable": "{input}のファイルを読み取れません: {detail}",
"check.unpack_failed": "圧縮ファイル {input} を展開できませんでした: {detail}",
"check.ticket_personalized": "{input}のファイルには個人用チケットが含まれています。共通チケットが必要です。",
"check.ticket_missing": "{input}のファイルには、内容に必要なチケットがありません。",
"check.base_not_totk": "本編のファイルは ゼルダの伝説 ティアーズ オブ ザ キングダム ではありません ({detail})。",
"check.base_is_update": "本編のファイルはアップデートです。ここには本編の NSP または XCI (バージョン 1.0.0) を選び、このファイルはアップデートとして選んでください。",
"check.base_combined": "本編のファイルに複数のパッケージ (本編、アップデート、DLC が 1 つのファイル) が含まれています。ゲームだけを含む本編のダンプを選んでください。",
"check.update_not_nsp": "アップデートは NSP または NSZ ファイルである必要があります。",
"check.update_is_base": "アップデートのファイルに本編が含まれています。1.1.0・1.2.1・1.4.3 のいずれかのアップデートの NSP を選んでください。",
"check.update_not_totk": "アップデートのファイルは ティアーズ オブ ザ キングダム のアップデートではありません ({detail})。",
"check.exefs_failed": "{input}のファイルのゲームコードが検査に合格しませんでした。{log} を参照してください。",
"check.input_damaged": "{input}のファイルが破損しているか不完全です: {path} ({detail})。そのファイルを元の場所からもう一度コピーするか、もう一度吸い出してから、セットアップを再実行してください。",
"check.base_wrong_version": "本編がバージョン 1.0.0 ではありません ({modules} が異なります)。",
"check.update_wrong_version": "アップデートのバージョンは {found} です。このリリースは {wanted} に対応しています。",
"check.disk_space": "{path} の空き容量が足りません: {need_gb} GB 必要、空き {free_gb} GB。",
"check.firmware_missing": "ファームウェアフォルダー {path} が存在しません。ファームウェアの Contents/registered フォルダーを選んでください。",
"check.firmware_empty": "ファームウェアフォルダー {path} に NCA ファイルがありません。ファームウェアの Contents/registered フォルダーを選んでください。",
"check.fonts_keys_needed": "この言語用の共有フォントがまだインストールされていません。セットアップがファームウェアから抽出できるよう、prod.keys を選んでください。",
"extract.exefs_mismatch": "抽出したゲームコードがバージョン {version} と一致しません ({modules})。",
"extract.romfs_merge_failed": "ゲームデータへのアップデートの適用に失敗しました: {detail}。詳細: {log}",
"extract.romfs_mismatch": "抽出したゲームデータがバージョン {version} と一致しません (サイズ {size}、チェックサム {sha256}...)。",
"fonts.failed": "共有フォントの抽出に失敗しました (終了コード {code}): {detail}。詳細: {log}",
"fonts.incomplete": "共有フォントの抽出で一部のファイルが書き込まれませんでした ({files})。",
"fonts.copy_failed": "共有フォントを {path} にコピーできません: {detail}",
"lift.failed": "ゲームコードの変換に失敗しました (終了コード {code})。詳細: {log}",
"compile.failed": "{game_exe} のコンパイルに失敗しました (終了コード {code})。詳細: {log}",
"compile.exe_in_use": "{path} は使用中です。ゲームを閉じてから、インストーラーをもう一度実行してください。",
"kit.in_use": "{path} は使用中です。ゲームと、開いているセットアップや再ビルドのウィンドウをすべて閉じてから、セットアップをもう一度実行してください。",
"kit.copy_failed": "ビルドキットを {path} にコピーできません: {detail}",
"compile.exe_locked": "{path} に書き込めません。別のプログラムがファイルを使用しています (そのフォルダーから起動したゲーム、またはファイルを検出したウイルス対策ソフト)。ゲームを閉じ、セットアップのフォルダーとインストール先フォルダーをウイルス対策ソフトの除外に追加し、Windows を再起動してから、セットアップをもう一度実行してください。詳細: {log}",
"prepare.xlate_in_use": "{path} は使用中です。ゲームを閉じ、以前の実行で残った totk_xlate プロセスを終了してから、インストーラーをもう一度実行してください。",
"prepare.shader_list_missing": "シェーダーの一覧がありません。",
"prepare.romfs_patches_failed": "ゲームデータパッチの書き出しに失敗しました (終了コード {code})。詳細: {log}",
"prepare.shaders_failed": "シェーダーの準備に失敗しました (終了コード {code})。詳細: {log}",
"cleanup.romfs_unreadable": "インストール後、{path} のゲームデータが見つからないか読み取れません。Windows を再起動し、同じフォルダーでインストーラーをもう一度実行してください。ゲームデータだけを再展開し、それ以外は保持します。",
"prepare.pack_failed": "シェーダーキャッシュのまとめに失敗しました (終了コード {code})。詳細: {log}",
"cleanup.ini_failed": "totk.ini を書き込めません: {detail}",
"warn.lang_needs_fonts": "{lang}のテキストには Switch のシステムフォントが必要ですが、指定されていません。追加されるまで、この言語ではゲームが起動しません。ファームウェアフォルダー (Contents/registered) を選ぶか、docs/installer.md の「Switch system fonts」を参照してください。",
"warn.npdm_differs": "main.npdm が参照用の {version} ダンプと異なります。コードモジュールのみを使用します。",
"warn.cheats_skipped": "mods フォルダーにあるゲームコードを変更するチートをビルドできませんでした。チートなしでゲームをインストールします。詳細: {log}",
"warn.exefs_skipped": "Mod の ExeFS パッチ (.ips、.pchtxt) をビルドできませんでした。パッチなしでゲームをインストールします。詳細: {log}",
"warn.plugins_skipped": "MOD のコードプラグイン (exefs subsdk) をビルドできませんでした。ゲームはそれらなしでインストールされます。詳細: {log}",
"warn.xbox_prompts_failed": "Xbox、PlayStation、PC のボタン表示を準備できませんでした (終了コード {code})。ゲームは Switch のボタン表示のままです。詳細: {log}",
"warn.shaders_skipped": "一部のシェーダーのビルド中にグラフィックドライバーがクラッシュしたため、{count} 個を準備から除外しました。ゲームは初めて必要になったときにそれらをビルドしますが、そこでもドライバーがクラッシュする可能性があります。ドライバーを更新すると解決することがあります。詳細: {log}",
"warn.kernel_old": "Linux {version} には、ゲームが必要とする書き込み追跡 (6.7 以降) がありません。ゲームが非常に遅くなることがあります。システムを更新すると解決します。",
"warn.dlss_kept": "インストール先フォルダーには既に DLSS ライブラリがあります ({path})。セットアップはそれを残します。",
"warn.dlss_download_failed": "NVIDIA DLSS を {url} からダウンロードできませんでした: {detail}。ゲームはなしで動作します。次回のセットアップ実行時に再試行します。",
"ui.title": "TotK セットアップ",
"ui.rebuild_title": "Mod に合わせてゲームを再ビルドしています",
"ui.start_game": "ゲームを開始",
"ui.version": "バージョン {version}",
"ui.intro": "お持ちのゲームファイルから、プレイ可能な ティアーズ オブ ザ キングダム のフォルダーを作成します。時間がかかりますが、実行は一度だけです。",
"ui.notice": "このセットアップが作成するフォルダーにはゲームが含まれます。個人での使用に限り、共有やアップロードはしないでください。",
"ui.keys_private": "キーファイルはその場で読み取られます。内容が表示、コピー、保存されることはありません。",
"ui.base": "本編",
"ui.update": "アップデート",
"ui.keys": "prod.keys",
"ui.firmware": "ファームウェア (任意)",
"ui.game_language": "ゲームの言語",
"ui.dest": "インストール先フォルダー",
"ui.browse": "参照...",
"ui.pick_game": "本編のファイルを選択",
"ui.pick_update": "1.1.0・1.2.1・1.4.3 のアップデートファイルを選択",
"ui.pick_keys": "prod.keys を選択",
"ui.pick_firmware": "Switch のファームウェアフォルダー (Contents/registered) を選択",
"ui.pick_dest": "インストール先フォルダーを選択",
"ui.firmware_help": "中国語、韓国語、繁体字中国語のテキスト用: ファームウェアの Contents/registered フォルダー (例: Ryujinx や Yuzu のもの)。セットアップはそこから Switch のシステムフォントをインストール先フォルダーにコピーします。",
"ui.dlss": "NVIDIA RTX グラフィックカード用に NVIDIA DLSS (nvngx_dlss.dll) をダウンロードする",
"ui.dlss_help": "GitHub 上の NVIDIA の DLSS SDK から、NVIDIA の RTX SDK ライセンスのもとで取得します (github.com/NVIDIA/DLSS)。これで dlaa と DLSS の設定が機能します。ない場合、これらの設定は効果がありません。",
"ui.compressed_help": "圧縮された NSZ / XCZ ファイルはそのまま使えます。セットアップが自分で展開します(ゲームデータの展開が終わるまで、展開後のファイルと同じだけの空き容量が必要です)。",
"ui.section_files": "ゲームファイル",
"ui.section_install": "インストール",
"ui.more_details": "▸ 詳細を表示",
"ui.fewer_details": "▾ 詳細を隠す",
"ui.formats_help": "本編: NSP、XCI、NSZ または XCZ。アップデート: 1.1.0、1.2.1 または 1.4.3 (NSP または NSZ)。",
"ui.type_game": "ゲームファイル (NSP、XCI、NSZ、XCZ)",
"ui.type_keys": "キーファイル (*.keys)",
"ui.type_all": "すべてのファイル",
"ui.start": "開始",
"ui.cancel": "キャンセル",
"ui.cancelling": "キャンセルしています...",
"ui.show_log": "ログを表示",
"ui.hide_log": "ログを隠す",
"ui.close": "閉じる",
"ui.back": "戻る",
"ui.open_folder": "フォルダーを開く",
"ui.update_mode": "このフォルダーには以前のインストールがあります。セットアップはそれを続行または更新します。ゲームファイルは再度必要な場合にのみ求められます。",
"ui.need_dest": "インストール先フォルダーを選んでください。",
"ui.need_base": "本編のファイルを選んでください。",
"ui.need_update": "1.1.0・1.2.1・1.4.3 のアップデートファイルを選んでください。",
"ui.need_keys": "prod.keys ファイルを選んでください。",
"ui.need_lang": "ゲームの言語を選んでください。",
"ui.missing_base": "本編のファイルが存在しません。",
"ui.missing_update": "アップデートのファイルが存在しません。",
"ui.missing_keys": "キーファイルが存在しません。",
"ui.missing_firmware": "ファームウェアフォルダーが存在しません。",
"ui.running_install": "インストール中",
"ui.running_resume": "以前のセットアップを続行中",
"ui.running_update": "インストールを更新中",
"ui.state_started": "開始",
"ui.state_done": "完了",
"ui.state_skipped": "スキップ",
"ui.state_pending": "待機中",
"ui.state_running": "実行中",
"ui.state_failed": "失敗",
"ui.log_warning": "警告",
"ui.log_error": "エラー",
"ui.log_space": "必要な容量: {need} GB、空き: {free} GB",
"ui.log_end": "終了",
"ui.result_ok": "ゲームの準備ができました",
"ui.result_failed": "セットアップに失敗しました",
"ui.result_cancelled": "セットアップはキャンセルされました",
"ui.done_text": "{dest} から {game_exe} を起動してください。セットアップと選んだゲームファイルはもう必要ありません。",
"ui.cancelled_text": "完了した手順は保持されます。続けるには、同じフォルダーでセットアップをもう一度開始してください。",
"ui.log_file": "ログファイル: {path}",
"ui.process_died": "セットアップが予期せず停止しました (終了コード {code})。",
"ui.confirm_cancel": "セットアップを実行中です。キャンセルしてウィンドウを閉じますか?",
"ui.space_one": "{path} に必要な空き容量: {need} GB (空き: {free} GB)。",
"ui.space_two": "{path} に必要な空き容量: {need} GB (空き: {free} GB)、{temp}: {temp_need} GB (空き: {temp_free} GB)。",
"ui.amount_bytes": "{done} / {total} GB",
"ui.amount_chunks": "{done} / {total} パート",
"ui.amount_objects": "{done} / {total} ファイル",
"ui.amount_shaders": "{done} / {total} シェーダー",
"ui.amount_other": "{done} / {total} {unit}",
"ui.seconds": "{n} 秒",
"param.input.base": "本編",
"param.input.update": "アップデート",
"param.input.keys": "キー",
"launcher.title": "TotK セットアップ",
"launcher.python_missing": "セットアップのファイルが不完全です。TotK-Setup.exe の隣にある python フォルダーがありません。アーカイブ全体をもう一度展開し、展開したフォルダーから TotK-Setup.exe を起動してください。",
"lang.ja": "日本語",
"lang.en-US": "英語 (米国)",
"lang.en-GB": "英語 (英国)",
"lang.fr": "フランス語",
"lang.fr-CA": "フランス語 (カナダ)",
"lang.de": "ドイツ語",
"lang.it": "イタリア語",
"lang.es": "スペイン語",
"lang.es-419": "スペイン語 (中南米)",
"lang.nl": "オランダ語",
"lang.pt": "ポルトガル語",
"lang.pt-BR": "ポルトガル語 (ブラジル)",
"lang.ru": "ロシア語",
"lang.ko": "韓国語",
"lang.zh-Hans": "中国語 (簡体字)",
"lang.zh-Hant": "中国語 (繁体字)"
}
+215
View File
@@ -0,0 +1,215 @@
{
"step.check": "컴퓨터와 게임 파일 확인",
"step.kit": "빌드 키트를 게임 폴더로 복사",
"step.fonts": "시스템 글꼴 추출",
"step.extract": "게임 추출",
"step.lift": "게임 코드를 C로 변환",
"step.compile": "{game_exe} 컴파일",
"step.prepare": "셰이더 준비",
"step.pc_prompts": "키보드 및 마우스 버튼 표시 그리기",
"step.shapes": "모니터에 맞게 게임 화면 배치",
"step.dlss": "NVIDIA DLSS 다운로드",
"step.cleanup": "정리",
"phase.check.host": "프로세서와 그래픽 카드를 확인하는 중",
"phase.check.verify": "이미 설치된 파일을 확인하는 중",
"phase.check.verify_romfs": "설치된 게임 데이터를 확인하는 중",
"phase.check.inputs": "키로 게임 파일을 여는 중",
"phase.check.unpack_base": "압축된 기본 게임의 압축을 푸는 중",
"phase.check.unpack_update": "압축된 업데이트의 압축을 푸는 중",
"phase.check.versions": "게임 버전을 확인하는 중",
"phase.kit.copy": "코드 모드용으로 게임이 스스로 다시 빌드할 때 쓰는 도구 복사 중",
"phase.fonts.extract": "펌웨어에서 공유 글꼴을 추출하는 중",
"phase.fonts.copy": "공유 글꼴을 설치 폴더로 복사하는 중",
"phase.extract.hash_base": "기본 게임의 체크섬을 계산하는 중",
"phase.extract.hash_update": "업데이트의 체크섬을 계산하는 중",
"phase.extract.exefs": "게임 코드를 추출하는 중",
"phase.extract.copy": "게임 데이터를 복사하는 중",
"phase.extract.merge": "게임 데이터에 업데이트를 적용하는 중",
"phase.extract.diagnose": "손상된 게임 파일을 찾는 중",
"phase.extract.index": "게임 데이터를 검증하는 중",
"phase.lift.discover": "함수를 찾는 중",
"phase.lift.emit": "C 코드를 작성하는 중",
"phase.compile.compile": "컴파일하는 중",
"phase.compile.link": "{game_exe} 링크 중",
"phase.prepare.romfs_patches": "60 fps 게임 데이터 패치를 작성하는 중",
"phase.pc_prompts.draw": "totk.ini의 할당에 따라 키와 마우스 버튼 표시 그리는 중",
"phase.prepare.seed": "게임 데이터에서 셰이더를 읽는 중",
"phase.prepare.translate": "셰이더를 변환하는 중",
"phase.prepare.libraries": "그래픽 드라이버용 셰이더를 빌드하는 중",
"phase.prepare.pack": "셰이더 캐시를 파일 하나로 묶는 중",
"phase.shapes.layouts": "화면 형태마다 화면 레이아웃과 버튼 표시 쓰는 중",
"phase.dlss.download": "NVIDIA DLSS SDK에서 nvngx_dlss.dll을 다운로드하는 중",
"phase.cleanup.ini": "totk.ini를 쓰는 중",
"phase.cleanup.temp": "임시 파일을 삭제하는 중",
"cli.usage": "잘못된 명령줄: {detail}",
"internal": "예기치 않은 오류({exception}): {detail}",
"state.unreadable": "{path}을(를) 읽을 수 없습니다. 다른 폴더를 선택하거나 해당 파일을 삭제하세요.",
"state.newer_format": "{path}은(는) 더 새로운 설치 프로그램이 작성했습니다. 그 설치 프로그램이나 다른 폴더를 사용하세요.",
"state.output_changed": "'{step}' 단계에서 설치한 파일이 만들어진 후 변경되었습니다. 해당 단계를 다시 실행합니다.",
"check.release_incomplete": "설치 프로그램 폴더가 불완전합니다. 누락: {paths}. 릴리스 압축을 다시 푸세요.",
"check.dest_not_folder": "설치 위치 {path}은(는) 폴더가 아니라 파일입니다.",
"check.dest_not_empty": "설치 폴더 {path}이(가) 비어 있지 않으며 이전 설치도 없습니다. 빈 폴더를 선택하세요.",
"check.lang_missing": "게임 언어를 선택하세요.",
"check.lang_unknown": "알 수 없는 언어 '{lang}'. 사용 가능: {known}.",
"check.toolchain_broken": "포함된 컴파일러가 작동하지 않습니다: {detail}",
"check.glibc_old": "이 시스템의 C 라이브러리는 glibc {version}입니다. 설치 프로그램의 컴파일러에는 {need} 이상이 필요합니다(Ubuntu 22.04, Debian 12, Fedora 35, SteamOS 3 이상에 있음). 시스템을 업데이트하면 해결됩니다.",
"check.host_probe_failed": "컴퓨터 확인이 실행되지 않았습니다(종료 코드 {code}).",
"check.cpu_too_old": "이 프로세서에는 게임이 빌드되는 가장 오래된 수준인 x86-64-v2(SSE4.2, POPCNT, CMPXCHG16B)가 없습니다. Intel Nehalem(2008) 또는 AMD Bulldozer(2011) 이후 프로세서에 있습니다.",
"check.vulkan_missing": "Vulkan 드라이버가 설치되어 있지 않습니다. 그래픽 카드의 최신 드라이버를 설치하세요.",
"check.vulkan_no_device": "Vulkan이 그래픽 카드를 찾지 못했습니다. 그래픽 카드의 최신 드라이버를 설치하세요.",
"check.vulkan_too_old": "게임에는 Vulkan 1.3을 지원하는 그래픽 카드가 필요합니다. 발견된 장치: {devices}. 그래픽 드라이버를 업데이트하세요.",
"check.no_display": "셰이더를 준비하려면 디스플레이가 필요합니다. 데스크톱 세션에서 설치 프로그램을 실행하거나 DISPLAY=:0 을 export 하세요(게임 모드의 Steam Deck에서는 XDG_RUNTIME_DIR=/run/user/1000 도).",
"check.inputs_needed": "게임 파일이 필요합니다. 기본 게임, 1.1.0 또는 1.2.1 또는 1.4.3 업데이트, prod.keys를 선택하세요.",
"check.input_missing": "파일을 찾을 수 없음({input}): {path}",
"check.keys_unreadable": "키 파일을 읽을 수 없습니다. prod.keys 파일을 선택하세요.",
"check.keys_no_header_key": "키 파일에 header_key가 없습니다. 본체에서 prod.keys를 다시 덤프하세요.",
"check.keys_wrong": "키로 {input} 파일을 열 수 없습니다. 본인 본체의 prod.keys를 사용하세요.",
"check.keys_too_old": "키 파일이 {input} 파일에 비해 너무 오래되었습니다(키 세대 {generation} 필요). 더 새로운 펌웨어의 본체에서 prod.keys를 덤프하세요.",
"check.not_game_file": "{input} 파일은 XCI, NSP, XCZ 또는 NSZ 게임 파일이 아닙니다.",
"check.file_unreadable": "{input} 파일을 읽을 수 없습니다: {detail}",
"check.unpack_failed": "압축 파일 {input}의 압축을 풀 수 없습니다: {detail}",
"check.ticket_personalized": "{input} 파일에 개인화된 티켓이 들어 있습니다. 공통 티켓이 필요합니다.",
"check.ticket_missing": "{input} 파일에 콘텐츠에 필요한 티켓이 없습니다.",
"check.base_not_totk": "기본 게임 파일이 젤다의 전설 티어스 오브 더 킹덤이 아닙니다({detail}).",
"check.base_is_update": "기본 게임 파일이 업데이트입니다. 여기에는 기본 게임 NSP 또는 XCI(버전 1.0.0)를 선택하고 이 파일은 업데이트로 선택하세요.",
"check.base_combined": "기본 게임 파일에 여러 패키지(기본 게임, 업데이트 또는 DLC가 한 파일에)가 들어 있습니다. 게임만 들어 있는 기본 게임 덤프를 선택하세요.",
"check.update_not_nsp": "업데이트는 NSP 또는 NSZ 파일이어야 합니다.",
"check.update_is_base": "업데이트 파일에 기본 게임이 들어 있습니다. 1.1.0 또는 1.2.1 또는 1.4.3 업데이트 NSP를 선택하세요.",
"check.update_not_totk": "업데이트 파일이 티어스 오브 더 킹덤 업데이트가 아닙니다({detail}).",
"check.exefs_failed": "{input} 파일의 게임 코드가 검사를 통과하지 못했습니다. {log}을(를) 참조하세요.",
"check.input_damaged": "{input} 파일이 손상되었거나 불완전합니다: {path}({detail}). 원본에서 파일을 다시 복사하거나 다시 덤프한 다음 설치를 다시 실행하세요.",
"check.base_wrong_version": "기본 게임이 버전 1.0.0이 아닙니다({modules} 다름).",
"check.update_wrong_version": "업데이트 버전은 {found}입니다. 이 릴리스는 {wanted}을(를) 사용합니다.",
"check.disk_space": "{path}의 여유 공간이 부족합니다. {need_gb} GB 필요, {free_gb} GB 사용 가능.",
"check.firmware_missing": "펌웨어 폴더 {path}이(가) 없습니다. 펌웨어의 Contents/registered 폴더를 선택하세요.",
"check.firmware_empty": "펌웨어 폴더 {path}에 NCA 파일이 없습니다. 펌웨어의 Contents/registered 폴더를 선택하세요.",
"check.fonts_keys_needed": "이 언어의 공유 글꼴이 아직 설치되지 않았습니다. 설치 프로그램이 펌웨어에서 추출할 수 있도록 prod.keys를 선택하세요.",
"extract.exefs_mismatch": "추출한 게임 코드가 버전 {version}과(와) 일치하지 않습니다({modules}).",
"extract.romfs_merge_failed": "게임 데이터에 업데이트를 적용하지 못했습니다: {detail}. 자세히: {log}",
"extract.romfs_mismatch": "추출한 게임 데이터가 버전 {version}과(와) 일치하지 않습니다(크기 {size}, 체크섬 {sha256}...).",
"fonts.failed": "공유 글꼴 추출에 실패했습니다(종료 코드 {code}): {detail}. 자세히: {log}",
"fonts.incomplete": "공유 글꼴 추출에서 일부 파일이 작성되지 않았습니다({files}).",
"fonts.copy_failed": "공유 글꼴을 {path}(으)로 복사할 수 없습니다: {detail}",
"lift.failed": "게임 코드 변환에 실패했습니다(종료 코드 {code}). 자세히: {log}",
"compile.failed": "{game_exe} 컴파일에 실패했습니다(종료 코드 {code}). 자세히: {log}",
"compile.exe_in_use": "{path}이(가) 사용 중입니다. 게임을 닫고 설치 프로그램을 다시 실행하세요.",
"kit.in_use": "{path}이(가) 사용 중입니다. 게임과 열려 있는 설치 또는 다시 빌드 창을 모두 닫은 다음 설치 프로그램을 다시 실행하세요.",
"kit.copy_failed": "빌드 키트를 {path}에 복사할 수 없습니다: {detail}",
"compile.exe_locked": "{path}에 쓸 수 없습니다. 다른 프로그램이 파일을 사용하고 있습니다(그 폴더에서 실행한 게임 또는 파일을 감지한 백신 프로그램). 게임을 닫고, 설치 프로그램 폴더와 설치 폴더를 백신 프로그램의 예외 목록에 추가한 다음 Windows를 다시 시작하고 설치 프로그램을 다시 실행하세요. 자세히: {log}",
"prepare.xlate_in_use": "{path}이(가) 사용 중입니다. 게임을 닫고 이전 실행에서 남은 totk_xlate 프로세스를 종료한 다음 설치 프로그램을 다시 실행하세요.",
"prepare.shader_list_missing": "셰이더 목록이 없습니다.",
"prepare.romfs_patches_failed": "게임 데이터 패치 작성에 실패했습니다(종료 코드 {code}). 자세히: {log}",
"prepare.shaders_failed": "셰이더 준비에 실패했습니다(종료 코드 {code}). 자세히: {log}",
"cleanup.romfs_unreadable": "설치 후 {path}의 게임 데이터가 없거나 읽을 수 없습니다. Windows를 다시 시작한 다음 같은 폴더로 설치 프로그램을 다시 실행하세요. 게임 데이터만 다시 추출하고 나머지는 유지합니다.",
"prepare.pack_failed": "셰이더 캐시 묶기에 실패했습니다(종료 코드 {code}). 자세히: {log}",
"cleanup.ini_failed": "totk.ini를 쓸 수 없습니다: {detail}",
"warn.lang_needs_fonts": "{lang} 텍스트에는 Switch 시스템 글꼴이 필요하지만 지정되지 않았습니다. 글꼴을 추가할 때까지 이 언어로는 게임이 시작되지 않습니다. 펌웨어 폴더(Contents/registered)를 선택하거나 docs/installer.md의 \"Switch system fonts\"를 참조하세요.",
"warn.npdm_differs": "main.npdm이 참조용 {version} 덤프와 다릅니다. 코드 모듈만 사용합니다.",
"warn.cheats_skipped": "mods 폴더에서 게임 코드를 바꾸는 치트를 빌드할 수 없었습니다. 치트 없이 게임을 설치합니다. 자세히: {log}",
"warn.exefs_skipped": "모드의 ExeFS 패치(.ips, .pchtxt)를 빌드할 수 없었습니다. 패치 없이 게임을 설치합니다. 자세히: {log}",
"warn.plugins_skipped": "모드의 코드 플러그인(exefs subsdk)을 빌드할 수 없었습니다. 게임은 플러그인 없이 설치됩니다. 자세히: {log}",
"warn.xbox_prompts_failed": "Xbox, PlayStation 또는 PC 버튼 표시를 준비할 수 없었습니다(종료 코드 {code}). 게임은 Switch 버튼 표시를 유지합니다. 자세히: {log}",
"warn.shaders_skipped": "일부 셰이더를 빌드하는 동안 그래픽 드라이버가 충돌하여 {count}개를 준비에서 제외했습니다. 게임은 처음 필요할 때 이를 빌드하며, 그때도 드라이버가 충돌할 수 있습니다. 드라이버를 업데이트하면 해결될 수 있습니다. 자세히: {log}",
"warn.kernel_old": "Linux {version}에는 게임이 사용하는 쓰기 추적(6.7 이상)이 없습니다. 게임이 매우 느릴 수 있습니다. 시스템을 업데이트하면 해결됩니다.",
"warn.dlss_kept": "설치 폴더에 이미 DLSS 라이브러리가 있습니다({path}). 설치 프로그램은 그대로 둡니다.",
"warn.dlss_download_failed": "{url}에서 NVIDIA DLSS를 다운로드할 수 없습니다: {detail}. 게임은 없이도 실행되며, 다음 설치 실행 때 다시 시도합니다.",
"ui.title": "TotK 설치",
"ui.rebuild_title": "모드에 맞게 게임을 다시 빌드하는 중",
"ui.start_game": "게임 시작",
"ui.version": "버전 {version}",
"ui.intro": "보유한 게임 파일로 플레이 가능한 티어스 오브 더 킹덤 폴더를 만듭니다. 시간이 걸리며 한 번만 실행됩니다.",
"ui.notice": "이 설치 프로그램이 만드는 폴더에는 게임이 들어 있습니다. 개인 용도로만 사용하고 공유하거나 업로드하지 마세요.",
"ui.keys_private": "키 파일은 그 자리에서 읽습니다. 내용은 표시, 복사, 저장되지 않습니다.",
"ui.base": "기본 게임",
"ui.update": "업데이트",
"ui.keys": "prod.keys",
"ui.firmware": "펌웨어(선택 사항)",
"ui.game_language": "게임 언어",
"ui.dest": "설치 폴더",
"ui.browse": "찾아보기...",
"ui.pick_game": "기본 게임 파일 선택",
"ui.pick_update": "1.1.0 또는 1.2.1 또는 1.4.3 업데이트 파일 선택",
"ui.pick_keys": "prod.keys 선택",
"ui.pick_firmware": "Switch 펌웨어 폴더 선택(Contents/registered)",
"ui.pick_dest": "설치 폴더 선택",
"ui.firmware_help": "중국어, 한국어, 번체 중국어 텍스트용: 펌웨어의 Contents/registered 폴더(예: Ryujinx 또는 Yuzu의 폴더). 설치 프로그램이 여기에서 Switch 시스템 글꼴을 설치 폴더로 복사합니다.",
"ui.dlss": "NVIDIA RTX 그래픽 카드용 NVIDIA DLSS (nvngx_dlss.dll) 다운로드",
"ui.dlss_help": "GitHub의 NVIDIA DLSS SDK에서, NVIDIA RTX SDK 라이선스에 따라 받습니다(github.com/NVIDIA/DLSS). 이 파일이 있어야 dlaa 및 DLSS 설정이 작동하며, 없으면 아무 효과가 없습니다.",
"ui.compressed_help": "압축된 NSZ 및 XCZ 파일은 그대로 사용할 수 있습니다. 설치 프로그램이 직접 압축을 풉니다(게임 데이터를 추출할 때까지 압축을 푼 파일만큼의 여유 공간이 필요합니다).",
"ui.section_files": "게임 파일",
"ui.section_install": "설치",
"ui.more_details": "▸ 자세히 보기",
"ui.fewer_details": "▾ 자세히 숨기기",
"ui.formats_help": "기본 게임: NSP, XCI, NSZ 또는 XCZ. 업데이트: 1.1.0, 1.2.1 또는 1.4.3(NSP 또는 NSZ).",
"ui.type_game": "게임 파일(NSP, XCI, NSZ, XCZ)",
"ui.type_keys": "키 파일(*.keys)",
"ui.type_all": "모든 파일",
"ui.start": "시작",
"ui.cancel": "취소",
"ui.cancelling": "취소하는 중...",
"ui.show_log": "로그 보기",
"ui.hide_log": "로그 숨기기",
"ui.close": "닫기",
"ui.back": "뒤로",
"ui.open_folder": "폴더 열기",
"ui.update_mode": "이 폴더에 이전 설치가 있습니다. 설치 프로그램이 이를 이어서 진행하거나 업데이트합니다. 게임 파일은 다시 필요한 경우에만 요청합니다.",
"ui.need_dest": "설치 폴더를 선택하세요.",
"ui.need_base": "기본 게임 파일을 선택하세요.",
"ui.need_update": "1.1.0 또는 1.2.1 또는 1.4.3 업데이트 파일을 선택하세요.",
"ui.need_keys": "prod.keys 파일을 선택하세요.",
"ui.need_lang": "게임 언어를 선택하세요.",
"ui.missing_base": "기본 게임 파일이 없습니다.",
"ui.missing_update": "업데이트 파일이 없습니다.",
"ui.missing_keys": "키 파일이 없습니다.",
"ui.missing_firmware": "펌웨어 폴더가 없습니다.",
"ui.running_install": "설치 중",
"ui.running_resume": "이전 설치를 이어서 진행하는 중",
"ui.running_update": "설치를 업데이트하는 중",
"ui.state_started": "시작됨",
"ui.state_done": "완료",
"ui.state_skipped": "건너뜀",
"ui.state_pending": "대기 중",
"ui.state_running": "실행 중",
"ui.state_failed": "실패",
"ui.log_warning": "경고",
"ui.log_error": "오류",
"ui.log_space": "필요한 공간: {need} GB, 여유: {free} GB",
"ui.log_end": "끝남",
"ui.result_ok": "게임이 준비되었습니다",
"ui.result_failed": "설치에 실패했습니다",
"ui.result_cancelled": "설치가 취소되었습니다",
"ui.done_text": "{dest}에서 {game_exe}을(를) 실행하세요. 설치 프로그램과 선택한 게임 파일은 더 이상 필요하지 않습니다.",
"ui.cancelled_text": "완료된 단계는 유지됩니다. 계속하려면 같은 폴더로 설치를 다시 시작하세요.",
"ui.log_file": "로그 파일: {path}",
"ui.process_died": "설치가 예기치 않게 중지되었습니다(종료 코드 {code}).",
"ui.confirm_cancel": "설치가 실행 중입니다. 취소하고 창을 닫을까요?",
"ui.space_one": "{path}에 필요한 여유 공간: {need} GB(여유: {free} GB).",
"ui.space_two": "{path}에 필요한 여유 공간: {need} GB(여유: {free} GB), {temp}: {temp_need} GB(여유: {temp_free} GB).",
"ui.amount_bytes": "{done} / {total} GB",
"ui.amount_chunks": "{done} / {total} 부분",
"ui.amount_objects": "{done} / {total} 파일",
"ui.amount_shaders": "{done} / {total} 셰이더",
"ui.amount_other": "{done} / {total} {unit}",
"ui.seconds": "{n}초",
"param.input.base": "기본 게임",
"param.input.update": "업데이트",
"param.input.keys": "키",
"launcher.title": "TotK 설치",
"launcher.python_missing": "설치 파일이 불완전합니다. TotK-Setup.exe 옆의 python 폴더가 없습니다. 전체 압축 파일을 다시 풀고 압축을 푼 폴더에서 TotK-Setup.exe를 실행하세요.",
"lang.ja": "일본어",
"lang.en-US": "영어(미국)",
"lang.en-GB": "영어(영국)",
"lang.fr": "프랑스어",
"lang.fr-CA": "프랑스어(캐나다)",
"lang.de": "독일어",
"lang.it": "이탈리아어",
"lang.es": "스페인어",
"lang.es-419": "스페인어(중남미)",
"lang.nl": "네덜란드어",
"lang.pt": "포르투갈어",
"lang.pt-BR": "포르투갈어(브라질)",
"lang.ru": "러시아어",
"lang.ko": "한국어",
"lang.zh-Hans": "중국어(간체)",
"lang.zh-Hant": "중국어(번체)"
}
+215
View File
@@ -0,0 +1,215 @@
{
"step.check": "Computer en spelbestanden controleren",
"step.kit": "De bouwkit naar de spelmap kopiëren",
"step.fonts": "Systeemlettertypen uitpakken",
"step.extract": "Spel uitpakken",
"step.lift": "Spelcode naar C vertalen",
"step.compile": "{game_exe} compileren",
"step.prepare": "Shaders voorbereiden",
"step.pc_prompts": "Toetsenbord- en muispictogrammen tekenen",
"step.shapes": "De spelschermen voor je beeldschermen indelen",
"step.dlss": "NVIDIA DLSS downloaden",
"step.cleanup": "Opruimen",
"phase.check.host": "Processor en videokaart controleren",
"phase.check.verify": "Al geïnstalleerde bestanden controleren",
"phase.check.verify_romfs": "Geïnstalleerde spelgegevens controleren",
"phase.check.inputs": "Spelbestanden openen met de sleutels",
"phase.check.unpack_base": "Gecomprimeerd basisspel uitpakken",
"phase.check.unpack_update": "Gecomprimeerde update uitpakken",
"phase.check.versions": "Spelversies controleren",
"phase.kit.copy": "De hulpmiddelen kopiëren waarmee het spel zichzelf opnieuw bouwt voor codemods",
"phase.fonts.extract": "Gedeelde lettertypen uit de firmware uitpakken",
"phase.fonts.copy": "Gedeelde lettertypen naar de installatiemap kopiëren",
"phase.extract.hash_base": "Controlesom van het basisspel berekenen",
"phase.extract.hash_update": "Controlesom van de update berekenen",
"phase.extract.exefs": "Spelcode uitpakken",
"phase.extract.copy": "Spelgegevens kopiëren",
"phase.extract.merge": "Update op de spelgegevens toepassen",
"phase.extract.diagnose": "Beschadigd spelbestand zoeken",
"phase.extract.index": "Spelgegevens verifiëren",
"phase.lift.discover": "Functies zoeken",
"phase.lift.emit": "C-code schrijven",
"phase.compile.compile": "Compileren",
"phase.compile.link": "{game_exe} linken",
"phase.prepare.romfs_patches": "Spelgegevenspatches voor 60 fps schrijven",
"phase.pc_prompts.draw": "Toets- en muisknoppictogrammen tekenen volgens de toewijzingen in totk.ini",
"phase.prepare.seed": "Shaders uit de spelgegevens lezen",
"phase.prepare.translate": "Shaders vertalen",
"phase.prepare.libraries": "Shaders voor het grafische stuurprogramma bouwen",
"phase.prepare.pack": "Shadercache in één bestand verpakken",
"phase.shapes.layouts": "Schermindelingen en knoppictogrammen voor elke schermvorm schrijven",
"phase.dlss.download": "nvngx_dlss.dll downloaden uit NVIDIA's DLSS SDK",
"phase.cleanup.ini": "totk.ini schrijven",
"phase.cleanup.temp": "Tijdelijke bestanden verwijderen",
"cli.usage": "Ongeldige opdrachtregel: {detail}",
"internal": "Onverwachte fout ({exception}): {detail}",
"state.unreadable": "{path} kan niet worden gelezen. Kies een andere map of verwijder dat bestand.",
"state.newer_format": "{path} is geschreven door een nieuwer installatieprogramma. Gebruik dat programma of een andere map.",
"state.output_changed": "Geïnstalleerde bestanden van stap '{step}' zijn gewijzigd sinds ze zijn gemaakt; die stap wordt opnieuw uitgevoerd.",
"check.release_incomplete": "De map van het installatieprogramma is onvolledig; ontbreekt: {paths}. Pak de release opnieuw uit.",
"check.dest_not_folder": "De installatielocatie {path} is een bestand, geen map.",
"check.dest_not_empty": "De installatiemap {path} is niet leeg en bevat geen eerdere installatie. Kies een lege map.",
"check.lang_missing": "Kies de taal van het spel.",
"check.lang_unknown": "Onbekende taal '{lang}'. Bekend: {known}.",
"check.toolchain_broken": "De meegeleverde compiler werkt niet: {detail}",
"check.glibc_old": "De C-bibliotheek van dit systeem is glibc {version}; de compiler van de installatie heeft {need} of nieuwer nodig (Ubuntu 22.04, Debian 12, Fedora 35, SteamOS 3 en nieuwer hebben die). Het systeem bijwerken lost dit op.",
"check.host_probe_failed": "De computercontrole is niet uitgevoerd (afsluitcode {code}).",
"check.cpu_too_old": "Deze processor mist x86-64-v2 (SSE4.2, POPCNT en CMPXCHG16B), het oudste niveau waarvoor het spel wordt gebouwd. Intel Nehalem (2008) of AMD Bulldozer (2011) en nieuwer hebben het.",
"check.vulkan_missing": "Er is geen Vulkan-stuurprogramma geïnstalleerd. Installeer het nieuwste stuurprogramma voor je videokaart.",
"check.vulkan_no_device": "Vulkan vindt geen videokaart. Installeer het nieuwste stuurprogramma voor je videokaart.",
"check.vulkan_too_old": "Het spel heeft een videokaart met Vulkan 1.3 nodig; gevonden: {devices}. Werk het grafische stuurprogramma bij.",
"check.no_display": "Voor het voorbereiden van de shaders is een scherm nodig. Start de installatie vanuit de bureaubladsessie of exporteer DISPLAY=:0 (op een Steam Deck in de Gamemodus ook XDG_RUNTIME_DIR=/run/user/1000).",
"check.inputs_needed": "De spelbestanden zijn nodig: kies het basisspel, de update 1.1.0, 1.2.1 of 1.4.3 en prod.keys.",
"check.input_missing": "Bestand niet gevonden ({input}): {path}",
"check.keys_unreadable": "Het sleutelbestand kan niet worden gelezen. Kies een prod.keys-bestand.",
"check.keys_no_header_key": "Het sleutelbestand heeft geen header_key. Lees prod.keys opnieuw uit je console uit.",
"check.keys_wrong": "De sleutels kunnen het bestand ({input}) niet openen. Gebruik de prod.keys van je console.",
"check.keys_too_old": "Het sleutelbestand is te oud voor het bestand ({input}) (sleutelgeneratie {generation} nodig). Lees prod.keys uit een console met nieuwere firmware.",
"check.not_game_file": "Het bestand ({input}) is geen XCI-, NSP-, XCZ- of NSZ-spelbestand.",
"check.file_unreadable": "Het bestand ({input}) kan niet worden gelezen: {detail}",
"check.unpack_failed": "Het gecomprimeerde bestand {input} kon niet worden uitgepakt: {detail}",
"check.ticket_personalized": "Het bestand ({input}) bevat een gepersonaliseerd ticket; een algemeen ticket is nodig.",
"check.ticket_missing": "Het bestand ({input}) mist het ticket dat de inhoud nodig heeft.",
"check.base_not_totk": "Het basisspelbestand is niet The Legend of Zelda: Tears of the Kingdom ({detail}).",
"check.base_is_update": "Het basisspelbestand is een update. Kies hier het basisspel als NSP of XCI (versie 1.0.0) en dit bestand als update.",
"check.base_combined": "Het basisspelbestand bevat meerdere pakketten (basisspel, update of DLC in één bestand). Kies een dump van het basisspel die alleen het spel bevat.",
"check.update_not_nsp": "De update moet een NSP- of NSZ-bestand zijn.",
"check.update_is_base": "Het updatebestand bevat een basisspel. Kies de NSP van update 1.1.0, 1.2.1 of 1.4.3.",
"check.update_not_totk": "Het updatebestand is geen update van Tears of the Kingdom ({detail}).",
"check.exefs_failed": "De spelcode van het bestand ({input}) heeft de controles niet doorstaan; zie {log}.",
"check.input_damaged": "Het bestand ({input}) is beschadigd of onvolledig: {path} ({detail}). Kopieer dat bestand opnieuw vanaf de bron of maak de dump opnieuw en voer de installatie dan opnieuw uit.",
"check.base_wrong_version": "Het basisspel is niet versie 1.0.0 ({modules} wijken af).",
"check.update_wrong_version": "De update is versie {found}; deze release gebruikt {wanted}.",
"check.disk_space": "Niet genoeg vrije ruimte voor {path}: {need_gb} GB nodig, {free_gb} GB vrij.",
"check.firmware_missing": "De firmwaremap {path} bestaat niet. Kies de map Contents/registered van de firmware.",
"check.firmware_empty": "De firmwaremap {path} bevat geen NCA-bestanden. Kies de map Contents/registered van de firmware.",
"check.fonts_keys_needed": "De gedeelde lettertypen voor deze taal zijn nog niet geïnstalleerd; kies prod.keys zodat de installatie ze uit de firmware kan uitpakken.",
"extract.exefs_mismatch": "De uitgepakte spelcode komt niet overeen met versie {version} ({modules}).",
"extract.romfs_merge_failed": "Het toepassen van de update op de spelgegevens is mislukt: {detail}. Details: {log}",
"extract.romfs_mismatch": "De uitgepakte spelgegevens komen niet overeen met versie {version} (grootte {size}, controlesom {sha256}...).",
"fonts.failed": "Het uitpakken van de gedeelde lettertypen is mislukt (afsluitcode {code}): {detail}. Details: {log}",
"fonts.incomplete": "Het uitpakken van de gedeelde lettertypen heeft niet elk bestand geschreven ({files}).",
"fonts.copy_failed": "De gedeelde lettertypen kunnen niet naar {path} worden gekopieerd: {detail}",
"lift.failed": "Het vertalen van de spelcode is mislukt (afsluitcode {code}). Details: {log}",
"compile.failed": "Het compileren van {game_exe} is mislukt (afsluitcode {code}). Details: {log}",
"compile.exe_in_use": "{path} is in gebruik. Sluit het spel en voer het installatieprogramma opnieuw uit.",
"kit.in_use": "{path} is in gebruik. Sluit het spel en elk geopend installatie- of herbouwvenster en start de installatie daarna opnieuw.",
"kit.copy_failed": "De bouwkit kan niet naar {path} worden gekopieerd: {detail}",
"compile.exe_locked": "{path} kan niet worden geschreven: een ander programma houdt het vast, een spel dat vanuit die map is gestart of een virusscanner die het bestand heeft gemarkeerd. Sluit het spel, voeg de map van de installatie en de installatiemap toe aan de uitzonderingen van de virusscanner, start Windows opnieuw en start de installatie daarna opnieuw. Details: {log}",
"prepare.xlate_in_use": "{path} is in gebruik. Sluit het spel, beëindig elk totk_xlate-proces dat van een eerdere uitvoering over is en voer het installatieprogramma opnieuw uit.",
"prepare.shader_list_missing": "De shaderlijst ontbreekt.",
"prepare.romfs_patches_failed": "Het schrijven van de spelgegevenspatches is mislukt (afsluitcode {code}). Details: {log}",
"prepare.shaders_failed": "Het voorbereiden van de shaders is mislukt (afsluitcode {code}). Details: {log}",
"cleanup.romfs_unreadable": "De spelgegevens in {path} ontbreken of kunnen na de installatie niet worden gelezen. Start Windows opnieuw en voer het installatieprogramma opnieuw uit op dezelfde map: het pakt de spelgegevens opnieuw uit en behoudt de rest.",
"prepare.pack_failed": "Het verpakken van de shadercache is mislukt (afsluitcode {code}). Details: {log}",
"cleanup.ini_failed": "totk.ini kan niet worden geschreven: {detail}",
"warn.lang_needs_fonts": "Tekst in het {lang} heeft de systeemlettertypen van de Switch nodig, en die zijn niet opgegeven. Het spel start niet in deze taal totdat ze zijn toegevoegd. Kies de firmwaremap (Contents/registered) of zie \"Switch system fonts\" in docs/installer.md.",
"warn.npdm_differs": "main.npdm wijkt af van de referentiedump {version}; alleen de codemodules worden gebruikt.",
"warn.cheats_skipped": "De cheats uit de modsmap die de spelcode wijzigen konden niet worden gebouwd; het spel wordt zonder ze geïnstalleerd. Details: {log}",
"warn.exefs_skipped": "De ExeFS-patches van de mods (.ips, .pchtxt) konden niet worden gebouwd; het spel wordt zonder ze geïnstalleerd. Details: {log}",
"warn.plugins_skipped": "De codeplug-ins van de mods (exefs subsdk) konden niet worden gebouwd; het spel wordt zonder ze geïnstalleerd. Details: {log}",
"warn.xbox_prompts_failed": "De Xbox-, PlayStation- of pc-knoppictogrammen konden niet worden voorbereid (afsluitcode {code}); het spel houdt de Switch-pictogrammen. Details: {log}",
"warn.shaders_skipped": "Het grafische stuurprogramma is gecrasht bij het bouwen van enkele shaders, dus {count} zijn uit de voorbereiding weggelaten. Het spel bouwt ze wanneer het ze voor het eerst nodig heeft, en het stuurprogramma kan daar ook crashen; een update van het stuurprogramma kan dit oplossen. Details: {log}",
"warn.kernel_old": "Linux {version} mist de schrijftracering waar het spel op rekent (6.7 of nieuwer); het spel kan erg traag zijn. Het systeem bijwerken lost dit op.",
"warn.dlss_kept": "Er staat al een DLSS-bibliotheek in de installatiemap ({path}); de installatie laat die staan.",
"warn.dlss_download_failed": "NVIDIA DLSS kon niet worden gedownload van {url}: {detail}. Het spel werkt zonder; de volgende installatieronde probeert het opnieuw.",
"ui.title": "TotK-installatie",
"ui.rebuild_title": "Spel opnieuw bouwen voor je mods",
"ui.start_game": "Spel starten",
"ui.version": "versie {version}",
"ui.intro": "Bouwt een speelbare map van Tears of the Kingdom uit je eigen spelbestanden. Dit duurt even en gebeurt één keer.",
"ui.notice": "De map die deze installatie bouwt bevat het spel. Die is alleen voor eigen gebruik; deel of upload hem niet.",
"ui.keys_private": "Het sleutelbestand wordt ter plaatse gelezen. De inhoud wordt nooit getoond, gekopieerd of opgeslagen.",
"ui.base": "Basisspel",
"ui.update": "Update",
"ui.keys": "prod.keys",
"ui.firmware": "Firmware (optioneel)",
"ui.game_language": "Taal van het spel",
"ui.dest": "Installatiemap",
"ui.browse": "Bladeren...",
"ui.pick_game": "Kies het basisspelbestand",
"ui.pick_update": "Kies het bestand van update 1.1.0, 1.2.1 of 1.4.3",
"ui.pick_keys": "Kies prod.keys",
"ui.pick_firmware": "Kies de map van de Switch-firmware (Contents/registered)",
"ui.pick_dest": "Kies de installatiemap",
"ui.firmware_help": "Voor Chinese, Koreaanse en traditioneel Chinese tekst: de map Contents/registered van de firmware, bijvoorbeeld uit Ryujinx of Yuzu. De installatie kopieert daaruit de systeemlettertypen van de Switch naar de installatiemap.",
"ui.dlss": "NVIDIA DLSS (nvngx_dlss.dll) downloaden voor NVIDIA RTX-videokaarten",
"ui.dlss_help": "Uit NVIDIA's DLSS SDK op GitHub, onder NVIDIA's RTX SDK-licentie (github.com/NVIDIA/DLSS). Hiermee werken de instellingen dlaa en DLSS; zonder doen ze niets.",
"ui.compressed_help": "Gecomprimeerde NSZ- en XCZ-bestanden werken zoals ze zijn: de installatie pakt ze zelf uit (tot de spelgegevens zijn uitgepakt, is daarvoor evenveel vrije ruimte nodig als de uitgepakte bestanden innemen).",
"ui.section_files": "Spelbestanden",
"ui.section_install": "Installatie",
"ui.more_details": "▸ Meer details",
"ui.fewer_details": "▾ Details verbergen",
"ui.formats_help": "Basisspel: NSP, XCI, NSZ of XCZ. Update: 1.1.0, 1.2.1 of 1.4.3, als NSP of NSZ.",
"ui.type_game": "Spelbestanden (NSP, XCI, NSZ, XCZ)",
"ui.type_keys": "Sleutelbestanden (*.keys)",
"ui.type_all": "Alle bestanden",
"ui.start": "Starten",
"ui.cancel": "Annuleren",
"ui.cancelling": "Annuleren...",
"ui.show_log": "Logboek tonen",
"ui.hide_log": "Logboek verbergen",
"ui.close": "Sluiten",
"ui.back": "Terug",
"ui.open_folder": "Map openen",
"ui.update_mode": "Deze map bevat een eerdere installatie. De installatie zet die voort of werkt die bij; de spelbestanden worden alleen gevraagd als ze opnieuw nodig zijn.",
"ui.need_dest": "Kies de installatiemap.",
"ui.need_base": "Kies het basisspelbestand.",
"ui.need_update": "Kies het bestand van update 1.1.0, 1.2.1 of 1.4.3.",
"ui.need_keys": "Kies het bestand prod.keys.",
"ui.need_lang": "Kies de taal van het spel.",
"ui.missing_base": "Het basisspelbestand bestaat niet.",
"ui.missing_update": "Het updatebestand bestaat niet.",
"ui.missing_keys": "Het sleutelbestand bestaat niet.",
"ui.missing_firmware": "De firmwaremap bestaat niet.",
"ui.running_install": "Installeren",
"ui.running_resume": "Eerdere installatie voortzetten",
"ui.running_update": "Installatie bijwerken",
"ui.state_started": "gestart",
"ui.state_done": "klaar",
"ui.state_skipped": "overgeslagen",
"ui.state_pending": "wacht",
"ui.state_running": "bezig",
"ui.state_failed": "mislukt",
"ui.log_warning": "Waarschuwing",
"ui.log_error": "Fout",
"ui.log_space": "Benodigde ruimte: {need} GB, vrij: {free} GB",
"ui.log_end": "Klaar",
"ui.result_ok": "Het spel is klaar",
"ui.result_failed": "De installatie is mislukt",
"ui.result_cancelled": "De installatie is geannuleerd",
"ui.done_text": "Start {game_exe} vanuit {dest}. Het installatieprogramma en de gekozen spelbestanden zijn niet meer nodig.",
"ui.cancelled_text": "De voltooide stappen blijven bewaard. Start de installatie opnieuw met dezelfde map om verder te gaan.",
"ui.log_file": "Logbestand: {path}",
"ui.process_died": "De installatie is onverwacht gestopt (afsluitcode {code}).",
"ui.confirm_cancel": "De installatie is bezig. Annuleren en het venster sluiten?",
"ui.space_one": "Benodigde vrije ruimte op {path}: {need} GB (vrij: {free} GB).",
"ui.space_two": "Benodigde vrije ruimte op {path}: {need} GB (vrij: {free} GB); op {temp}: {temp_need} GB (vrij: {temp_free} GB).",
"ui.amount_bytes": "{done} / {total} GB",
"ui.amount_chunks": "{done} / {total} delen",
"ui.amount_objects": "{done} / {total} bestanden",
"ui.amount_shaders": "{done} / {total} shaders",
"ui.amount_other": "{done} / {total} {unit}",
"ui.seconds": "{n} s",
"param.input.base": "basisspel",
"param.input.update": "update",
"param.input.keys": "sleutels",
"launcher.title": "TotK-installatie",
"launcher.python_missing": "De installatiebestanden zijn onvolledig: de map python naast TotK-Setup.exe ontbreekt. Pak het hele archief opnieuw uit en start TotK-Setup.exe vanuit de uitgepakte map.",
"lang.ja": "Japans",
"lang.en-US": "Engels (VS)",
"lang.en-GB": "Engels (VK)",
"lang.fr": "Frans",
"lang.fr-CA": "Frans (Canada)",
"lang.de": "Duits",
"lang.it": "Italiaans",
"lang.es": "Spaans",
"lang.es-419": "Spaans (Latijns-Amerika)",
"lang.nl": "Nederlands",
"lang.pt": "Portugees",
"lang.pt-BR": "Portugees (Brazilië)",
"lang.ru": "Russisch",
"lang.ko": "Koreaans",
"lang.zh-Hans": "Chinees (vereenvoudigd)",
"lang.zh-Hant": "Chinees (traditioneel)"
}
+19 -4
View File
@@ -1,10 +1,13 @@
{
"step.check": "Verificando o computador e os arquivos do jogo",
"step.kit": "Copiando o kit de compilação para a pasta do jogo",
"step.fonts": "Extraindo as fontes do sistema",
"step.extract": "Extraindo o jogo",
"step.lift": "Traduzindo o código do jogo para C",
"step.compile": "Compilando o {game_exe}",
"step.prepare": "Preparando os shaders",
"step.pc_prompts": "Desenhando os ícones de teclado e mouse",
"step.shapes": "Ajustando as telas do jogo aos seus monitores",
"step.dlss": "Baixando o NVIDIA DLSS",
"step.cleanup": "Finalizando",
@@ -15,6 +18,7 @@
"phase.check.unpack_base": "Descompactando o jogo base compactado",
"phase.check.unpack_update": "Descompactando a atualização compactada",
"phase.check.versions": "Verificando as versões do jogo",
"phase.kit.copy": "Copiando as ferramentas com que o jogo se recompila para mods de código",
"phase.fonts.extract": "Extraindo as fontes compartilhadas do firmware",
"phase.fonts.copy": "Copiando as fontes compartilhadas para a pasta de instalação",
"phase.extract.hash_base": "Calculando o checksum do jogo base",
@@ -29,10 +33,12 @@
"phase.compile.compile": "Compilando",
"phase.compile.link": "Ligando o {game_exe}",
"phase.prepare.romfs_patches": "Gravando os patches de 60 fps nos dados do jogo",
"phase.pc_prompts.draw": "Desenhando os ícones de teclas e botões do mouse a partir das atribuições do totk.ini",
"phase.prepare.seed": "Lendo os shaders dos dados do jogo",
"phase.prepare.translate": "Traduzindo os shaders",
"phase.prepare.libraries": "Montando os shaders para o driver de vídeo",
"phase.prepare.pack": "Juntando o cache de shaders num único arquivo",
"phase.shapes.layouts": "Gravando os layouts de tela e os botões para cada formato de monitor",
"phase.dlss.download": "Baixando o nvngx_dlss.dll do DLSS SDK da NVIDIA",
"phase.cleanup.ini": "Gravando o totk.ini",
"phase.cleanup.temp": "Removendo os arquivos temporários",
@@ -91,6 +97,9 @@
"lift.failed": "Falha ao traduzir o código do jogo (código de saída {code}). Detalhes: {log}",
"compile.failed": "Falha ao compilar o {game_exe} (código de saída {code}). Detalhes: {log}",
"compile.exe_in_use": "{path} está em uso. Feche o jogo e execute o instalador de novo.",
"kit.in_use": "{path} está em uso. Feche o jogo e qualquer janela de instalação ou recompilação aberta, depois execute o instalador de novo.",
"kit.copy_failed": "Não foi possível copiar o kit de compilação para {path}: {detail}",
"compile.exe_locked": "Não é possível gravar {path}: outro programa o está usando, um jogo aberto dessa pasta ou um antivírus que marcou o arquivo. Feche o jogo, adicione a pasta do instalador e a pasta de instalação às exceções do antivírus, reinicie o Windows e execute o instalador de novo. Detalhes: {log}",
"prepare.xlate_in_use": "{path} está em uso. Feche o jogo, encerre qualquer processo totk_xlate que tenha sobrado de uma execução anterior e execute o instalador de novo.",
"prepare.shader_list_missing": "A lista de shaders está faltando.",
"prepare.romfs_patches_failed": "Falha ao gravar os patches nos dados do jogo (código de saída {code}). Detalhes: {log}",
@@ -102,8 +111,9 @@
"warn.lang_needs_fonts": "Textos em {lang} precisam das fontes de sistema do Switch, e nenhuma foi informada. O jogo não inicia neste idioma até que sejam adicionadas. Escolha a pasta do firmware (Contents/registered) ou veja \"Switch system fonts\" em docs/installer.md.",
"warn.cheats_skipped": "Não foi possível compilar os cheats da pasta de mods que alteram o código do jogo; o jogo é instalado sem eles. Detalhes: {log}",
"warn.exefs_skipped": "Não foi possível compilar os patches ExeFS dos mods (.ips, .pchtxt); o jogo é instalado sem eles. Detalhes: {log}",
"warn.plugins_skipped": "Não foi possível compilar os plugins de código dos mods (exefs subsdk); o jogo é instalado sem eles. Detalhes: {log}",
"warn.npdm_differs": "O main.npdm difere do dump de referência da versão {version}; só os módulos de código são usados.",
"warn.xbox_prompts_failed": "Não foi possível preparar os ícones de botão do Xbox ou do PC (código de saída {code}); o jogo mantém os ícones do Switch. Detalhes: {log}",
"warn.xbox_prompts_failed": "Não foi possível preparar os ícones de botão do Xbox, do PlayStation ou do PC (código de saída {code}); o jogo mantém os ícones do Switch. Detalhes: {log}",
"warn.shaders_skipped": "O driver gráfico travou ao compilar alguns shaders, então {count} ficaram fora da preparação. O jogo os compila quando precisar deles pela primeira vez, e o driver pode travar ali também; uma atualização do driver pode resolver. Detalhes: {log}",
"warn.kernel_old": "O Linux {version} não tem o rastreamento de escrita de que o jogo depende (6.7 ou mais novo); o jogo pode rodar muito devagar. Atualizar o sistema resolve.",
"warn.dlss_kept": "Já existe uma biblioteca DLSS na pasta de instalação ({path}); a instalação a mantém.",
@@ -116,10 +126,10 @@
"ui.intro": "Monta uma pasta jogável de Tears of the Kingdom a partir dos seus próprios arquivos do jogo. Isso demora um pouco e só precisa ser feito uma vez.",
"ui.notice": "A pasta que esta instalação monta contém o jogo. Ela é só para seu uso pessoal; não compartilhe nem envie para a internet.",
"ui.keys_private": "O arquivo de chaves é lido no lugar. O conteúdo dele nunca é mostrado, copiado nem guardado.",
"ui.base": "Jogo base (NSP, XCI, NSZ ou XCZ)",
"ui.update": "Atualização 1.1.0, 1.2.1 ou 1.4.3 (NSP ou NSZ)",
"ui.base": "Jogo base",
"ui.update": "Atualização",
"ui.keys": "prod.keys",
"ui.firmware": "Pasta de firmware (opcional)",
"ui.firmware": "Firmware (opcional)",
"ui.game_language": "Idioma do jogo",
"ui.dest": "Pasta de instalação",
"ui.browse": "Procurar...",
@@ -132,6 +142,11 @@
"ui.dlss": "Baixar o NVIDIA DLSS (nvngx_dlss.dll) para placas de vídeo NVIDIA RTX",
"ui.dlss_help": "Do DLSS SDK da NVIDIA no GitHub, sob a licença NVIDIA RTX SDK (github.com/NVIDIA/DLSS). Sem ele as opções dlaa e DLSS não fazem nada.",
"ui.compressed_help": "Arquivos compactados NSZ e XCZ funcionam do jeito que estão: a instalação os descompacta sozinha (para isso, até os dados do jogo serem extraídos, ela precisa de tanto espaço livre quanto ocupam os arquivos descompactados).",
"ui.section_files": "Arquivos do jogo",
"ui.section_install": "Instalação",
"ui.more_details": "▸ Mais detalhes",
"ui.fewer_details": "▾ Ocultar detalhes",
"ui.formats_help": "Jogo base: NSP, XCI, NSZ ou XCZ. Atualização: 1.1.0, 1.2.1 ou 1.4.3, em NSP ou NSZ.",
"ui.type_game": "Arquivos de jogo (NSP, XCI, NSZ, XCZ)",
"ui.type_keys": "Arquivos de chaves (*.keys)",
"ui.type_all": "Todos os arquivos",
+19 -4
View File
@@ -1,10 +1,13 @@
{
"step.check": "Проверка компьютера и игровых файлов",
"step.kit": "Копирование набора сборки в папку игры",
"step.fonts": "Извлечение системных шрифтов",
"step.extract": "Распаковка игры",
"step.lift": "Перевод кода игры в C",
"step.compile": "Сборка {game_exe}",
"step.prepare": "Подготовка шейдеров",
"step.pc_prompts": "Рисование подсказок клавиатуры и мыши",
"step.shapes": "Раскладка экранов игры под ваши мониторы",
"step.dlss": "Загрузка NVIDIA DLSS",
"step.cleanup": "Уборка",
@@ -15,6 +18,7 @@
"phase.check.unpack_base": "Распаковка сжатой базовой игры",
"phase.check.unpack_update": "Распаковка сжатого обновления",
"phase.check.versions": "Проверка версий игры",
"phase.kit.copy": "Копирование инструментов, которыми игра пересобирает себя для модов с кодом",
"phase.fonts.extract": "Извлечение общих шрифтов из прошивки",
"phase.fonts.copy": "Копирование общих шрифтов в папку установки",
"phase.extract.hash_base": "Подсчёт контрольной суммы базовой игры",
@@ -29,10 +33,12 @@
"phase.compile.compile": "Компиляция",
"phase.compile.link": "Компоновка {game_exe}",
"phase.prepare.romfs_patches": "Запись патчей данных игры для 60 кадров/с",
"phase.pc_prompts.draw": "Рисование подсказок клавиш и кнопок мыши по назначениям из totk.ini",
"phase.prepare.seed": "Чтение шейдеров из данных игры",
"phase.prepare.translate": "Трансляция шейдеров",
"phase.prepare.libraries": "Сборка шейдеров для драйвера видеокарты",
"phase.prepare.pack": "Упаковка кэша шейдеров в один файл",
"phase.shapes.layouts": "Запись раскладок экрана и кнопок для каждой формы монитора",
"phase.dlss.download": "Загрузка nvngx_dlss.dll из DLSS SDK от NVIDIA",
"phase.cleanup.ini": "Запись totk.ini",
"phase.cleanup.temp": "Удаление временных файлов",
@@ -91,6 +97,9 @@
"lift.failed": "Не удалось перевести код игры (код выхода {code}). Подробности: {log}",
"compile.failed": "Не удалось собрать {game_exe} (код выхода {code}). Подробности: {log}",
"compile.exe_in_use": "Файл {path} занят. Закройте игру и запустите установку снова.",
"kit.in_use": "{path} занят другой программой. Закройте игру и все окна установки или пересборки, затем запустите установку снова.",
"kit.copy_failed": "Не удалось скопировать набор сборки в {path}: {detail}",
"compile.exe_locked": "Файл {path} не удаётся записать: его держит другая программа — игра, запущенная из этой папки, или антивирус, который пометил файл. Закройте игру, добавьте папку установщика и папку установки в исключения антивируса, перезагрузите Windows и запустите установку снова. Подробности: {log}",
"prepare.xlate_in_use": "Файл {path} занят. Закройте игру, завершите процесс totk_xlate, оставшийся от прошлого запуска, и запустите установку снова.",
"prepare.shader_list_missing": "Нет списка шейдеров.",
"prepare.romfs_patches_failed": "Не удалось записать патчи данных игры (код выхода {code}). Подробности: {log}",
@@ -103,7 +112,8 @@
"warn.npdm_differs": "main.npdm отличается от эталонного дампа {version}; используются только модули с кодом.",
"warn.cheats_skipped": "Не удалось собрать читы из папки модов, меняющие код игры; игра установится без них. Подробности: {log}",
"warn.exefs_skipped": "Не удалось собрать ExeFS-патчи модов (.ips, .pchtxt); игра установится без них. Подробности: {log}",
"warn.xbox_prompts_failed": "Не удалось подготовить подсказки кнопок Xbox или PC (код выхода {code}); игра оставит подсказки Switch. Подробности: {log}",
"warn.plugins_skipped": "Не удалось собрать плагины кода модов (exefs subsdk); игра установится без них. Подробности: {log}",
"warn.xbox_prompts_failed": "Не удалось подготовить подсказки кнопок Xbox, PlayStation или PC (код выхода {code}); игра оставит подсказки Switch. Подробности: {log}",
"warn.shaders_skipped": "Графический драйвер аварийно завершился при сборке части шейдеров, поэтому {count} из них пропущены при подготовке. Игра соберёт их, когда они впервые понадобятся, и драйвер может упасть и там; обновление драйвера может это исправить. Подробности: {log}",
"warn.kernel_old": "В Linux {version} нет отслеживания записи, на которое опирается игра (нужна версия 6.7 или новее); игра может работать очень медленно. Обновление системы это исправит.",
"warn.dlss_kept": "В папке установки уже есть библиотека DLSS ({path}); установка её оставляет.",
@@ -116,10 +126,10 @@
"ui.intro": "Собирает готовую к запуску папку с Tears of the Kingdom из ваших игровых файлов. Занимает много времени и выполняется один раз.",
"ui.notice": "Папка, которую создаёт установка, содержит игру. Она предназначена только для личного использования: не передавайте и не выкладывайте её.",
"ui.keys_private": "Файл ключей читается на месте. Его содержимое не показывается, не копируется и не сохраняется.",
"ui.base": "Базовая игра (NSP, XCI, NSZ или XCZ)",
"ui.update": "Обновление 1.1.0 или 1.2.1 или 1.4.3 (NSP или NSZ)",
"ui.base": "Базовая игра",
"ui.update": "Обновление",
"ui.keys": "prod.keys",
"ui.firmware": "Папка прошивки (необязательно)",
"ui.firmware": "Прошивка (необязательно)",
"ui.game_language": "Язык игры",
"ui.dest": "Папка установки",
"ui.browse": "Обзор...",
@@ -132,6 +142,11 @@
"ui.dlss": "Загрузить NVIDIA DLSS (nvngx_dlss.dll) для видеокарт NVIDIA RTX",
"ui.dlss_help": "Из DLSS SDK от NVIDIA на GitHub, по лицензии NVIDIA RTX SDK (github.com/NVIDIA/DLSS). Без него настройки dlaa и DLSS ничего не делают.",
"ui.compressed_help": "Сжатые файлы NSZ и XCZ подходят как есть: установка сама их распакует (для этого, пока извлекаются данные игры, нужно столько свободного места, сколько занимают распакованные файлы).",
"ui.section_files": "Файлы игры",
"ui.section_install": "Установка",
"ui.more_details": "▸ Подробнее",
"ui.fewer_details": "▾ Скрыть подробности",
"ui.formats_help": "Базовая игра: NSP, XCI, NSZ или XCZ. Обновление: 1.1.0, 1.2.1 или 1.4.3, в NSP или NSZ.",
"ui.type_game": "Файлы игры (NSP, XCI, NSZ, XCZ)",
"ui.type_keys": "Файлы ключей (*.keys)",
"ui.type_all": "Все файлы",
+19 -4
View File
@@ -1,10 +1,13 @@
{
"step.check": "检查电脑和游戏文件",
"step.kit": "正在把构建工具包复制到游戏文件夹",
"step.fonts": "正在提取系统字体",
"step.extract": "解包游戏",
"step.lift": "将游戏代码转换为 C 代码",
"step.compile": "编译 {game_exe}",
"step.prepare": "准备着色器",
"step.pc_prompts": "绘制键盘和鼠标按键提示",
"step.shapes": "为你的显示器调整游戏画面布局",
"step.dlss": "下载 NVIDIA DLSS",
"step.cleanup": "清理",
@@ -15,6 +18,7 @@
"phase.check.unpack_base": "正在解压压缩的游戏本体",
"phase.check.unpack_update": "正在解压压缩的更新",
"phase.check.versions": "检查游戏版本",
"phase.kit.copy": "正在复制游戏为代码模组重新构建自身所用的工具",
"phase.fonts.extract": "正在从固件中提取共享字体",
"phase.fonts.copy": "正在将共享字体复制到安装文件夹",
"phase.extract.hash_base": "计算游戏本体的校验和",
@@ -29,10 +33,12 @@
"phase.compile.compile": "编译",
"phase.compile.link": "链接 {game_exe}",
"phase.prepare.romfs_patches": "写入 60 帧游戏数据补丁",
"phase.pc_prompts.draw": "根据 totk.ini 中的按键绑定绘制键盘和鼠标按键提示",
"phase.prepare.seed": "从游戏数据中读取着色器",
"phase.prepare.translate": "转译着色器",
"phase.prepare.libraries": "为显卡驱动构建着色器",
"phase.prepare.pack": "将着色器缓存打包成一个文件",
"phase.shapes.layouts": "为每种显示器比例写入画面布局和按键提示",
"phase.dlss.download": "从 NVIDIA 的 DLSS SDK 下载 nvngx_dlss.dll",
"phase.cleanup.ini": "写入 totk.ini",
"phase.cleanup.temp": "删除临时文件",
@@ -91,6 +97,9 @@
"lift.failed": "游戏代码转换失败(退出代码 {code})。详情:{log}",
"compile.failed": "编译 {game_exe} 失败(退出代码 {code})。详情:{log}",
"compile.exe_in_use": "{path} 正在使用中。请关闭游戏后重新运行安装程序。",
"kit.in_use": "{path} 正在被占用。请关闭游戏以及所有打开的安装或重新构建窗口,再重新运行安装程序。",
"kit.copy_failed": "无法把构建工具包复制到 {path}:{detail}",
"compile.exe_locked": "无法写入 {path}:另一个程序正在占用它,可能是从该文件夹启动的游戏,或标记了该文件的杀毒软件。请关闭游戏,将安装程序文件夹和安装文件夹加入杀毒软件的排除项,重启 Windows,然后重新运行安装程序。详情:{log}",
"prepare.xlate_in_use": "{path} 正在被占用。请关闭游戏,结束上次残留的 totk_xlate 进程,再重新运行安装程序。",
"prepare.shader_list_missing": "缺少着色器列表。",
"prepare.romfs_patches_failed": "写入游戏数据补丁失败(退出代码 {code})。详情:{log}",
@@ -102,8 +111,9 @@
"warn.lang_needs_fonts": "{lang}文本需要 Switch 系统字体,但未提供。在添加这些字体之前,游戏无法以该语言启动。请选择固件文件夹(Contents/registered),或参阅 docs/installer.md 中的“Switch system fonts”一节。",
"warn.cheats_skipped": "无法构建 mods 文件夹中修改游戏代码的金手指;游戏将不含它们进行安装。详情:{log}",
"warn.exefs_skipped": "无法构建模组的 ExeFS 补丁(.ips、.pchtxt);游戏将不含它们进行安装。详情:{log}",
"warn.plugins_skipped": "无法构建模组的代码插件(exefs subsdk);游戏将不含它们进行安装。详情:{log}",
"warn.npdm_differs": "main.npdm 与参考的 {version} 导出不同;只使用其中的代码模块。",
"warn.xbox_prompts_failed": "无法准备 Xbox 或 PC 按键提示(退出代码 {code});游戏将继续使用 Switch 按键提示。详情:{log}",
"warn.xbox_prompts_failed": "无法准备 Xbox、PlayStation 或 PC 按键提示(退出代码 {code});游戏将继续使用 Switch 按键提示。详情:{log}",
"warn.shaders_skipped": "显卡驱动在编译部分着色器时崩溃,因此有 {count} 个着色器未被预先准备。游戏会在首次需要时编译它们,驱动在那时也可能崩溃;更新驱动可能会解决。详情:{log}",
"warn.kernel_old": "Linux {version} 缺少游戏依赖的写入跟踪功能(需要 6.7 或更新版本);游戏可能运行得很慢。更新系统即可解决。",
"warn.dlss_kept": "安装文件夹中已有 DLSS 库({path});安装程序将保留它。",
@@ -116,10 +126,10 @@
"ui.intro": "用你自己的游戏文件构建一个可以游玩的《王国之泪》文件夹。耗时较长,只需运行一次。",
"ui.notice": "此安装程序构建的文件夹包含游戏本身,仅供你个人使用;请勿分享或上传。",
"ui.keys_private": "密钥文件只在原位置读取,其内容绝不会被显示、复制或保存。",
"ui.base": "游戏本体(NSP、XCI、NSZ 或 XCZ)",
"ui.update": "1.1.0、1.2.1 或 1.4.3 更新(NSP 或 NSZ)",
"ui.base": "游戏本体",
"ui.update": "更新",
"ui.keys": "prod.keys",
"ui.firmware": "固件文件夹(可选)",
"ui.firmware": "固件(可选)",
"ui.game_language": "游戏语言",
"ui.dest": "安装文件夹",
"ui.browse": "浏览...",
@@ -132,6 +142,11 @@
"ui.dlss": "为 NVIDIA RTX 显卡下载 NVIDIA DLSS(nvngx_dlss.dll)",
"ui.dlss_help": "来自 GitHub 上 NVIDIA 的 DLSS SDK,遵循 NVIDIA RTX SDK 许可(github.com/NVIDIA/DLSS)。没有它,dlaa 和 DLSS 设置不起作用。",
"ui.compressed_help": "压缩的 NSZ 和 XCZ 文件可以直接使用:安装程序会自行解压(在游戏数据提取完成之前,需要与解压后文件大小相同的可用空间)。",
"ui.section_files": "游戏文件",
"ui.section_install": "安装",
"ui.more_details": "▸ 更多说明",
"ui.fewer_details": "▾ 收起说明",
"ui.formats_help": "游戏本体:NSP、XCI、NSZ 或 XCZ。更新:1.1.0、1.2.1 或 1.4.3,NSP 或 NSZ 格式。",
"ui.type_game": "游戏文件(NSP、XCI、NSZ、XCZ)",
"ui.type_keys": "密钥文件(*.keys)",
"ui.type_all": "所有文件",
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) rdbende <rdbende@proton.me>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+130
View File
@@ -0,0 +1,130 @@
package require Tk 8.6-
source [file join [file dirname [info script]] theme light.tcl]
source [file join [file dirname [info script]] theme dark.tcl]
if {[tk windowingsystem] == "win32"} {
set static ""
} else {
set static " static"
}
font create SunValleyCaptionFont -family "Segoe UI Variable$static Small" -size -12
font create SunValleyBodyFont -family "Segoe UI Variable$static Text" -size -14
font create SunValleyBodyStrongFont -family "Segoe UI Variable$static Text Semibold" -size -14
font create SunValleyBodyLargeFont -family "Segoe UI Variable$static Text" -size -18
font create SunValleySubtitleFont -family "Segoe UI Variable$static Display Semibold" -size -20
font create SunValleyTitleFont -family "Segoe UI Variable$static Display Semibold" -size -28
font create SunValleyTitleLargeFont -family "Segoe UI Variable$static Display Semibold" -size -40
font create SunValleyDisplayFont -family "Segoe UI Variable$static Display Semibold" -size -68
proc config_entry_font {w} {
set font_config [$w config -font]
if {[lindex $font_config 3] != [lindex $font_config 4]} {
return
}
if {[ttk::style theme use] in {"sun-valley-dark" "sun-valley-light"}} {
$w configure -font SunValleyBodyFont
}
}
proc config_menus {w} {
if {[tk windowingsystem] == "aqua" || [tk windowingsystem] == "win32"} {
return
}
set theme [ttk::style theme use]
if {$theme == "sun-valley-dark"} {
$w configure \
-relief solid \
-borderwidth 1 \
-activeborderwidth 0 \
-background "#292929" \
-activebackground $ttk::theme::sv_dark::colors(-selbg) \
-activeforeground $ttk::theme::sv_dark::colors(-selfg) \
-selectcolor $ttk::theme::sv_dark::colors(-selfg)
} elseif {$theme == "sun-valley-light"} {
$w configure \
-relief solid \
-borderwidth 1 \
-activeborderwidth 0 \
-background "#e7e7e7" \
-activebackground $ttk::theme::sv_light::colors(-selbg) \
-activeforeground $ttk::theme::sv_light::colors(-selfg) \
-selectcolor $ttk::theme::sv_light::colors(-selfg)
}
if {[[winfo toplevel $w] cget -menu] != $w} {
if {$theme == "sun-valley-dark"} {
$w configure -borderwidth 0 -background $ttk::theme::sv_dark::colors(-bg)
} elseif {$theme == "sun-valley-light"} {
$w configure -borderwidth 0 -background $ttk::theme::sv_light::colors(-bg)
}
}
}
proc configure_colors {} {
set theme [ttk::style theme use]
if {$theme == "sun-valley-dark"} {
ttk::style configure . \
-background $ttk::theme::sv_dark::colors(-bg) \
-foreground $ttk::theme::sv_dark::colors(-fg) \
-troughcolor $ttk::theme::sv_dark::colors(-bg) \
-focuscolor $ttk::theme::sv_dark::colors(-selbg) \
-selectbackground $ttk::theme::sv_dark::colors(-selbg) \
-selectforeground $ttk::theme::sv_dark::colors(-selfg) \
-insertwidth 1 \
-insertcolor $ttk::theme::sv_dark::colors(-fg) \
-fieldbackground $ttk::theme::sv_dark::colors(-bg) \
-font SunValleyBodyFont \
-borderwidth 0 \
-relief flat
tk_setPalette \
background $ttk::theme::sv_dark::colors(-bg) \
foreground $ttk::theme::sv_dark::colors(-fg) \
highlightColor $ttk::theme::sv_dark::colors(-selbg) \
selectBackground $ttk::theme::sv_dark::colors(-selbg) \
selectForeground $ttk::theme::sv_dark::colors(-selfg) \
activeBackground $ttk::theme::sv_dark::colors(-selbg) \
activeForeground $ttk::theme::sv_dark::colors(-selfg)
ttk::style map . -foreground [list disabled $ttk::theme::sv_dark::colors(-disfg)]
} elseif {$theme == "sun-valley-light"} {
ttk::style configure . \
-background $ttk::theme::sv_light::colors(-bg) \
-foreground $ttk::theme::sv_light::colors(-fg) \
-troughcolor $ttk::theme::sv_light::colors(-bg) \
-focuscolor $ttk::theme::sv_light::colors(-selbg) \
-selectbackground $ttk::theme::sv_light::colors(-selbg) \
-selectforeground $ttk::theme::sv_light::colors(-selfg) \
-insertwidth 1 \
-insertcolor $ttk::theme::sv_light::colors(-fg) \
-fieldbackground $ttk::theme::sv_light::colors(-bg) \
-font SunValleyBodyFont \
-borderwidth 0 \
-relief flat
tk_setPalette \
background $ttk::theme::sv_light::colors(-bg) \
foreground $ttk::theme::sv_light::colors(-fg) \
highlightColor $ttk::theme::sv_light::colors(-selbg) \
selectBackground $ttk::theme::sv_light::colors(-selbg) \
selectForeground $ttk::theme::sv_light::colors(-selfg) \
activeBackground $ttk::theme::sv_light::colors(-selbg) \
activeForeground $ttk::theme::sv_light::colors(-selfg)
ttk::style map . -foreground [list disabled $ttk::theme::sv_light::colors(-disfg)]
}
}
bind [winfo class .] <<ThemeChanged>> {+configure_colors}
bind TEntry <<ThemeChanged>> {+config_entry_font %W}
bind TCombobox <<ThemeChanged>> {+config_entry_font %W}
bind TSpinbox <<ThemeChanged>> {+config_entry_font %W}
bind Menu <<ThemeChanged>> {+config_menus %W}
+465
View File
@@ -0,0 +1,465 @@
source [file join [file dirname [info script]] sprites_dark.tcl]
namespace eval ttk::theme::sv_dark {
package provide ttk::theme::sv_dark 2.5
array set colors {
-fg "#fafafa"
-bg "#1c1c1c"
-disfg "#595959"
-selfg "#ffffff"
-selbg "#2f60d8"
-accent "#57c8ff"
}
proc load_images {imgfile} {
variable I
image create photo spritesheet -file $imgfile -format png
foreach {name x y width height} $::spriteinfo {
set I($name) [image create photo -width $width -height $height]
$I($name) copy spritesheet -from $x $y [expr {$x+$width}] [expr {$y+$height}]
}
}
load_images [file join [file dirname [info script]] spritesheet_dark.png]
ttk::style theme create sun-valley-dark -parent clam -settings {
# Button
ttk::style layout TButton {
Button.button -children {
Button.padding -children {
Button.label -side left -expand 1
}
}
}
ttk::style configure TButton -padding {8 2 8 3} -anchor center -foreground $colors(-fg)
ttk::style map TButton -foreground [list disabled "#7a7a7a" pressed "#d0d0d0"]
ttk::style element create Button.button image \
[list $I(button-rest) \
{selected disabled} $I(button-dis) \
disabled $I(button-dis) \
selected $I(button-rest) \
pressed $I(button-pressed) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
# Toolbutton
ttk::style layout Toolbutton {
Toolbutton.button -children {
Toolbutton.padding -children {
Toolbutton.label -side left -expand 1
}
}
}
ttk::style configure Toolbutton -padding {8 2 8 3} -anchor center
ttk::style element create Toolbutton.button image \
[list $I(empty) \
disabled $I(button-dis) \
pressed $I(button-pressed) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
# Accent.TButton
ttk::style layout Accent.TButton {
AccentButton.button -children {
AccentButton.padding -children {
AccentButton.label -side left -expand 1
}
}
}
ttk::style configure Accent.TButton -padding {8 2 8 3} -anchor center -foreground "#000000"
ttk::style map Accent.TButton -foreground [list pressed "#25536a" disabled "#a5a5a5"]
ttk::style element create AccentButton.button image \
[list $I(button-accent-rest) \
{selected disabled} $I(button-accent-dis) \
disabled $I(button-accent-dis) \
selected $I(button-accent-rest) \
pressed $I(button-accent-pressed) \
{active focus} $I(button-accent-focus-hover) \
active $I(button-accent-hover) \
focus $I(button-accent-focus) \
] -border 4 -sticky nsew
# Menubutton
ttk::style layout TMenubutton {
Menubutton.button -children {
Menubutton.padding -children {
Menubutton.label -side left -expand 1
Menubutton.indicator -side right -sticky nsew
}
}
}
ttk::style configure TMenubutton -padding {8 2 13 3}
ttk::style element create Menubutton.button image \
[list $I(button-rest) \
disabled $I(button-dis) \
pressed $I(button-pressed) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
ttk::style element create Menubutton.indicator image $I(down) -width 10 -sticky e
# OptionMenu
ttk::style layout TOptionMenu {
OptionMenu.button -children {
OptionMenu.padding -children {
OptionMenu.label -side left -expand 1
OptionMenu.indicator -side right -sticky nsew
}
}
}
ttk::style configure TOptionMenu -padding {8 2 13 3}
ttk::style element create OptionMenu.button image \
[list $I(button-rest) \
disabled $I(button-dis) \
pressed $I(button-pressed) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
ttk::style element create OptionMenu.indicator image $I(down) -width 10 -sticky e
# Checkbutton
ttk::style layout TCheckbutton {
Checkbutton.button -children {
Checkbutton.padding -children {
Checkbutton.indicator -side left
Checkbutton.label -side right -expand 1
}
}
}
ttk::style configure TCheckbutton -padding 4
ttk::style element create Checkbutton.indicator image \
[list $I(check-unsel-rest) \
{alternate disabled} $I(check-tri-dis) \
{selected disabled} $I(check-dis) \
disabled $I(check-unsel-dis) \
{pressed alternate} $I(check-tri-hover) \
{active focus alternate} $I(check-tri-focus-hover) \
{active alternate} $I(check-tri-hover) \
{focus alternate} $I(check-tri-focus) \
alternate $I(check-tri-rest) \
{pressed selected} $I(check-hover) \
{active focus selected} $I(check-focus-hover) \
{active selected} $I(check-hover) \
{focus selected} $I(check-focus) \
selected $I(check-rest) \
{pressed !selected} $I(check-unsel-pressed) \
{active focus} $I(check-unsel-focus-hover) \
active $I(check-unsel-hover) \
focus $I(check-unsel-focus) \
] -width 26 -sticky w
# Switch.TCheckbutton
ttk::style layout Switch.TCheckbutton {
Switch.button -children {
Switch.padding -children {
Switch.indicator -side left
Switch.label -side right -expand 1
}
}
}
ttk::style element create Switch.indicator image \
[list $I(switch-off-rest) \
{selected disabled} $I(switch-dis) \
disabled $I(switch-off-dis) \
{pressed selected} $I(switch-pressed) \
{active focus selected} $I(switch-focus-hover) \
{active selected} $I(switch-hover) \
{focus selected} $I(switch-focus) \
selected $I(switch-rest) \
{pressed !selected} $I(switch-off-pressed) \
{active focus} $I(switch-off-focus-hover) \
active $I(switch-off-hover) \
focus $I(switch-off-focus) \
] -width 46 -sticky w
# Toggle.TButton
ttk::style layout Toggle.TButton {
ToggleButton.button -children {
ToggleButton.padding -children {
ToggleButton.label -side left -expand 1
}
}
}
ttk::style configure Toggle.TButton -padding {8 2 8 3} -anchor center -foreground $colors(-fg)
ttk::style map Toggle.TButton -foreground \
[list {selected disabled} "#a5a5a5" \
{selected pressed} "#d0d0d0" \
selected "#000000" \
pressed "#25536a" \
disabled "#7a7a7a"
]
ttk::style element create ToggleButton.button image \
[list $I(button-rest) \
{selected disabled} $I(button-accent-dis) \
disabled $I(button-dis) \
{pressed selected} $I(button-rest) \
{active focus selected} $I(button-accent-focus-hover) \
{active selected} $I(button-accent-hover) \
{focus selected} $I(button-accent-focus) \
selected $I(button-accent-rest) \
{pressed !selected} $I(button-accent-rest) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
# Radiobutton
ttk::style layout TRadiobutton {
Radiobutton.button -children {
Radiobutton.padding -children {
Radiobutton.indicator -side left
Radiobutton.label -side right -expand 1
}
}
}
ttk::style configure TRadiobutton -padding 4
ttk::style element create Radiobutton.indicator image \
[list $I(radio-unsel-rest) \
{selected disabled} $I(radio-dis) \
disabled $I(radio-unsel-dis) \
{pressed selected} $I(radio-pressed) \
{active focus selected} $I(radio-focus-hover) \
{active selected} $I(radio-hover) \
{focus selected} $I(radio-focus) \
selected $I(radio-rest) \
{pressed !selected} $I(radio-unsel-pressed) \
{active focus} $I(radio-unsel-focus-hover) \
active $I(radio-unsel-hover) \
focus $I(radio-unsel-focus) \
] -width 26 -sticky w
# Entry
ttk::style configure TEntry -foreground $colors(-fg) -padding {6 1 4 2}
ttk::style map TEntry -foreground [list disabled "#757575" pressed "#cfcfcf"]
ttk::style element create Entry.field image \
[list $I(textbox-rest) \
{focus hover !invalid} $I(textbox-focus) \
invalid $I(textbox-error) \
disabled $I(textbox-dis) \
{focus !invalid} $I(textbox-focus) \
hover $I(textbox-hover) \
] -border 5 -sticky nsew
# Combobox
ttk::style layout TCombobox {
Combobox.field -sticky nsew -children {
Combobox.arrow -side right -sticky ns
Combobox.padding -sticky nsew -children {
Combobox.textarea -sticky nsew
}
}
}
ttk::style configure TCombobox -foreground $colors(-fg) -padding {6 1 0 2}
ttk::style configure ComboboxPopdownFrame -borderwidth 1 -relief solid
ttk::style map TCombobox -foreground [list disabled "#757575" pressed "#cfcfcf"]
ttk::style map TCombobox -selectbackground [list \
{readonly hover} $colors(-selbg) \
{readonly focus} $colors(-selbg) \
] -selectforeground [list \
{readonly hover} $colors(-selfg) \
{readonly focus} $colors(-selfg) \
]
ttk::style element create Combobox.field image \
[list $I(textbox-rest) \
{readonly focus} $I(button-focus) \
{readonly disabled} $I(button-dis) \
{readonly pressed} $I(button-pressed) \
{readonly hover} $I(button-hover) \
readonly $I(button-rest) \
{focus hover !invalid} $I(textbox-focus) \
invalid $I(textbox-error) \
disabled $I(textbox-dis) \
focus $I(textbox-focus) \
{focus !invalid} $I(textbox-focus) \
hover $I(textbox-hover) \
] -border 5
ttk::style element create Combobox.arrow image $I(down) -width 34 -sticky {}
# Spinbox
ttk::style layout TSpinbox {
Spinbox.field -side top -sticky we -children {
Spinbox.downarrow -side right -sticky ns
Spinbox.uparrow -side right -sticky ns
Spinbox.padding -sticky nswe -children {
Spinbox.textarea -sticky nsew
}
}
}
ttk::style configure TSpinbox -foreground $colors(-fg) -padding {6 1 0 2}
ttk::style map TSpinbox -foreground [list disabled "#757575" pressed "#cfcfcf"]
ttk::style element create Spinbox.field image \
[list $I(textbox-rest) \
{focus hover !invalid} $I(textbox-focus) \
invalid $I(textbox-error) \
disabled $I(textbox-dis) \
focus $I(textbox-focus) \
{focus !invalid} $I(textbox-focus) \
hover $I(textbox-hover) \
] -border 5 -sticky nsew
ttk::style element create Spinbox.uparrow image $I(up) -width 34 -height 16 -sticky {}
ttk::style element create Spinbox.downarrow image $I(down) -width 34 -height 16 -sticky {}
# Progressbar
ttk::style element create Horizontal.Progressbar.trough image $I(progressbar-trough-hor) -border 1 -sticky ew
ttk::style element create Horizontal.Progressbar.pbar image $I(progressbar-bar-hor) -border 2 -sticky ew
ttk::style element create Vertical.Progressbar.trough image $I(progressbar-trough-vert) -border 1 -sticky ns
ttk::style element create Vertical.Progressbar.pbar image $I(progressbar-bar-vert) -border 2 -sticky ns
# Scale
ttk::style element create Horizontal.Scale.trough image $I(slider-trough-hor) \
-border 5 -padding 0 -sticky {ew}
ttk::style element create Vertical.Scale.trough image $I(slider-trough-vert) \
-border 5 -padding 0 -sticky {ns}
ttk::style element create Scale.slider image \
[list $I(slider-thumb-rest) \
disabled $I(slider-thumb-dis) \
pressed $I(slider-thumb-pressed) \
{active focus} $I(slider-thumb-focus-hover) \
active $I(slider-thumb-hover) \
focus $I(slider-thumb-focus) \
] -sticky {}
# Scrollbar
ttk::style layout Vertical.TScrollbar {
Vertical.Scrollbar.trough -sticky ns -children {
Vertical.Scrollbar.uparrow -side top
Vertical.Scrollbar.downarrow -side bottom
Vertical.Scrollbar.thumb -expand 1
}
}
ttk::style layout Horizontal.TScrollbar {
Horizontal.Scrollbar.trough -sticky ew -children {
Horizontal.Scrollbar.leftarrow -side left
Horizontal.Scrollbar.rightarrow -side right
Horizontal.Scrollbar.thumb -expand 1
}
}
ttk::style element create Horizontal.Scrollbar.trough image $I(scrollbar-trough-hor) -sticky ew -border {6 0}
ttk::style element create Horizontal.Scrollbar.thumb image $I(scrollbar-thumb-hor) -sticky ew -border {3 0}
ttk::style element create Horizontal.Scrollbar.rightarrow image $I(scrollbar-right) -sticky e -width 13
ttk::style element create Horizontal.Scrollbar.leftarrow image $I(scrollbar-left) -sticky w -width 13
ttk::style element create Vertical.Scrollbar.trough image $I(scrollbar-trough-vert) -sticky ns -border {0 6}
ttk::style element create Vertical.Scrollbar.thumb image $I(scrollbar-thumb-vert) -sticky ns -border {0 3}
ttk::style element create Vertical.Scrollbar.uparrow image $I(scrollbar-up) -sticky n -height 13
ttk::style element create Vertical.Scrollbar.downarrow image $I(scrollbar-down) -sticky s -height 13
# Separator
ttk::style element create Separator.separator image $I(sep) -width 1 -height 1
# Sizegrip
ttk::style element create Sizegrip.sizegrip image $I(grip) -sticky nsew
# Card
ttk::style layout Card.TFrame {
Card.field {
Card.padding -expand 1
}
}
ttk::style element create Card.field image $I(card) -border 10 -padding 4 -sticky nsew
# Labelframe
ttk::style layout TLabelframe {
Labelframe.border {
Labelframe.padding -expand 1 -children {
Labelframe.label -side left
}
}
}
ttk::style element create Labelframe.border image $I(card) -border 5 -padding 4 -sticky nsew
ttk::style configure TLabelframe.Label -font SunValleyCaptionFont
# Notebook
ttk::style layout TNotebook {
Notebook.border -children {
TNotebook.Tab -expand 1
}
}
ttk::style configure TNotebook -padding 1
ttk::style configure TNotebook.Tab -focuscolor $colors(-accent)
ttk::style element create Notebook.border image $I(notebook-border) -border 5 -padding 5
ttk::style element create Notebook.tab image \
[list $I(tab-rest) \
selected $I(tab-selected) \
active $I(tab-hover) \
] -border 13 -padding {16 14 16 6} -height 32
# Treeview
ttk::style configure Heading -font SunValleyCaptionFont
ttk::style configure Treeview \
-background $colors(-bg) \
-rowheight [expr {[font metrics SunValleyBodyFont -linespace] + 3}] \
-font SunValleyBodyFont
ttk::style map Treeview -background {selected "#292929"} -foreground "selected $colors(-selfg)"
ttk::style element create Treeview.field image $I(card) -border 5 -width 0 -height 0
ttk::style element create Treeheading.cell image \
[list $I(heading-rest) \
pressed $I(heading-pressed) \
active $I(heading-hover)
] -border 5 -padding 14 -sticky nsew
ttk::style element create Treeitem.indicator image \
[list $I(right) \
user2 $I(empty) \
user1 $I(down) \
] -width 26 -sticky {}
# Panedwindow
ttk::style configure Sash \
-lightcolor "#9e9e9e" \
-darkcolor "#9e9e9e" \
-bordercolor "#9e9e9e" \
-sashthickness 4 \
-gripcount 20
}
}
+469
View File
@@ -0,0 +1,469 @@
source [file join [file dirname [info script]] sprites_light.tcl]
namespace eval ttk::theme::sv_light {
package provide ttk::theme::sv_light 2.5
array set colors {
-fg "#1c1c1c"
-bg "#fafafa"
-disfg "#a0a0a0"
-selfg "#ffffff"
-selbg "#2f60d8"
-accent "#005fb8"
}
proc load_images {imgfile} {
variable I
image create photo spritesheet -file $imgfile -format png
foreach {name x y width height} $::spriteinfo {
set I($name) [image create photo -width $width -height $height]
$I($name) copy spritesheet -from $x $y [expr {$x+$width}] [expr {$y+$height}]
}
}
load_images [file join [file dirname [info script]] spritesheet_light.png]
ttk::style theme create sun-valley-light -parent clam -settings {
# Button
ttk::style layout TButton {
Button.button -children {
Button.padding -children {
Button.label -side left -expand 1
}
}
}
ttk::style configure TButton -padding {8 2 8 3} -anchor center -foreground $colors(-fg)
ttk::style map TButton -foreground [list disabled "#a2a2a2" pressed "#636363" active "#1a1a1a"]
ttk::style element create Button.button image \
[list $I(button-rest) \
{selected disabled} $I(button-dis) \
disabled $I(button-dis) \
selected $I(button-rest) \
pressed $I(button-pressed) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
# Toolbutton
ttk::style layout Toolbutton {
Toolbutton.button -children {
Toolbutton.padding -children {
Toolbutton.label -side left -expand 1
}
}
}
ttk::style configure Toolbutton -padding {8 2 8 3} -anchor center
ttk::style element create Toolbutton.button image \
[list $I(empty) \
disabled $I(button-dis) \
pressed $I(button-pressed) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
# Accent.TButton
ttk::style layout Accent.TButton {
AccentButton.button -children {
AccentButton.padding -children {
AccentButton.label -side left -expand 1
}
}
}
ttk::style configure Accent.TButton -padding {8 2 8 3} -anchor center -foreground "#ffffff"
ttk::style map Accent.TButton -foreground [list pressed "#c1d8ee" disabled "#ffffff"]
ttk::style element create AccentButton.button image \
[list $I(button-accent-rest) \
{selected disabled} $I(button-accent-dis) \
disabled $I(button-accent-dis) \
selected $I(button-accent-rest) \
pressed $I(button-accent-pressed) \
{active focus} $I(button-accent-focus-hover) \
active $I(button-accent-hover) \
focus $I(button-accent-focus) \
] -border 4 -sticky nsew
# Menubutton
ttk::style layout TMenubutton {
Menubutton.button -children {
Menubutton.padding -children {
Menubutton.label -side left -expand 1
Menubutton.indicator -side right -sticky nsew
}
}
}
ttk::style configure TMenubutton -padding {8 2 13 3}
ttk::style element create Menubutton.button image \
[list $I(button-rest) \
disabled $I(button-dis) \
pressed $I(button-pressed) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
ttk::style element create Menubutton.indicator image $I(down) -width 10 -sticky e
# OptionMenu
ttk::style layout TOptionMenu {
OptionMenu.button -children {
OptionMenu.padding -children {
OptionMenu.label -side left -expand 1
OptionMenu.indicator -side right -sticky nsew
}
}
}
ttk::style configure TOptionMenu -padding {8 2 13 3}
ttk::style element create OptionMenu.button image \
[list $I(button-rest) \
disabled $I(button-dis) \
pressed $I(button-pressed) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
ttk::style element create OptionMenu.indicator image $I(down) -width 10 -sticky e
# Checkbutton
ttk::style layout TCheckbutton {
Checkbutton.button -children {
Checkbutton.padding -children {
Checkbutton.indicator -side left
Checkbutton.label -side right -expand 1
}
}
}
ttk::style configure TCheckbutton -padding 4
ttk::style element create Checkbutton.indicator image \
[list $I(check-unsel-rest) \
{alternate disabled} $I(check-tri-dis) \
{selected disabled} $I(check-dis) \
disabled $I(check-unsel-dis) \
{pressed alternate} $I(check-tri-hover) \
{active focus alternate} $I(check-tri-focus-hover) \
{active alternate} $I(check-tri-hover) \
{focus alternate} $I(check-tri-focus) \
alternate $I(check-tri-rest) \
{pressed selected} $I(check-hover) \
{active focus selected} $I(check-focus-hover) \
{active selected} $I(check-hover) \
{focus selected} $I(check-focus) \
selected $I(check-rest) \
{pressed !selected} $I(check-unsel-pressed) \
{active focus} $I(check-unsel-focus-hover) \
active $I(check-unsel-hover) \
focus $I(check-unsel-focus) \
] -width 26 -sticky w
# Switch.TCheckbutton
ttk::style layout Switch.TCheckbutton {
Switch.button -children {
Switch.padding -children {
Switch.indicator -side left
Switch.label -side right -expand 1
}
}
}
ttk::style element create Switch.indicator image \
[list $I(switch-off-rest) \
{selected disabled} $I(switch-dis) \
disabled $I(switch-off-dis) \
{pressed selected} $I(switch-pressed) \
{active focus selected} $I(switch-focus-hover) \
{active selected} $I(switch-hover) \
{focus selected} $I(switch-focus) \
selected $I(switch-rest) \
{pressed !selected} $I(switch-off-pressed) \
{active focus} $I(switch-off-focus-hover) \
active $I(switch-off-hover) \
focus $I(switch-off-focus) \
] -width 46 -sticky w
# Toggle.TButton
ttk::style layout Toggle.TButton {
ToggleButton.button -children {
ToggleButton.padding -children {
ToggleButton.label -side left -expand 1
}
}
}
ttk::style configure Toggle.TButton -padding {8 2 8 3} -anchor center -foreground $colors(-fg)
ttk::style map Toggle.TButton -foreground \
[list {selected disabled} "#ffffff" \
{selected pressed} "#636363" \
selected "#ffffff" \
pressed "#c1d8ee" \
disabled "#a2a2a2" \
active "#1a1a1a"
]
ttk::style element create ToggleButton.button image \
[list $I(button-rest) \
{selected disabled} $I(button-accent-dis) \
disabled $I(button-dis) \
{pressed selected} $I(button-rest) \
{active focus selected} $I(button-accent-focus-hover) \
{active selected} $I(button-accent-hover) \
{focus selected} $I(button-accent-focus) \
selected $I(button-accent-rest) \
{pressed !selected} $I(button-accent-rest) \
{active focus} $I(button-focus-hover) \
active $I(button-hover) \
focus $I(button-focus) \
] -border 4 -sticky nsew
# Radiobutton
ttk::style layout TRadiobutton {
Radiobutton.button -children {
Radiobutton.padding -children {
Radiobutton.indicator -side left
Radiobutton.label -side right -expand 1
}
}
}
ttk::style configure TRadiobutton -padding 4
ttk::style element create Radiobutton.indicator image \
[list $I(radio-unsel-rest) \
{selected disabled} $I(radio-dis) \
disabled $I(radio-unsel-dis) \
{pressed selected} $I(radio-pressed) \
{active focus selected} $I(radio-focus-hover) \
{active selected} $I(radio-hover) \
{focus selected} $I(radio-focus) \
selected $I(radio-rest) \
{pressed !selected} $I(radio-unsel-pressed) \
{active focus} $I(radio-unsel-focus-hover) \
active $I(radio-unsel-hover) \
focus $I(radio-unsel-focus) \
] -width 26 -sticky w
# Entry
ttk::style configure TEntry -foreground $colors(-fg) -padding {6 1 4 2}
ttk::style map TEntry -foreground [list disabled $colors(-disfg) pressed "#636363" active "#626262"]
ttk::style element create Entry.field image \
[list $I(textbox-rest) \
{focus hover !invalid} $I(textbox-focus) \
invalid $I(textbox-error) \
disabled $I(textbox-dis) \
{focus !invalid} $I(textbox-focus) \
hover $I(textbox-hover) \
] -border 5 -sticky nsew
# Combobox
ttk::style layout TCombobox {
Combobox.field -sticky nsew -children {
Combobox.arrow -side right -sticky ns
Combobox.padding -sticky nsew -children {
Combobox.textarea -sticky nsew
}
}
}
ttk::style configure TCombobox -foreground $colors(-fg) -padding {6 1 0 2}
ttk::style configure ComboboxPopdownFrame -borderwidth 1 -relief solid
ttk::style map TCombobox -foreground [list disabled $colors(-disfg) pressed "#636363" active "#626262"]
ttk::style map TCombobox -selectbackground [list \
{readonly hover} $colors(-selbg) \
{readonly focus} $colors(-selbg) \
] -selectforeground [list \
{readonly hover} $colors(-selfg) \
{readonly focus} $colors(-selfg) \
]
ttk::style element create Combobox.field image \
[list $I(textbox-rest) \
{readonly focus} $I(button-focus) \
{readonly disabled} $I(button-dis) \
{readonly pressed} $I(button-pressed) \
{readonly hover} $I(button-hover) \
readonly $I(button-rest) \
{focus hover !invalid} $I(textbox-focus) \
invalid $I(textbox-error) \
disabled $I(textbox-dis) \
focus $I(textbox-focus) \
{focus !invalid} $I(textbox-focus) \
hover $I(textbox-hover) \
] -border 5
ttk::style element create Combobox.arrow image $I(down) -width 34 -sticky {}
# Spinbox
ttk::style layout TSpinbox {
Spinbox.field -side top -sticky we -children {
Spinbox.downarrow -side right -sticky ns
Spinbox.uparrow -side right -sticky ns
Spinbox.padding -sticky nswe -children {
Spinbox.textarea -sticky nsew
}
}
}
ttk::style configure TSpinbox -foreground $colors(-fg) -padding {6 1 0 2}
ttk::style map TSpinbox -foreground [list disabled $colors(-disfg) pressed "#636363" active "#626262"]
ttk::style element create Spinbox.field image \
[list $I(textbox-rest) \
{focus hover !invalid} $I(textbox-focus) \
invalid $I(textbox-error) \
disabled $I(textbox-dis) \
focus $I(textbox-focus) \
{focus !invalid} $I(textbox-focus) \
hover $I(textbox-hover) \
] -border 5 -sticky nsew
ttk::style element create Spinbox.uparrow image $I(up) -width 34 -height 16 -sticky {}
ttk::style element create Spinbox.downarrow image $I(down) -width 34 -height 16 -sticky {}
# Progressbar
ttk::style element create Horizontal.Progressbar.trough image $I(progressbar-trough-hor) \
-border 1 -sticky ew
ttk::style element create Horizontal.Progressbar.pbar image $I(progressbar-bar-hor) \
-border 2 -sticky ew
ttk::style element create Vertical.Progressbar.trough image $I(progressbar-trough-vert) \
-border 1 -sticky ns
ttk::style element create Vertical.Progressbar.pbar image $I(progressbar-bar-vert) \
-border 2 -sticky ns
# Scale
ttk::style element create Horizontal.Scale.trough image $I(slider-trough-hor) \
-border 5 -padding 0 -sticky {ew}
ttk::style element create Vertical.Scale.trough image $I(slider-trough-vert) \
-border 5 -padding 0 -sticky {ns}
ttk::style element create Scale.slider image \
[list $I(slider-thumb-rest) \
disabled $I(slider-thumb-dis) \
pressed $I(slider-thumb-pressed) \
{active focus} $I(slider-thumb-focus-hover) \
active $I(slider-thumb-hover) \
focus $I(slider-thumb-focus) \
] -sticky {}
# Scrollbar
ttk::style layout Vertical.TScrollbar {
Vertical.Scrollbar.trough -sticky ns -children {
Vertical.Scrollbar.uparrow -side top
Vertical.Scrollbar.downarrow -side bottom
Vertical.Scrollbar.thumb -expand 1
}
}
ttk::style layout Horizontal.TScrollbar {
Horizontal.Scrollbar.trough -sticky ew -children {
Horizontal.Scrollbar.leftarrow -side left
Horizontal.Scrollbar.rightarrow -side right
Horizontal.Scrollbar.thumb -expand 1
}
}
ttk::style element create Horizontal.Scrollbar.trough image $I(scrollbar-trough-hor) -sticky ew -border {6 0}
ttk::style element create Horizontal.Scrollbar.thumb image $I(scrollbar-thumb-hor) -sticky ew -border {3 0}
ttk::style element create Horizontal.Scrollbar.rightarrow image $I(scrollbar-right) -sticky e -width 13
ttk::style element create Horizontal.Scrollbar.leftarrow image $I(scrollbar-left) -sticky w -width 13
ttk::style element create Vertical.Scrollbar.trough image $I(scrollbar-trough-vert) -sticky ns -border {0 6}
ttk::style element create Vertical.Scrollbar.thumb image $I(scrollbar-thumb-vert) -sticky ns -border {0 3}
ttk::style element create Vertical.Scrollbar.uparrow image $I(scrollbar-up) -sticky n -height 13
ttk::style element create Vertical.Scrollbar.downarrow image $I(scrollbar-down) -sticky s -height 13
# Separator
ttk::style element create Separator.separator image $I(sep) -width 1 -height 1
# Sizegrip
ttk::style element create Sizegrip.sizegrip image $I(grip) -sticky nsew
# Card
ttk::style layout Card.TFrame {
Card.field {
Card.padding -expand 1
}
}
ttk::style element create Card.field image $I(card) -border 10 -padding 4 -sticky nsew
# Labelframe
ttk::style layout TLabelframe {
Labelframe.border {
Labelframe.padding -expand 1 -children {
Labelframe.label -side left
}
}
}
ttk::style element create Labelframe.border image $I(card) -border 5 -padding 4 -sticky nsew
ttk::style configure TLabelframe.Label -font SunValleyCaptionFont
# Notebook
ttk::style layout TNotebook {
Notebook.border -children {
TNotebook.Tab -expand 1
}
}
ttk::style configure TNotebook -padding 1
ttk::style configure TNotebook.Tab -focuscolor $colors(-accent)
ttk::style element create Notebook.border image $I(notebook-border) -border 5 -padding 5
ttk::style element create Notebook.tab image \
[list $I(tab-rest) \
selected $I(tab-selected) \
active $I(tab-hover) \
] -border 13 -padding {16 14 16 6} -height 32
# Treeview
ttk::style configure Heading -font SunValleyCaptionFont
ttk::style configure Treeview \
-background $colors(-bg) \
-rowheight [expr {[font metrics SunValleyBodyFont -linespace] + 3}] \
-font SunValleyBodyFont
ttk::style map Treeview -background {selected "#e7e7e7"} -foreground {selected "#191919"}
ttk::style element create Treeview.field image $I(card) -border 5 -width 0 -height 0
ttk::style element create Treeheading.cell image \
[list $I(heading-rest) \
pressed $I(heading-pressed) \
active $I(heading-hover)
] -border 5 -padding 14 -sticky nsew
ttk::style element create Treeitem.indicator image \
[list $I(right) \
user2 $I(empty) \
user1 $I(down) \
] -width 26 -sticky {}
# Panedwindow
ttk::style configure Sash \
-lightcolor "#676767" \
-darkcolor "#676767" \
-bordercolor "#676767" \
-sashthickness 4 \
-gripcount 20
}
}
+95
View File
@@ -0,0 +1,95 @@
set ::spriteinfo [list \
card 0 0 50 50 \
notebook-border 50 0 40 40 \
switch-dis 50 40 40 20 \
switch-focus-hover 0 50 40 20 \
switch-focus 0 70 40 20 \
switch-hover 40 60 40 20 \
switch-off-dis 90 0 40 20 \
switch-off-focus-hover 90 20 40 20 \
switch-off-focus 90 40 40 20 \
switch-off-hover 80 60 40 20 \
switch-off-pressed 0 90 40 20 \
switch-off-rest 40 80 40 20 \
switch-pressed 80 80 40 20 \
switch-rest 0 110 40 20 \
tab-hover 130 0 32 32 \
tab-rest 130 32 32 32 \
tab-selected 120 64 32 32 \
heading-hover 40 100 22 22 \
heading-pressed 62 100 22 22 \
heading-rest 84 100 22 22 \
slider-thumb-dis 106 100 22 22 \
slider-thumb-focus-hover 128 96 22 22 \
slider-thumb-focus 0 130 22 22 \
slider-thumb-hover 22 130 22 22 \
slider-thumb-pressed 44 122 22 22 \
slider-thumb-rest 66 122 22 22 \
slider-trough-hor 88 122 22 22 \
slider-trough-vert 110 122 22 22 \
button-accent-dis 132 118 20 20 \
button-accent-focus-hover 0 152 20 20 \
button-accent-focus 20 152 20 20 \
button-accent-hover 40 152 20 20 \
button-accent-pressed 60 144 20 20 \
button-accent-rest 80 144 20 20 \
button-dis 100 144 20 20 \
button-focus-hover 120 144 20 20 \
button-focus 140 138 20 20 \
button-hover 162 0 20 20 \
button-pressed 162 20 20 20 \
button-rest 162 40 20 20 \
check-dis 162 60 20 20 \
check-focus-hover 150 96 20 20 \
check-focus 152 116 20 20 \
check-hover 160 136 20 20 \
check-pressed 0 172 20 20 \
check-rest 20 172 20 20 \
check-tri-dis 40 172 20 20 \
check-tri-focus-hover 160 156 20 20 \
check-tri-focus 140 158 20 20 \
check-tri-hover 60 164 20 20 \
check-tri-pressed 80 164 20 20 \
check-tri-rest 100 164 20 20 \
check-unsel-dis 120 164 20 20 \
check-unsel-focus-hover 182 0 20 20 \
check-unsel-focus 182 20 20 20 \
check-unsel-hover 182 40 20 20 \
check-unsel-pressed 182 60 20 20 \
check-unsel-rest 180 80 20 20 \
progressbar-bar-hor 180 100 20 5 \
progressbar-bar-vert 172 80 5 20 \
progressbar-trough-hor 152 80 20 5 \
progressbar-trough-vert 172 100 5 20 \
radio-dis 180 105 20 20 \
radio-focus-hover 180 125 20 20 \
radio-focus 180 145 20 20 \
radio-hover 180 165 20 20 \
radio-pressed 160 176 20 20 \
radio-rest 140 178 20 20 \
radio-unsel-dis 0 192 20 20 \
radio-unsel-focus-hover 20 192 20 20 \
radio-unsel-focus 40 192 20 20 \
radio-unsel-hover 180 185 20 20 \
radio-unsel-pressed 60 184 20 20 \
radio-unsel-rest 80 184 20 20 \
scrollbar-thumb-hor 160 196 20 12 \
scrollbar-thumb-vert 100 184 12 20 \
scrollbar-trough-hor 112 198 20 12 \
scrollbar-trough-vert 202 0 12 20 \
textbox-dis 0 212 20 20 \
textbox-error 20 212 20 20 \
textbox-focus 40 212 20 20 \
textbox-hover 60 210 20 20 \
textbox-rest 80 210 20 20 \
down 40 50 10 5 \
empty 152 64 10 10 \
grip 152 85 10 10 \
right 162 85 5 10 \
sep 202 20 10 10 \
up 40 55 10 5 \
scrollbar-down 132 138 8 6 \
scrollbar-left 44 144 6 8 \
scrollbar-right 50 144 6 8 \
scrollbar-up 172 120 8 6 \
]
+95
View File
@@ -0,0 +1,95 @@
set ::spriteinfo [list \
card 0 0 50 50 \
notebook-border 50 0 40 40 \
switch-dis 50 40 40 20 \
switch-focus-hover 0 50 40 20 \
switch-focus 0 70 40 20 \
switch-hover 40 60 40 20 \
switch-off-dis 90 0 40 20 \
switch-off-focus-hover 90 20 40 20 \
switch-off-focus 90 40 40 20 \
switch-off-hover 80 60 40 20 \
switch-off-pressed 0 90 40 20 \
switch-off-rest 40 80 40 20 \
switch-pressed 80 80 40 20 \
switch-rest 0 110 40 20 \
tab-hover 130 0 32 32 \
tab-rest 130 32 32 32 \
tab-selected 120 64 32 32 \
heading-hover 40 100 22 22 \
heading-pressed 62 100 22 22 \
heading-rest 84 100 22 22 \
slider-thumb-dis 106 100 22 22 \
slider-thumb-focus-hover 128 96 22 22 \
slider-thumb-focus 0 130 22 22 \
slider-thumb-hover 22 130 22 22 \
slider-thumb-pressed 44 122 22 22 \
slider-thumb-rest 66 122 22 22 \
slider-trough-hor 88 122 22 22 \
slider-trough-vert 110 122 22 22 \
button-accent-dis 132 118 20 20 \
button-accent-focus-hover 0 152 20 20 \
button-accent-focus 20 152 20 20 \
button-accent-hover 40 152 20 20 \
button-accent-pressed 60 144 20 20 \
button-accent-rest 80 144 20 20 \
button-dis 100 144 20 20 \
button-focus-hover 120 144 20 20 \
button-focus 140 138 20 20 \
button-hover 162 0 20 20 \
button-pressed 162 20 20 20 \
button-rest 162 40 20 20 \
check-dis 162 60 20 20 \
check-focus-hover 150 96 20 20 \
check-focus 152 116 20 20 \
check-hover 160 136 20 20 \
check-pressed 0 172 20 20 \
check-rest 20 172 20 20 \
check-tri-dis 40 172 20 20 \
check-tri-focus-hover 160 156 20 20 \
check-tri-focus 140 158 20 20 \
check-tri-hover 60 164 20 20 \
check-tri-pressed 80 164 20 20 \
check-tri-rest 100 164 20 20 \
check-unsel-dis 120 164 20 20 \
check-unsel-focus-hover 182 0 20 20 \
check-unsel-focus 182 20 20 20 \
check-unsel-hover 182 40 20 20 \
check-unsel-pressed 182 60 20 20 \
check-unsel-rest 180 80 20 20 \
progressbar-bar-hor 180 100 20 5 \
progressbar-bar-vert 172 80 5 20 \
progressbar-trough-hor 152 80 20 5 \
progressbar-trough-vert 172 100 5 20 \
radio-dis 180 105 20 20 \
radio-focus-hover 180 125 20 20 \
radio-focus 180 145 20 20 \
radio-hover 180 165 20 20 \
radio-pressed 160 176 20 20 \
radio-rest 140 178 20 20 \
radio-unsel-dis 0 192 20 20 \
radio-unsel-focus-hover 20 192 20 20 \
radio-unsel-focus 40 192 20 20 \
radio-unsel-hover 180 185 20 20 \
radio-unsel-pressed 60 184 20 20 \
radio-unsel-rest 80 184 20 20 \
scrollbar-thumb-hor 160 196 20 12 \
scrollbar-thumb-vert 100 184 12 20 \
scrollbar-trough-hor 112 198 20 12 \
scrollbar-trough-vert 202 0 12 20 \
textbox-dis 0 212 20 20 \
textbox-error 20 212 20 20 \
textbox-focus 40 212 20 20 \
textbox-hover 60 210 20 20 \
textbox-rest 80 210 20 20 \
down 40 50 10 5 \
empty 152 64 10 10 \
grip 152 85 10 10 \
right 162 85 5 10 \
sep 202 20 10 10 \
up 40 55 10 5 \
scrollbar-down 132 138 8 6 \
scrollbar-left 44 144 6 8 \
scrollbar-right 50 144 6 8 \
scrollbar-up 172 120 8 6 \
]
Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

+345 -41
View File
@@ -2,13 +2,19 @@
"""Generate C for the ExeFS modules: function discovery, then parallel emission into chunked C files.
Usage: gen.py --exefs build/extracted/v121/exefs --out generated/v121 [--modules main,subsdk0,sdk] [--jobs N]
[--limit N] [--chunk-fns N] [--chunk-bytes B] [--big-fn B] [--patches FILE]
[--limit N] [--chunk-fns N] [--chunk-bytes B] [--big-fn B] [--patches FILE] [--v-locals K [--v-trust]]
[--no-cache] [--fn-enter-all] [--plugins NSO[,NSO...]]
--plugins places a mod's code modules (exlaunch plugins) after sdk as plugin0..N (recomp/layout.py) and lifts them with
the game modules; their DT_INIT and init_array entries are seeds too (Module.init_functions). Without it the output is
what it was before plugins existed.
Output, under --out:
layout.h, layout.json module bases (recomp/layout.py)
<mod>/<mod>_NNNN.c one `void f_<addr>(Cpu *c)` per guest function, about --chunk-bytes of C per file
<mod>/<mod>_table.c sorted <mod>_fn_addrs[] / <mod>_fn_ptrs[] / <mod>_fn_count for rt_dispatch
<mod>/manifest.json chunk list, function count, statistics and timings
<mod>/lift_cache.json per chunk: the key of its inputs, its file's SHA-256, size and mtime, and its results
<mod>/folded.txt the module's bytes the generated code took as constants: what the jump tables read at
lift time, as module offsets [start, end); tools/exefs_patches.py keeps a mod's data
writes off them
@@ -24,8 +30,20 @@ Emission runs in worker processes, one chunk per task. Each worker loads the mod
time and resolves its jump tables (recomp/jumptables.py), so memory per worker does not grow with the module.
Chunks are sized from a per-instruction estimate of the C they produce, so their names and contents only depend on
the input; a chunk whose text did not change is not rewritten and keeps its mtime.
A chunk is not lifted again when its inputs did not change. Its text depends only on the generator (recomp/*.py,
GENERATED_MARKER, the Emitter options), the module (its file, its base, and the function starts discovered from it),
the chunk's number and functions, and the patch sites, spin waits and function hooks inside the chunk's address
range (and whether the patch table has hooks at all): the per-module caches of recomp/jumptables.py are derived from
the module's bytes and base, and its per-function state is reset for each function. The SHA-256 of all of these is the chunk's key. <mod>/lift_cache.json records the key of each chunk
with the SHA-256, size and mtime of the file it wrote and the results the manifest and folded.txt need, under a
digest of the entry. A chunk whose entry is intact, whose key matches and whose file still has that size, mtime and
hash is reused as it is; any other chunk is lifted. So a rebuild after a change to one cheat lifts only the chunks
holding its sites. --no-cache, or TOTK_LIFT_CACHE=0 in the environment, lifts every chunk.
"""
import argparse
import bisect
import hashlib
import json
import multiprocessing as mp
import os
@@ -33,6 +51,7 @@ import re
import sys
import time
from collections import Counter
from concurrent.futures import ThreadPoolExecutor
from pathlib import Path
import numpy as np
@@ -46,9 +65,10 @@ import hostmem # noqa: E402
import jumptables # noqa: E402
import patches # noqa: E402
import regs # noqa: E402
import vlocals # noqa: E402
from check_content import GENERATED_MARKER # noqa: E402
from layout import layout, write as write_layout # noqa: E402
from lifter import hx # noqa: E402
from layout import layout, plugin_files, write as write_layout # noqa: E402
from lifter import Insn, hx # noqa: E402
from module import Module # noqa: E402
TERMINATORS = ('b', 'br', 'ret', 'trap')
@@ -61,7 +81,7 @@ MUSTTAIL = '__attribute__((musttail)) return'
EST_INT = 62
EST_SIMD = 75
EST_SIMD_LDST = 48
EST_FN = 38 # per function: signature, FN_ENTER, closing brace
EST_FN = 38 # per function: signature, FN_ENTER (recomp/patches.py `hook`), closing brace
EST_BR_LABELS = 10 # per instruction of a function with a `br`: switch cases, or labels if it falls back
@@ -69,6 +89,30 @@ def fname(a):
return f'f_{a:x}'
def orig_name(a):
"""The unpatched copy of the function at a that a plugin's replace hook reaches as its original (patches.py `orig`)."""
return f'fo_{a:x}'
def open_module(name, path, base, table, plugin=False):
"""Module name for lifting: a plugin with a `plugin` line of the patch table (recomp/patches.py) is lifted from its
image after the init, its inline-hook stubs returning where they would branch to their trampolines."""
p = table.plugins.get(name)
if not p:
return Module(name, path, base, 'c', plugin=plugin)
image = Path(p['image']).read_bytes()
mod = Module(name, path, base, 'c', plugin=True, image=image, rets=[o + 12 for o in p['stubs']],
seeds=sorted(p['stubs'] | p['seeds']))
t0, t1 = mod.nso.text[0], mod.nso.text[0] + mod.nso.text[1]
if hashlib.sha256(image[t0:t1]).hexdigest() != p['sha256']:
raise patches.PatchError(f'{name}: {p["image"]} is not the image whose .text the patch table names')
for o in p['stubs']:
w = int.from_bytes(image[o + 12:o + 16], 'little')
if not mod.in_text(base + o) or w >> 26 != 0x05:
raise patches.PatchError(f'{name}+{o:#x}: no inline-hook stub (its fourth word {w:08x} is no b)')
return mod
def header(what):
return f'// {GENERATED_MARKER}: {what}, generated by recomp/gen.py from game code. Do not edit or commit.\n'
@@ -209,16 +253,25 @@ def partition(est, max_fns, max_bytes, big_fn):
# ------------------------------------------------------------------------------------------------ emission
class Emitter:
"""C for the functions of one module. starts is the set of every function start of the module."""
"""C for the functions of one module. starts is the set of every function start of the module. A new input of
the C (an argument here, or anything else it reads) must go into the lift cache's key: chunk_key."""
def __init__(self, mod, starts, patched=None, reg_locals=regs.LOCALS, callee_saved=True, spins=None):
def __init__(self, mod, starts, patched=None, reg_locals=regs.LOCALS, callee_saved=True, spins=None,
v_locals=vlocals.LOCALS, v_trust=False, hooks=None, fn_enter_all=False, picks=None, origs=None):
self.mod = mod
self.starts = starts
self.patched = patched or {} # {address: [(set index, [replacement words])]} (recomp/patches.py)
self.picks = picks or {} # {contested site: (pick index, {ordered set: value})} (recomp/patches.py)
self.spins = spins or {} # {spin wait back-edge: its head} (recomp/patches.py `spin`)
self.origs = origs or set() # functions also emitted unpatched, as orig_name() (recomp/patches.py `orig`)
self.reg_locals = reg_locals # recomp/regs.py: registers per function in C locals
self.kept = regs.CALLEE_SAVED if callee_saved else frozenset() # not reloaded after a call
self.v_locals = v_locals # recomp/vlocals.py: V registers per function in C locals (0: all in c->v)
self.v_trust = v_trust # with v_locals: V8-V15 are not reloaded after a call
# Functions that start with FN_ENTER (recomp/patches.py `hook`): None is every function
self.hooks = None if fn_enter_all else hooks
self.uses_patches = False
self.uses_picks = False
self.stats = Counter()
self.unsupported = Counter()
@@ -266,9 +319,12 @@ class Emitter:
alternative may branch (bl, b, b.cond / cbz / tbz, ret)."""
out = []
for _, words in self.patched[a]:
lifted = [self.mod.lifter.lift(w, a) for w in words]
# ('call', target): a plugin's inline hook (recomp/patches.py @call), before the site's own instruction
lifted = [Insn('hook', target=w[1]) if isinstance(w, tuple) else self.mod.lifter.lift(w, a) for w in words]
for j, r in enumerate(lifted):
last = j == len(lifted) - 1
if r.kind == 'hook' and not last:
continue
if r.kind != 'op' and not (last and r.kind in ('bl', 'b', 'bcond', 'ret')):
raise patches.PatchError(f'{a:#x}: replacement word {words[j]:08x} is a {r.kind}')
out.append(lifted)
@@ -347,6 +403,22 @@ class Emitter:
raise patches.PatchError(f'{a:#x}: a patched call that uses flags')
return reads, alts[0][1]
def unpatched_copy(self, entry, end, refs):
"""C of the function [entry, end) without its patched sites, named orig_name(entry): what a plugin's replace
hook calls as the original (its trampoline, recomp/patches.py `orig`). Its own fall-back fb_ is renamed too."""
kept = self.patched
self.patched = {a: alts for a, alts in kept.items() if not entry <= a < end}
try:
lines, r = self.function(entry, end)
finally:
self.patched = kept
refs |= r
text = '\n'.join(lines).replace(f'fb_{entry:x}(', f'fbo_{entry:x}(')
head = f'void {fname(entry)}(Cpu *c) {{'
if head not in text:
raise patches.PatchError(f'{entry:#x}: no function head to rename for its unpatched copy')
return text.replace(head, f'void {orig_name(entry)}(Cpu *c) {{', 1)
def function(self, entry, end):
"""(lines of C, referenced function starts) for the guest function [entry, end)."""
mod, starts = self.mod, self.starts
@@ -387,6 +459,7 @@ class Emitter:
self.stats['external_branches'] += 1
return f'{publish(i)}{spill}c->pc = {hx(t)}; {MUSTTAIL} rt_dispatch(c);'
enter = [f' FN_ENTER({hx(entry)});'] if self.hooks is None or entry in self.hooks else []
if all_labels:
# An unresolved computed br re-enters the function through fb_<entry>, which switches on c->pc to any
# instruction. A goto to a shared dispatch block inside the body instead turns every instruction into
@@ -395,13 +468,13 @@ class Emitter:
cases = ' '.join(f'case {hx(t)}: goto L_{t:x};' for t in range(entry, end, 4))
redispatch = f'{MUSTTAIL} {fb}(c);'
out = [f'static void {fb}(Cpu *c);',
f'void {fname(entry)}(Cpu *c) {{', f' FN_ENTER({hx(entry)});', f' c->pc = {hx(entry)};',
f'void {fname(entry)}(Cpu *c) {{', *enter, f' c->pc = {hx(entry)};',
f' {redispatch}', '}',
f'static void {fb}(Cpu *c) {{', f' switch (c->pc) {{ {cases} default: break; }}',
f' {MUSTTAIL} rt_dispatch(c);']
else:
redispatch = f'{MUSTTAIL} rt_dispatch(c);'
out = [f'void {fname(entry)}(Cpu *c) {{', f' FN_ENTER({hx(entry)});']
out = [f'void {fname(entry)}(Cpu *c) {{', *enter]
if fp.used:
out.append(' ' + fp.decl())
@@ -428,16 +501,26 @@ class Emitter:
return f'if ({fx(i, r.cond)}) {{ {jump(r.target, i)} }}'
if r.kind == 'ret':
return f'{spill}return;'
if r.kind == 'hook':
# a call that writes no x30, the whole Cpu current before it and read back after it: the stub saves and
# restores x30 itself, and the callback may change any register through exlaunch's hook context
refs.add(r.target)
self.stats['plugin_hook_calls'] += 1
return f'{spill}{fname(r.target)}(c);{reload}'
raise patches.PatchError(f'{a:#x}: patched instruction is a {r.kind}')
def patch(i, ins, a):
"""if (switch) { replacement } else if ... else { original } for a patched site (recomp/patches.py)."""
"""if (switch) { replacement } else if ... else { original } for a patched site (recomp/patches.py); an
ordered set of a contested site tests the site's pick byte instead of its switch."""
if ins.kind not in ('op', 'bl', 'b', 'bcond'):
raise patches.PatchError(f'{a:#x}: patched instruction is a {ins.kind}')
line = ' '
n, values = self.picks.get(a, (None, {}))
for (k, _), words in zip(self.patched[a], self.replacements(a)):
line += f' if (rt_patch_on[{k}]) {{ {" ".join(one(i, r, a) for r in words)} }} else'
test = f'rt_patch_pick[{n}] == {values[k]}' if k in values else f'rt_patch_on[{k}]'
line += f' if ({test}) {{ {" ".join(one(i, r, a) for r in words)} }} else'
self.uses_patches = True
self.uses_picks |= bool(values)
self.stats['patched_sites'] += 1
return f'{line} {{ {one(i, ins, a)} }}'
@@ -504,6 +587,8 @@ class Emitter:
else:
out += [line for _, line in body]
out.append('}')
if self.v_locals:
out = vlocals.rewrite('\n'.join(out), self.v_locals, self.v_trust, self.stats).split('\n')
self.stats['functions'] += 1
self.stats['instructions'] += len(insns)
return out, refs
@@ -512,22 +597,28 @@ class Emitter:
def chunk_text(name, number, emitter, fns):
"""C text of one chunk. fns: [(entry, end)]."""
body, refs = [], set()
emitter.uses_patches = False
emitter.uses_patches = emitter.uses_picks = False
for entry, end in fns:
lines, r = emitter.function(entry, end)
body.append('\n'.join(lines))
refs |= r
if entry in emitter.origs:
body.append(emitter.unpatched_copy(entry, end, refs))
# Every referenced function gets a prototype, including ones defined later in this chunk.
protos = ''.join(f'void {fname(r)}(Cpu *c);\n' for r in sorted(refs))
if emitter.uses_patches:
protos += 'extern uint8_t rt_patch_on[];\n'
return (header(f'{name} chunk {number:04d}') + '#include "cpu.h"\n#include "simd.h"\n\n' + protos + '\n'
+ '\n\n'.join(body) + '\n')
if emitter.uses_picks:
protos += 'extern uint8_t rt_patch_pick[];\n'
vdef = '#define RT_VLOCALS 1\n' if emitter.v_locals else '' # runtime/simd.h: the V-locals accessors
return (header(f'{name} chunk {number:04d}') + vdef + '#include "cpu.h"\n#include "simd.h"\n\n' + protos
+ '\n' + '\n\n'.join(body) + '\n')
def write_if_changed(path, text):
def write_if_changed(path, text, wait=True):
"""Returns True if the file was written. An unchanged file keeps its mtime, so the build skips it. A changed one
is written under a temporary name and renamed into place, so a reader never sees it half written."""
is written under a temporary name and renamed into place, so a reader never sees it half written. wait: retry
the rename while another process holds the file (_retry); without it the first failure raises."""
data = text.encode()
try:
if path.stat().st_size == len(data) and path.read_bytes() == data:
@@ -537,7 +628,10 @@ def write_if_changed(path, text):
tmp = path.with_name(f'.{path.name}.{os.getpid()}.tmp')
tmp.write_bytes(data)
try:
_retry(os.replace, tmp, path)
if wait:
_retry(os.replace, tmp, path)
else:
os.replace(tmp, path)
except OSError:
tmp.unlink(missing_ok=True)
raise
@@ -576,7 +670,7 @@ def _emitter(name):
e = _W['emitters'].get(name)
if e is None:
path, base = _W['mods'][name]
mod = Module(name, path, base, 'c')
mod = open_module(name, path, base, _W['patches'])
# Module.read is how the jump tables (recomp/jumptables.py _eval) read .text and .rodata at lift time: the
# bytes it returns become part of the generated code, so <mod>/folded.txt lists them
read, reads = mod.read, _W['reads'].setdefault(name, [])
@@ -587,7 +681,10 @@ def _emitter(name):
mod.read = recorded
e = _W['emitters'][name] = Emitter(mod, set(_W['starts'][name].tolist()),
_W['patches'].for_module(name, base),
spins=_W['patches'].spins_for(name, base), **_W['opts'])
spins=_W['patches'].spins_for(name, base),
hooks=_W['patches'].hooks_for(name, base),
picks=_W['patches'].picks_for(name, base),
origs=_W['patches'].origs_for(name, base), **_W['opts'])
return e
@@ -603,8 +700,8 @@ def merge_ranges(ranges):
def _emit_chunk(task):
"""Worker: write one chunk. Returns its statistics."""
name, number, path, fns = task
"""Worker: write one chunk. Returns its statistics, and the SHA-256, size and mtime of its file for the cache."""
name, number, path, fns, key = task
t0 = time.perf_counter()
# Test hook: a pool wider than this raises the MemoryError a busy machine does, so the retry can be exercised.
limit = os.environ.get('TOTK_LIFT_TEST_OOM_ABOVE')
@@ -614,28 +711,37 @@ def _emit_chunk(task):
e.stats.clear()
e.unsupported.clear()
text = chunk_text(name, number, e, fns)
error = None
error, st = None, None
try:
written = write_if_changed(Path(path), text)
st = os.stat(path)
except OSError as ex:
written, error = False, f'{path}: {ex}'
reads = _W['reads'].get(name, [])
folded = merge_ranges(reads)
reads.clear()
return {'module': name, 'number': number, 'file': Path(path).name, 'functions': len(fns), 'bytes': len(text),
'written': written, 'error': error, 'seconds': time.perf_counter() - t0, 'stats': dict(e.stats),
'unsupported': dict(e.unsupported), 'folded': folded}
'written': written, 'reused': False, 'error': error, 'seconds': time.perf_counter() - t0,
'stats': dict(e.stats), 'unsupported': dict(e.unsupported), 'folded': folded, 'key': key,
'sha256': _sha256(text.encode()), 'size': st.st_size if st else None,
'mtime_ns': st.st_mtime_ns if st else None}
# ------------------------------------------------------------------------------------------------ driver
def table_text(name, addrs):
def table_text(name, addrs, extra=None):
"""<mod>_table.c: the function starts and their C; extra {address: C function name} adds entries of functions
lifted elsewhere (a plugin's trampoline reaching the unpatched copy of a game function, recomp/patches.py `orig`)."""
extra = extra or {}
names = {a: fname(a) for a in addrs if a not in extra}
names.update(extra)
addrs = sorted(names)
lines = [header(f'{name} function table'), '#include "cpu.h"\n\n']
lines += [f'void {fname(a)}(Cpu *c);\n' for a in addrs]
lines += [f'void {names[a]}(Cpu *c);\n' for a in addrs]
lines.append(f'\nconst uint64_t {name}_fn_addrs[] = {{\n')
lines.append(',\n'.join(hx(a) for a in addrs))
lines.append(f'\n}};\nconst GuestFn {name}_fn_ptrs[] = {{\n')
lines.append(',\n'.join(fname(a) for a in addrs))
lines.append(',\n'.join(names[a] for a in addrs))
lines.append(f'\n}};\nconst uint64_t {name}_fn_count = {len(addrs)};\n')
return ''.join(lines)
@@ -663,6 +769,129 @@ def remove_stale(moddir, name, nchunks, errors):
return removed
# ------------------------------------------------------------------------------------------------ lift cache
CACHE_FILE = 'lift_cache.json'
CACHE_VERSION = 1 # raise when the cache's format or the meaning of its key changes
# Per-chunk results the cache keeps beside the key: what the manifest, folded.txt and the reuse check need.
CACHED = ('functions', 'bytes', 'stats', 'unsupported', 'folded', 'sha256', 'size', 'mtime_ns')
def _sha256(data):
return hashlib.sha256(data).hexdigest()
def _key(*parts):
"""SHA-256 of JSON-encodable parts."""
return _sha256(json.dumps(parts, separators=(',', ':')).encode())
def generator_key(opts):
"""Key of everything the chunk text depends on besides the module and the patches: the generator's sources
(recomp/*.py, not the patch tables beside them), the marker in each header, the Emitter options, the Python
version that runs them."""
srcs = [[p.name, _sha256(p.read_bytes())] for p in sorted((ROOT / 'recomp').glob('*.py'))]
return _key('gen', CACHE_VERSION, list(sys.version_info[:2]), GENERATED_MARKER, sorted(opts.items()), srcs)
def module_key(gen_key, name, path, base, abs_starts):
"""Key of one module's inputs: the generator, the module's file and base, and the function starts discovered
from them (they decide which branches become direct calls)."""
return _key(gen_key, name, _sha256(Path(path).read_bytes()), base, _sha256(abs_starts.tobytes()))
def in_span(addrs, lo, hi):
"""The addresses of the sorted list addrs in [lo, hi)."""
return addrs[bisect.bisect_left(addrs, lo):bisect.bisect_left(addrs, hi)]
def chunk_key(mod_key, number, fns, patched, site_addrs, spins, spin_addrs, hook_addrs, picks=None, origs=None):
"""Key of one chunk: its module, number (in its header) and functions, and the patch sites (set index and
replacement words, @page resolved, so the patch page is in them), the pick index and values of its contested
sites, spin waits and hooked functions inside its address range; hook_addrs None (FN_ENTER in every function) keys
apart from an empty list. Every input of the chunk text that is not in generator_key or module_key must be added
here, with a case in tests/lift_cache_test.py."""
lo, hi = fns[0][0], fns[-1][1]
in_chunk = in_span(site_addrs, lo, hi)
sites = [[a, [[k, [list(w) if isinstance(w, tuple) else w for w in words]] for k, words in patched[a]]]
for a in in_chunk]
hooks = None if hook_addrs is None else in_span(hook_addrs, lo, hi)
contested = [[a, picks[a][0], sorted(picks[a][1].items())] for a in in_chunk if a in (picks or {})]
parts = [mod_key, number, fns, sites, [[b, spins[b]] for b in in_span(spin_addrs, lo, hi)], hooks, contested]
copies = [e for e, _ in fns if e in (origs or ())]
if copies: # none: the key it had before plugins
parts.append(copies)
return _key(*parts)
def _entry_check(file, entry):
"""Digest of a cache entry: its chunk file name, key and results. The results go into the manifest and folded.txt
as they are, so a changed value in the cache file must not be taken (tools/exefs_patches.py --folded keeps a
mod's data writes off the folded bytes)."""
return _key(file, entry['key'], [entry[k] for k in CACHED])
def load_cache(moddir):
"""{chunk file name: entry} from <mod>/lift_cache.json: the entries whose digest matches; empty when the file is
missing or unreadable."""
try:
data = json.loads((moddir / CACHE_FILE).read_text())
if data.get('version') != CACHE_VERSION or not isinstance(data.get('chunks'), dict):
return {}
out = {}
for file, e in data['chunks'].items():
try:
if e['check'] == _entry_check(file, e):
out[file] = e
except (KeyError, TypeError):
pass
return out
except (OSError, ValueError, AttributeError):
return {}
def _intact(path, entry):
"""True when the file at path still is the one the entry recorded: same size and mtime, then same SHA-256 (a bit
flipped in a kept file would otherwise stay forever, as tools/build_game.py check_objects says of objects)."""
try:
st = path.stat()
if st.st_size != entry['size'] or st.st_mtime_ns != entry['mtime_ns']:
return False
return _sha256(path.read_bytes()) == entry['sha256']
except (OSError, KeyError, TypeError):
return False
def reuse(tasks, caches):
"""The results of the tasks whose chunk can be reused: its recorded key equals the task's and its file is intact.
The files are hashed on threads (hashlib releases the GIL), about 1 GB in all for the three modules."""
cands = []
for name, number, path, fns, key in tasks:
e = caches.get(name, {}).get(Path(path).name)
if e is not None and e['key'] == key:
cands.append((name, number, Path(path), key, e))
with ThreadPoolExecutor(min(16, os.cpu_count() or 4)) as ex:
ok = list(ex.map(lambda c: _intact(c[2], c[4]), cands))
out = []
for (name, number, path, key, e), good in zip(cands, ok):
if good:
out.append({'module': name, 'number': number, 'file': path.name, 'written': False, 'reused': True,
'error': None, 'seconds': 0.0, 'key': key, **{k: e[k] for k in CACHED}})
return out
def cache_text(name, results):
"""<mod>/lift_cache.json for this run's chunks; a chunk that could not be written gets no entry. Keys keep their
order (no sort_keys), so a reused chunk's `unsupported` merges into the census as it did when it was lifted."""
chunks = {}
for r in results:
if not r['error'] and r['size'] is not None:
e = {'key': r['key'], **{k: r[k] for k in CACHED}}
chunks[r['file']] = {**e, 'check': _entry_check(r['file'], e)}
return json.dumps({'module': name, 'marker': GENERATED_MARKER, 'version': CACHE_VERSION, 'chunks': chunks},
separators=(',', ':')) + '\n'
# Peak memory of one emit worker on 1.4.3 is 1.3 GiB (1.5 GiB with margin); the parent holds about 0.7 GiB.
WORKER_MEM = 1536 << 20
MEM_SHARE = 0.8 # of the free memory the workers may take, the rest is for the system and other programs
@@ -692,7 +921,10 @@ def main():
ap = argparse.ArgumentParser(description=__doc__.splitlines()[0])
ap.add_argument('--exefs', type=Path, required=True)
ap.add_argument('--out', type=Path, required=True)
ap.add_argument('--modules', default='main,subsdk0,sdk')
ap.add_argument('--modules', default='main,subsdk0,sdk', help='modules to lift (default main,subsdk0,sdk and every '
'--plugins module)')
ap.add_argument('--plugins', default='', help='comma-separated plugin NSOs (exefs/subsdk* of a mod), in mod load '
'order: lifted as plugin0..N after sdk')
ap.add_argument('--jobs', type=int, help='emit workers (default: by free memory and CPU count)')
ap.add_argument('--limit', type=int, default=0, help='emit only the first N functions of each module')
ap.add_argument('--chunk-fns', type=int, default=3000, help='functions per chunk at most')
@@ -705,15 +937,34 @@ def main():
ap.add_argument('--no-callee-saved-trust', action='store_true',
help='reload X19-X29 and SP after every call too, instead of trusting AAPCS64 (slower; for '
'telling a broken callee from a generator bug)')
ap.add_argument('--v-locals', type=int, default=vlocals.LOCALS,
help='V registers per function kept in C locals that clang holds in XMM registers, the most used '
f'ones (recomp/vlocals.py; default {vlocals.LOCALS}, 0: all in the Cpu)')
ap.add_argument('--v-trust', action='store_true',
help='with --v-locals: do not reload V8-V15 after a call (AAPCS64: the callee preserves their low '
'64 bits)')
ap.add_argument('--fn-enter-all', action='store_true',
help='FN_ENTER (runtime/cpu.h) in every function, also with hook lines in the patch table '
'(recomp/patches.py `hook`): a whole-game function-entry profile')
ap.add_argument('--no-cache', action='store_true',
help=f'lift every chunk, also those whose inputs match <mod>/{CACHE_FILE} (it is written anew); '
'so does the environment variable TOTK_LIFT_CACHE=0')
args = ap.parse_args()
opts = {'reg_locals': args.reg_locals, 'callee_saved': not args.no_callee_saved_trust}
# The installer's lift step passes no --no-cache; the environment reaches it, as TOTK_LIFT_JOBS does (pick_jobs)
no_cache = ('--no-cache' if args.no_cache else
'TOTK_LIFT_CACHE=0' if os.environ.get('TOTK_LIFT_CACHE', '').strip() == '0' else None)
opts = {'reg_locals': args.reg_locals, 'callee_saved': not args.no_callee_saved_trust, 'v_locals': args.v_locals,
'v_trust': args.v_trust, 'fn_enter_all': args.fn_enter_all}
gen_key = generator_key(opts)
t0 = time.perf_counter()
mods = layout(args.exefs)
write_layout(mods, args.out)
plugins = [Path(p) for p in args.plugins.split(',') if p]
mods = layout(args.exefs, plugins)
files = plugin_files(plugins)
write_layout(mods, args.out, files)
table = patches.load(args.patches, mods) if args.patches else patches.Table()
write_if_changed(args.out / 'patches.h', patches.header_text(table, GENERATED_MARKER))
want = args.modules.split(',')
want = args.modules.split(',') + list(files)
unknown = set(want) - {n for n, _, _ in mods}
if unknown:
raise SystemExit(f'not in {args.exefs}: {", ".join(sorted(unknown))}')
@@ -723,8 +974,8 @@ def main():
if name not in want:
continue
t = time.perf_counter()
path = args.exefs / name
mod = Module(name, path, base, 'c')
path = Path(files[name][0]) if name in files else args.exefs / name
mod = open_module(name, path, base, table, plugin=name in files)
patches.check(table, mod, name)
starts, dstats = discover(mod)
est = estimate_sizes(mod, starts)
@@ -734,12 +985,39 @@ def main():
chunks = partition(est[:n], args.chunk_fns, args.chunk_bytes, args.big_fn)
moddir = args.out / name
moddir.mkdir(parents=True, exist_ok=True)
extra = table.orig_entries(name, {n: b for n, b, _ in mods})
if extra: # a trampoline reaches another function's unpatched copy, not a lift of its own words
keep = ~np.isin(abs_starts, np.array(sorted(extra), dtype=abs_starts.dtype))
starts, est, abs_starts = starts[keep], est[keep], abs_starts[keep]
n = len(starts) if not args.limit else min(args.limit, len(starts))
ends = np.append(abs_starts[1:], mod.hi)
chunks = partition(est[:n], args.chunk_fns, args.chunk_bytes, args.big_fn)
missing = sorted(base + o for o in (table.plugins.get(name) or {}).get('seeds', ())
if base + o not in set(abs_starts.tolist()))
if missing:
raise SystemExit(f'{name}: the seeds {", ".join(hex(a) for a in missing)} are no function starts')
mkey = module_key(gen_key, name, path, base, abs_starts)
if table.plugin_inputs(name):
mkey = _key(mkey, table.plugin_inputs(name), _sha256(Path(table.plugins[name]['image']).read_bytes()))
patched, spins, picks = table.for_module(name, base), table.spins_for(name, base), table.picks_for(name, base)
origs = table.origs_for(name, base)
bad = sorted(origs - set(abs_starts.tolist()))
if bad:
raise SystemExit(f'{args.patches}: orig {", ".join(hex(a) for a in bad)} is no function start of {name}')
site_addrs, spin_addrs = sorted(patched), sorted(spins)
hooks = None if args.fn_enter_all else table.hooks_for(name, base)
stray = sorted(set(hooks or ()) - set(abs_starts.tolist()))
if stray:
raise SystemExit(f'{args.patches}: hook {", ".join(f"{name}+{a - base:#x}" for a in stray)} is no function '
f'start of {name}')
hook_addrs = None if hooks is None else sorted(hooks)
for number, (i0, i1) in enumerate(chunks):
fns = list(zip(abs_starts[i0:i1].tolist(), ends[i0:i1].tolist()))
tasks.append((int(est[i0:i1].sum()), (name, number, str(moddir / f'{name}_{number:04d}.c'), fns)))
key = chunk_key(mkey, number, fns, patched, site_addrs, spins, spin_addrs, hook_addrs, picks, origs)
tasks.append((int(est[i0:i1].sum()), (name, number, str(moddir / f'{name}_{number:04d}.c'), fns, key)))
paths[name] = (str(path), base)
starts_abs[name] = abs_starts
info[name] = {'base': base, 'lo': mod.lo, 'hi': mod.hi, 'emitted': abs_starts[:n].tolist(),
info[name] = {'base': base, 'lo': mod.lo, 'hi': mod.hi, 'emitted': abs_starts[:n].tolist(), 'extra': extra,
'chunks': len(chunks), 'discover': dstats, 'discover_seconds': time.perf_counter() - t,
'moddir': moddir}
print(f'{name}: {dstats["functions"]} functions ({dstats["seeds"]} seeds, {dstats["rounds"]} rounds), '
@@ -755,9 +1033,23 @@ def main():
ctx = mp.get_context('spawn')
jobs, why = pick_jobs(args.jobs)
pending = [t for _, t in tasks]
emitted = 0
while True:
print(f'emitting with {jobs} workers ({why})', file=sys.stderr, flush=True)
reused = [] if no_cache else reuse(pending, {name: load_cache(d['moddir']) for name, d in info.items()})
for r in reused:
results[r['module']].append(r)
folded[r['module']] += r['folded']
skip = {(r['module'], r['number']) for r in reused}
pending = [t for t in pending if (t[0], t[1]) not in skip]
emitted = len(reused)
print(f'reusing {len(reused)} of {len(tasks)} chunks (inputs unchanged), {time.perf_counter() - t_emit:.1f}s'
if not no_cache else f'lifting every chunk ({no_cache})', file=sys.stderr, flush=True)
if reused or not pending:
# installer/steps.py EMITTED reads these lines for its progress bar: the reused chunks count as done, and a
# run with nothing to lift still reaches M/M
print(f'emitted {emitted}/{len(tasks)} chunks, 0s', file=sys.stderr, flush=True)
if len(pending) < jobs:
jobs, why = max(1, len(pending)), f'{len(pending)} chunk{"s" if len(pending) != 1 else ""} to lift'
while pending:
print(f'emitting with {jobs} worker{"s" if jobs != 1 else ""} ({why})', file=sys.stderr, flush=True)
try:
# Chunk writes are atomic and idempotent, so a chunk lost with a failed pool is simply emitted again.
# Its folded bytes come with its result: a chunk emitted again reads them again in its new worker.
@@ -790,7 +1082,8 @@ def main():
stats.update(r['stats'])
unsupported.update(r['unsupported'])
t = time.perf_counter()
table_written = write_if_changed(moddir / f'{name}_table.c', table_text(name, d['emitted']))
table_written = write_if_changed(moddir / f'{name}_table.c', table_text(
name, d['emitted'], {t: orig_name(f) for t, f in d['extra'].items()}))
write_if_changed(moddir / 'folded.txt', folded_text(name, merge_ranges(folded[name])))
removed = remove_stale(moddir, name, d['chunks'], errors)
manifest = {
@@ -827,7 +1120,9 @@ def main():
'c_bytes': sum(r['bytes'] for r in rs),
'largest_chunk_bytes': max((r['bytes'] for r in rs), default=0),
'chunks_written': sum(r['written'] for r in rs) + table_written,
'chunks_reused': sum(r['reused'] for r in rs),
'stale_chunks_removed': removed,
**{k: v for k, v in sorted(stats.items()) if k.startswith('v_')}, # --v-locals only
},
'unsupported_census': dict(unsupported.most_common(50)),
'timings': {
@@ -838,8 +1133,17 @@ def main():
},
}
write_if_changed(moddir / 'manifest.json', json.dumps(manifest, indent=1) + '\n')
# The cache goes last, after every output it describes. It only saves time, so a failed write warns and the
# lift still succeeds, without waiting for a holder of the file: the previous cache stays, and its entries
# for the chunks this run rewrote no longer match their files' size, mtime and hash. A run stopped before
# here leaves it the same way.
try:
write_if_changed(moddir / CACHE_FILE, cache_text(name, rs), wait=False)
except OSError as ex:
print(f'{name}: {CACHE_FILE} not written, the next lift reuses less: {ex}', file=sys.stderr, flush=True)
s = manifest['stats']
print(f'{name}: {s["emitted_functions"]} functions, {len(rs)} chunks, {s["c_bytes"] / 1e6:.0f} MB of C, '
print(f'{name}: {s["emitted_functions"]} functions, {len(rs)} chunks ({s["chunks_reused"]} reused), '
f'{s["c_bytes"] / 1e6:.0f} MB of C, '
f'{s["jump_tables"]} jump tables, {s["all_label_fallbacks"]} all-label fallbacks, '
f'{s["br_dispatch"]} br via dispatch, {s["traps"]} traps ({s["unsupported"]} unsupported)',
file=sys.stderr)
+35 -13
View File
@@ -6,9 +6,12 @@ calls layout() and writes the result into generated/<version>/layout.h and layou
build read.
Modules are placed in Horizon's load order (rtld is dropped; the host links the modules):
main, subsdk0..9, sdk. Each base is aligned to 2 MiB. Everything must stay below 2^39, the limit of the addresses
IPC buffers can encode.
main, subsdk0..9, sdk. A mod's code modules (exlaunch plugins such as an exefs/subsdk9) follow sdk as plugin0, plugin1,
... in mod load order, so the game modules keep their bases with or without them (after the plugin design in #845 by
itaskaev2). Each base is aligned to 2 MiB. Everything must stay below 2^39, the limit of the addresses IPC buffers can
encode.
"""
import hashlib
import json
from pathlib import Path
@@ -24,14 +27,18 @@ def align_up(v, a=ALIGN):
return (v + a - 1) & ~(a - 1)
def layout(exefs):
"""[(name, base, size)] for the modules present in the ExeFS directory, in load order."""
def plugin_name(i):
return f'plugin{i}'
def layout(exefs, plugins=()):
"""[(name, base, size)] for the modules present in the ExeFS directory, then the plugin NSOs (paths, in mod load
order) as plugin0..N, in load order."""
exefs = Path(exefs)
paths = [(name, exefs / name) for name in ORDER if (exefs / name).exists()]
paths += [(plugin_name(i), Path(p)) for i, p in enumerate(plugins)]
out, base = [], FIRST_BASE
for name in ORDER:
path = exefs / name
if not path.exists():
continue
for name, path in paths:
size = Nso(str(path)).size
out.append((name, base, size))
base = align_up(base + size)
@@ -40,12 +47,27 @@ def layout(exefs):
return out
def write(mods, outdir):
"""layout.json for Python tools and layout.h for the runtime."""
def plugin_files(plugins):
"""{plugin<N>: (absolute path, SHA-256 of the NSO)} for layout.json: the build and the runtime read a plugin from its
mod folder, not from the ExeFS directory, and check that it is the file the code was lifted from."""
return {plugin_name(i): (Path(p).resolve().as_posix(), hashlib.sha256(Path(p).read_bytes()).hexdigest())
for i, p in enumerate(plugins)}
def write(mods, outdir, files=None):
"""layout.json for Python tools and layout.h for the runtime. files: plugin_files() for the plugin entries, which
carry them as "file" and "sha256"; without plugins both files are what they were before plugins existed."""
files = files or {}
outdir = Path(outdir)
outdir.mkdir(parents=True, exist_ok=True)
(outdir / 'layout.json').write_text(json.dumps(
[{'name': n, 'base': f'{b:#x}', 'size': f'{s:#x}'} for n, b, s in mods], indent=1) + '\n')
def entry(n, b, s):
e = {'name': n, 'base': f'{b:#x}', 'size': f'{s:#x}'}
if n in files:
e['file'], e['sha256'] = files[n]
return e
(outdir / 'layout.json').write_text(json.dumps([entry(n, b, s) for n, b, s in mods], indent=1) + '\n')
lines = ['// Module layout chosen by recomp/layout.py. Generated; do not edit.', '#pragma once', '']
for n, b, s in mods:
lines.append(f'#define MOD_{n.upper()}_BASE {b:#x}ull')
@@ -56,6 +78,6 @@ def write(mods, outdir):
def read(outdir):
"""[(name, base, size)] from a layout.json written by write()."""
"""[(name, base, size)] from a layout.json written by write() (a plugin's file and hash left out)."""
data = json.loads((Path(outdir) / 'layout.json').read_text())
return [(m['name'], int(m['base'], 16), int(m['size'], 16)) for m in data]
+2 -1
View File
@@ -352,7 +352,8 @@ class Lifter:
dst = {
(3, 3, 13, 0, 2): 'c->tpidr = {v};',
(3, 3, 4, 2, 0): 'c->nzcv = {v} & 0xf0000000ull;',
(3, 3, 4, 4, 0): 'c->fpcr = {v} & 0x7c00000ull; rt_fpcr_sync(c);' if self.sc else 'rt_set_fpcr({v});',
(3, 3, 4, 4, 0): ('c->fpcr = {v} & 0x7c00000ull; rt_fpcr_sync(c); RT_FPCR_NOTE(c, c->x[30]);' if self.sc
else 'rt_set_fpcr({v});'),
(3, 3, 4, 4, 1): 'c->fpsr = {v} & 0xf800009full;' if self.sc else 'rt_set_fpsr({v});',
}.get(key)
if dst is None:
+37 -4
View File
@@ -10,8 +10,9 @@ from collections import OrderedDict
import numpy as np
from lifter import Insn, Lifter, Unsupported, hx
from nso import Nso, R_AARCH64_RELATIVE
from nso import DT_INIT, DT_INIT_ARRAY, DT_INIT_ARRAYSZ, Nso, R_AARCH64_RELATIVE
RET = 0xD65F03C0
LIFT_CACHE = 1 << 16 # lifted instructions kept per module; analyses revisit nearby addresses only
@@ -33,12 +34,27 @@ def _read_encoded(img, off, enc, pc_base):
class Module:
def __init__(self, name, path, base, simd='c'):
def __init__(self, name, path, base, simd='c', plugin=False, image=None, rets=(), seeds=()):
"""image, rets, seeds: a plugin's lift (recomp/patches.py `plugin`): its .text is taken from image (the plugin's
image after its init, holding the hook stubs and trampolines the file has as zeros), the words at the image
offsets rets become `ret` (an inline-hook stub's b to its trampoline), and the image offsets seeds are function
starts too."""
self.name = name
self.nso = Nso(str(path))
self.base = base
self.plugin = plugin # a mod's code module (recomp/layout.py plugin<N>): its init functions are seeds too
n = self.nso
self.image = bytes(n.image)
if image is not None:
t0, t1 = n.text[0], n.text[0] + n.text[1]
if len(image) < t1:
raise ValueError(f'{name}: the image after the init is shorter than its .text')
img = bytearray(self.image)
img[t0:t1] = image[t0:t1]
for o in rets:
img[o:o + 4] = RET.to_bytes(4, 'little')
self.image = bytes(img)
self.extra_seeds = [base + o for o in seeds]
self.lo = base + n.text[0]
self.hi = self.lo + n.text[1]
self.words = np.frombuffer(self.image, dtype='<u4', count=n.text[1] // 4, offset=n.text[0])
@@ -83,7 +99,7 @@ class Module:
def eh_frame_functions(self):
"""Function starts from .eh_frame_hdr's binary search table (absolute addresses)."""
img, hdr = self.image, self.nso.eh_start
if not hdr or hdr >= len(img):
if not hdr or hdr >= len(img) or self.nso.eh_end <= hdr: # MOD0 with an empty .eh_frame_hdr range (exlaunch)
return []
_, ptr_enc, cnt_enc, tbl_enc = img[hdr:hdr + 4]
off = hdr + 4
@@ -100,9 +116,26 @@ class Module:
starts.append(self.base + loc)
return starts
def init_functions(self):
"""DT_INIT and the DT_INIT_ARRAY entries (absolute addresses). rtld calls DT_INIT only; the module's DT_INIT
runs the array through blr (SDK and exlaunch modules alike), so the entries are seeds too. An entry holds its
target as the addend of its R_AARCH64_RELATIVE relocation, or as the word itself when no relocation names it."""
dyn, out = self.nso.dyn, []
if dyn.get(DT_INIT):
out.append(self.base + dyn[DT_INIT])
if dyn.get(DT_INIT_ARRAY):
addends = {off: add for off, typ, _, add in self.nso.relocs if typ == R_AARCH64_RELATIVE}
for off in range(dyn[DT_INIT_ARRAY], dyn[DT_INIT_ARRAY] + dyn.get(DT_INIT_ARRAYSZ, 0), 8):
out.append(self.base + addends.get(off, self.nso.u64(off)))
return out
def seeds(self):
"""Known function starts: .eh_frame_hdr, exported FUNC symbols, R_AARCH64_RELATIVE targets in .text."""
"""Known function starts: .eh_frame_hdr, exported FUNC symbols, R_AARCH64_RELATIVE targets in .text; for a
plugin also its init functions (exlaunch's DT_INIT starts inside a function discovery would merge it into)."""
starts = set(self.eh_frame_functions())
if self.plugin:
starts.update(self.init_functions())
starts.update(self.extra_seeds)
for _, info, shndx, value, _ in self.nso.syms:
if shndx and (info & 0xF) == 2:
starts.add(self.base + value)
+1 -1
View File
@@ -7,7 +7,7 @@ from collections import Counter
import lz4.block
DT_NULL, DT_NEEDED, DT_PLTRELSZ, DT_HASH, DT_STRTAB, DT_SYMTAB, DT_RELA, DT_RELASZ = 0, 1, 2, 4, 5, 6, 7, 8
DT_STRSZ, DT_JMPREL, DT_RELACOUNT = 10, 23, 0x6FFFFFF9
DT_STRSZ, DT_INIT, DT_JMPREL, DT_INIT_ARRAY, DT_INIT_ARRAYSZ, DT_RELACOUNT = 10, 12, 23, 25, 27, 0x6FFFFFF9
DT_RELRSZ, DT_RELR, DT_GNU_HASH = 0x23, 0x24, 0x6FFFFEF5
R_AARCH64_ABS64, R_AARCH64_GLOB_DAT, R_AARCH64_JUMP_SLOT, R_AARCH64_RELATIVE = 257, 1025, 1026, 1027
+70
View File
@@ -10,6 +10,10 @@ set cloth TOTK_CLOTH_REALTIME 1
set bounce TOTK_HIGHFPS_FIX 1
set output TOTK_PATCH_OUTPUT 0
set scene TOTK_PATCH_SCENE 0
set shadow TOTK_PATCH_SHADOW 0
set cascade TOTK_PATCH_CASCADE 0
# Load-dependent quality (patches-v121.txt explains it): no sites found in this version yet, so the setting does nothing.
set steady TOTK_LOD_STEADY 0
# 60 fps: the adaptive present-interval controller (main+0x8f26c8, 1.0.0 0x8f6bec) gets the minimum interval 1.
site fps60 main 90e978 6b08015f 7100055f # clamp: cmp w10, #1 (was cmp w10, w8 = minimum)
@@ -66,6 +70,72 @@ site scene main cea5e0 5e21d900 @page:x9 # scvtf s0, s8 -> adrp x9, page
site scene main cea5e8 bd0cc660 2d420520 # str s0, [x19, #0xcc4] -> ldp s0, s1, [x9, #16]
site scene main cea5ec 5e21d921 bd0cc660 # scvtf s1, s9 -> str s0, [x19, #0xcc4]
# Equipment-switch cooldown (issue #18): the player update tests state +0x109c against FLT_EPSILON,
# while the equipment gate (main+0x7f0134) blocks changes above zero. Step every positive remainder through
# main+0xa26bb0, including (0, FLT_EPSILON], so a measured frame ratio cannot leave equipment locked.
site realtime main a20518 1e270101 1e2703e1 # fmov s1, w8 (FLT_EPSILON) -> fmov s1, wzr
# Cursor and aim steps (MacNativeGames game_patches.c patch_cursor_speed, 363a6eb): use the same 30 Hz ratio
# already read by these updates for smoothing. x9 / s16 are scratch at the map site; x20 holds the aim clock.
set cursor TOTK_HIGHFPS_FIX 1
site cursor main f31e80 bd400361 f94002e9 bd400930 1e300800 bd400361 # map pan s0 *= [[x23] + 8]
site cursor main 1d55f24 1e2a198c 1e2a198c bd400a90 1e30098c # vertical ability aim s12 *= [x20 + 8]
site cursor main 1d556a4 1e200923 1e200923 bd400a90 1e300863 # vertical gyro aim s3 *= [x20 + 8]
# Camera aspect (Hor+): two camera projection updates and the two copies of the viewport projection routine.
# The camera sites were matched against 1.0.0 by instruction windows; both viewport copies match the same
# 193-word normalized window. Page +56 is set by runtime/resolution.c. Save x10 instead of assuming it dead.
set aspect TOTK_ASPECT_PATCH 0
site aspect main cdbf30 bd414260 f81f0fea @page:x10 bd403940 f84107ea
site aspect main 1261a64 bd414260 f81f0fea @page:x10 bd403940 f84107ea
site aspect main 19c2260 1e211800 f81f0fea @page:x10 bd403940 f84107ea
site aspect main 1ed8fa4 1e211800 f81f0fea @page:x10 bd403940 f84107ea
# Field of view: load the camera's vertical angle as before and multiply by page +60. The following projection
# setup overwrites s8 before reading it; s1 (the half-angle multiplier) stays intact. x10 is saved on the stack.
set fov TOTK_FOV_PATCH 0
site fov main cdbef8 bd413e60 f81f0fea @page:x10 bd413e60 bd403d48 1e280800 f84107ea
site fov main 1261a2c bd413e60 f81f0fea @page:x10 bd413e60 bd403d48 1e280800 f84107ea
# Texture pool offsets above 2 GiB (MacNativeGames game_patches.c patch_pool_offset, ca311e2d): the loader
# passes w25 to SetStorage and SetPackagedTextureData. Widen unsigned to cover the complete 32-bit pool offset.
set pooloff TOTK_POOL_OFFSET_PATCH 1
site pooloff main 9b93a8 93407f22 2a1903e2
site pooloff main 9b93c4 8b39c101 8b394101
# Fixed scene tier: the 1.1.0 controller (main+0xce8d74, 1.2.1 main+0xcc26f4) returns its scale through w23 in
# the shared epilogue. res_dynres_live enables this set when dynamic_res is off, preserving the configured render_scale.
set fixres TOTK_FIXED_RES_PATCH 0
site fixres main ce9280 2a1703e9 52a7f009 # mov w9, w23 -> mov w9, #0x3f800000 (1.0f)
# Sun shadow map: the size rounded here is used for width (+0x3d8), height (+0x3f8) and viewport together.
# runtime/resolution.c shadow_init supplies the fixed size at page +92; the default remains the game's size.
site shadow main d0760c 11001d6b @page:x11 b9405d6b 11001d6b
# Sun shadow cascade parameter defaults: depth_shadow_near_0_1..3 and depth_shadow_far_0. The constructor
# stores 20, 40, 80 and 160 metres; runtime/resolution.c res_shadow_range supplies page +64..+76.
site cascade main 1157fb8 52a83408 @page:x8 b9404108
site cascade main 1158040 52a84408 @page:x8 b9404508
site cascade main 11580c8 52a85408 @page:x8 b9404908
site cascade main 115814c 52a86408 @page:x8 b9404d08
# High-frame-rate climbing (#35, #276, #1001): r is in s9 in the local 1.1.0 controller at main+0x1927948.
# The shipping formula multiplies by -0.181, doubles with fadd, then adds 1.272; keep its rounding and [0.5, 1.5] clamp.
# For r<1 use the 1.2.1 climb h(r,u), u=max(page+0,r); the normal 30 Hz factor stays unchanged.
# runtime/frame_rate.c disables climb when realtime=0; TOTK_CLIMB_FIX=0 keeps the original instruction.
# A 96-byte, 16-byte-aligned stack frame saves x8 and full q5/q6/q7/q16/q17; only s0/s1 are outputs.
set climb TOTK_CLIMB_FIX 1
site climb main 19279f0 1e2f1001 d10183ff f90003e8 ad009be5 ad01c3e7 3d8017f1 @page:x8 bd400111 1e296a31 1e2e1005 1e3138a5 52862508 72a7e308 1e270106 1e2608a5 1e2528a5 529a1ca8 72a7f448 1e270106 1e2628a5 1e201006 1e2678a5 52946dc8 72a7e528 1e270106 1e3118c6 52828248 72a7dfe8 1e270107 1e2728c6 529573e8 72a7b5a8 1e270107 1f1118e6 1e283a27 2f00e410 1e3068e7 1e261010 1f1098e6 1e241010 1e3078c6 1e2668a5 1e256800 1e2f1001 1e256821 3dc017f1 ad41c3e7 ad409be5 f94003e8 910183ff
# Gear rotation check (#330, #984): main+0x213eec4, vtable 0x347e8e8 slot +0x110.
# AI dispatchers 0x1205b90 / 0x2ae29ac pass a context with frame delta at +8; keep it in the already-saved s12.
# Scale RotateStartDeg/30 by that delta for all three angle compares: 0x213f10c/0x213f174/0x213f1b0.
# The second site saves full q4 in a 16-byte stack slot, without relying on a later callee killing it.
# This set does not read the patch page and works with realtime=0; TOTK_HIGHFPS_FIX=0 keeps both original sites.
set gears TOTK_HIGHFPS_FIX 1
site gears main 213eee4 f9402001 bd40082c f9402001
site gears main 213f0d4 1e24180c 3c9f0fe4 1e241804 1e2c088c 3cc107e4
# Spin waits, from tools/spin_waits.py --exefs build/extracted/v110/exefs --patches recomp/patches-v110.txt: loops that only
# another thread can end; their back-edges pass rt_spin_gate (runtime/kernel.c), TOTK_SPIN=0 keeps the core.
+133
View File
@@ -10,6 +10,8 @@ set bounce TOTK_HIGHFPS_FIX 1
set output TOTK_PATCH_OUTPUT 0
set scene TOTK_PATCH_SCENE 0
set shadow TOTK_PATCH_SHADOW 0
set grass TOTK_PATCH_GRASS 0
set cascade TOTK_PATCH_CASCADE 0
# 60 fps: the adaptive present-interval controller (main+0x8f26c8, 1.0.0 0x8f6bec) gets the minimum interval 1.
site fps60 main 8f273c 6b08015f 7100055f # clamp: cmp w10, #1 (was cmp w10, w8 = minimum)
@@ -55,6 +57,21 @@ site cloth main 8222f0 9401d7cf @page:x8 bd400104 1e240842 1e240863 9401d7cf #
# 100; compare +0x28 * +0x38 (30 / time scale) instead, the same value at 30 Hz and independent of the frame rate.
site bounce main bda798 bd402900 bd402900 bd403901 1e210800 # ldr s0, [x8, #0x28]; ldr s1, [x8, #0x38]; fmul s0, s0, s1
# Climbing (issues #35, #276, #1001): the climb controller's velocity step (main+0x1918220, the same code as 1.4.3
# main+0x1f49754) multiplies the requested velocity by a factor that makes up for a movement loss growing with the
# frame rate: 1.272 - 0.362 (r - 1) clamped to [0.5, 1.5] (r = VFR +0, the 30 Hz ratio times the time scale). Right at
# 30 fps, 78% of the speed at 60 and 30% at 240. Below r = 1 use 1.4.3's factor, 1.272 + 1.189 (1 - r) at most 2
# (Nintendo's 60 fps fit), and below r = 0.5 the 1.4.3 set climb's g(r) = 0.66265 / r + 0.4982 + 0.0848 r, at most 8.
# Without flags: h = max(min(1.4.3 factor, 2), g - 16 max(r - 0.5, 0)), s0 = max(s0, h), s1 = max(1.5, h), and the
# following fmin s1, s0, s1 gives max(min(s0, 1.5), h). For r >= 1 h is at most the shipping value, so 30 fps and
# slower keep the factor bit for bit. x8 is dead after the load at 0x19182c0; s5-s7 and s16 are written before any
# later read in this function.
# g takes u = max(page +0, r): the patch page's 30 Hz frame ratio without the time scale (runtime/frame_rate.c), so
# slow motion at 30 or 60 fps keeps the shipping factor and only a real frame rate above 60 raises it; the runtime
# switches the set off without the real-time step, where the page is not written.
set climb TOTK_CLIMB_FIX 1
site climb main 19182cc 1e2f1001 @page:x8 bd400111 1e296a31 1e2e1005 1e3138a5 52862508 72a7e308 1e270106 1e2608a5 1e2528a5 529a1ca8 72a7f448 1e270106 1e2628a5 1e201006 1e2678a5 52946dc8 72a7e528 1e270106 1e3118c6 52828248 72a7dfe8 1e270107 1e2728c6 529573e8 72a7b5a8 1e270107 1f1118e6 1e283a27 2f00e410 1e3068e7 1e261010 1f1098e6 1e241010 1e3078c6 1e2668a5 1e256800 1e2f1001 1e256821 # fmov s1, #1.5 -> s5 = h(r); s0 = max(s0, s5); s1 = max(1.5, s5)
# Cursor and aim steps (upstream game_patches.c patch_cursor_speed, 363a6eb). These updates read the game's 30 Hz frame
# ratio for their smoothing but leave it out of the step itself, so the map cursor and the vertical Ultrahand aim moved
# 2x as fast at 60 fps and 4x at 120 as at the shipping 30 fps (issue #44). Each site multiplies the step by that ratio,
@@ -65,6 +82,22 @@ site cursor main ec3d9c bd400361 f94002e9 bd400930 1e300800 bd400361 # map pan
site cursor main 1d48d64 1e2a198c 1e2a198c bd400a90 1e30098c # fdiv s12, s12, s10, then s12 *= [x20 + 8]: vertical Ultrahand aim
site cursor main 1d484e4 1e200923 1e200923 bd400a90 1e300863 # fmul s3, s9, s0, then s3 *= [x20 + 8]: vertical gyro aim (Recall)
# Gear rotation check (issues #330, #984). The update of ActorCheckRotateModule (main+0x21350c0; vtable +0x110, called
# by the AI node dispatchers main+0x11f5a40 / 0x2adbcf8 with x1 = the update context) reports a gear or water wheel as
# turning when the angle it turned since the previous update is above RotateStartDeg / 30, the angle of one 30 Hz
# frame. Above 30 fps a gear turns less per update than that, reads as stopped, and the shrine doors that wait on it
# (Riogok, Turakamik, the Wind Temple) never open. 1.4.3 (main+0x273d080) divides the angle by the context's +8, the
# frame delta in 30 Hz frames (the AI root sets it from its owner's virtual +0x30, main+0x106acc4, and the frame
# counter node SelectorGenericFrameCounter, main+0x10b66f8, adds it up per update). 1.2.1 gets the same context and
# ignores it: the update overwrites x1 with its first instruction. The first site keeps ctx+8 in s12 (the prologue has
# saved d12, the function first writes it at the second site, and callees preserve it); the second multiplies the
# threshold by it, which is 1.4.3's test with both sides multiplied by the delta. s4 is free after the fdiv: the next
# read follows a write in the callee main+0x11c2014. The context follows the measured step with the set realtime and is
# the whole-vsync ratio without it (0.25 at 120 fps, 0.5 at 60 fps measured), so the set works either way.
set gears TOTK_HIGHFPS_FIX 1
site gears main 21350e0 f9402001 bd40082c f9402001 # ldr x1, [x0, #0x40], after ldr s12, [x1, #8] (frame delta)
site gears main 21352d0 1e24180c 1e241804 1e2c088c # fdiv s12, s0, s4 -> fdiv s4, s0, s4; fmul s12, s4, s12
# Output size (upstream games/totk/runtime/game_patches.c patch_output_res; runtime/resolution.c switches the set on).
# The swapchain size nnMain writes before NvInitializeGraphics comes from page +48 ({w, h} as one 64-bit value), and
# the output size the renderer lays out its canvas, crop and UI in (main+0xcc3f00, read from the graphics parameters
@@ -81,6 +114,14 @@ site scene main cc3f68 5e21d900 @page:x9 # scvtf s0, s8 -> adrp x9, page
site scene main cc3f70 bd0cc660 2d420520 # str s0, [x19, #0xcc4] -> ldp s0, s1, [x9, #16]
site scene main cc3f74 5e21d921 bd0cc660 # scvtf s1, s9 -> str s0, [x19, #0xcc4]
# Fixed scene size (MacNativeGames game_patches_v143.c patch_fixed_res, 1.4.3 main+0x5848a8; runtime/resolution.c
# res_dynres_live switches the set on unless TOTK_DYNAMIC_RES=1). The game's dynamic resolution controller
# (main+0xcc26f4, called once per frame from the renderer at main+0xcc0fa0) steps the scene through tiers of 100, 90 and
# 80 % by a cost model that grows with the scene width squared (runtime/resolution.c res_dynres_live), and the renderer stores scene width * tier / output width at +0xccc (main+0xcc1150).
# Every path leaves through one epilogue, where the tier's scale moves into the result: 1.0 there makes every tier 100 %.
set fixres TOTK_FIXED_RES_PATCH 0
site fixres main cc2c00 2a1703e9 52a7f009 # mov w9, w23 -> mov w9, #0x3f800000 (1.0f)
# Camera aspect ratio for a game resolution that is not 16:9 (upstream game_patches.c, the 1.2.1 sites of aspect_install;
# runtime/resolution.c res_init writes the output's width / height to page +56 and switches the set on). The same four
# sites as patches-v143.txt, with the same original words: two camera sites (update and setup) load the camera's copy of
@@ -92,6 +133,22 @@ site aspect main 12521cc bd414260 f81f0fea @page:x10 bd403940 f84107ea # ldr s0
site aspect main 19b36f0 1e211800 f81f0fea @page:x10 bd403940 f84107ea # fdiv s0, s0, s1 (viewport)
site aspect main 1ecdf68 1e211800 f81f0fea @page:x10 bd403940 f84107ea # fdiv s0, s0, s1 (viewport)
# Field of view (runtime/resolution.c res_fov_live writes TOTK_FOV / 100 to page +60 and switches the set). The same two
# camera routines as the aspect set (update main+0xcb4208, setup main+0x1252024; 1.4.3 main+0x628460, main+0xb432bc)
# load the camera's vertical view angle (+0x13c, radians) a few words before the ratio and hand it to sead's perspective
# projection (+0xa0, then sinf / cosf / tanf of half of it at +0xa4..+0xac); 1.4.3's setup reads the same fields through
# x22 = camera + 0xd8. Eight more places fill a perspective projection the same way, 1.4.3 has the same eight, and
# neither version patches them: one more inlined copy that scales an angle of another object (main+0x6c5548, 1.4.3
# main+0x4e9754), three projection routines (main+0xdde89c, main+0x1141ce8, main+0x1a5e994; 1.4.3 main+0xc02690,
# main+0xd42730, main+0x27d53d8) and four that fill a projection on the stack (main+0x7800f0, main+0x7805fc,
# main+0xc764cc, main+0x21ee474; 1.4.3 main+0x63e2b4, main+0x63e744, main+0x79344, main+0x2804fec). The replacement is
# the one of patches-v143.txt (word for word the sites of patches-v110.txt): it loads the angle as before and
# multiplies it by the factor on the page; s8 holds the factor because the next instruction (fmul s8, s0, s1) overwrites
# it, and x10 is kept on the stack.
set fov TOTK_FOV_PATCH 0
site fov main cb4ad8 bd413e60 f81f0fea @page:x10 bd413e60 bd403d48 1e280800 f84107ea # ldr s0, [x19, #0x13c] (camera update)
site fov main 1252194 bd413e60 f81f0fea @page:x10 bd413e60 bd403d48 1e280800 f84107ea # ldr s0, [x19, #0x13c] (camera setup)
# Texture pool offsets past 2 GiB (MacNativeGames ca311e2d). The texture loader keeps a texture's place in its pool as a
# 32-bit offset (main+0xad4294: sub x25, x9, x10, stored as the word w25) and widens it as a signed number for
# nvnTextureBuilderSetStorage's offset and for SetPackagedTextureData's source (the pool's CPU address + offset). The
@@ -103,6 +160,17 @@ set pooloff TOTK_POOL_OFFSET_PATCH 1
site pooloff main ad43f0 93407f22 2a1903e2 # sxtw x2, w25 -> mov w2, w25 (SetStorage offset)
site pooloff main ad440c 8b39c101 8b394101 # add x1, x8, w25, sxtw -> add x1, x8, w25, uxtw (packaged data source)
# Load-dependent quality, after the emulator mod "Disable LOD Quality Reduction" (main-1.2.1.pchtxt), which turns a
# conditional branch into an unconditional one; the generator patches only plain instructions (recomp/gen.py, the
# emitter's patch), so the site feeds the branch instead. The graphics settings setup (main+0xc7e9xx, it also reads the
# FSR and FXAA switches) walks a
# list at its +0x120 and passes three floats of each entry to virtual setters, which the mod describes as the drop of
# model and texture detail when the frame rate falls; it skips all of it, to the epilogue, when the value it reads at
# main+0xc7eb24 is above 8. Reading 9 there skips it as the mod does; w21 is not read again on that path (the epilogue
# restores it).
set steady TOTK_LOD_STEADY 0
site steady main c7eb24 b9400815 52800135 # ldr w21, [x0, #8] -> mov w21, #9 (b.gt 0xc7ee4c taken)
# Direct mouse camera (runtime/mouse_direct.c; the same hooks as patches-v143.txt, mapped by enclosing function to the
# 1.2.1 main, each original word checked). The camera input update (main+0xd18088, 1.4.3 0x874c1c) after its dead zone,
# clamp and StickExponent keeps x in s11 (1.4.3 s9); the host callback performs the displaced store and adds raw mouse
@@ -1076,3 +1144,68 @@ spin sdk 3d3250 3d3270 # 9 instructions; loads
# goes in just before the rounding, as the community's shadow resolution mods do (1.1.0: mov w11, #1024 over the
# computation). Found by a write watch on the size field (the writer was this function, and no other).
site shadow main cec22c 11001d6b @page:x11 b9405d6b 11001d6b # add w11, w11, #7 -> adrp x11, page; ldr w11, [x11, #92]; add w11, w11, #7
# Sun shadow cascade distances (runtime/resolution.c res_shadow_range switches the set on; issue #606). On 1.2.1 the
# depth shadow parameters (depth_shadow_near_0_0..3 and depth_shadow_far_0, whose constructor defaults at
# main+0x114c2f8.. are 20, 40, 80, 160 and 2000 m) do not reach the sun's cascades: the game's shadow controller sets
# bit 1 of the scene's depth shadow flags when it starts (main+0xc7b0e8), and with that bit the per-view update
# (main+0xa2cff4) skips its copy of those parameters into the cascade boundaries. The controller writes the boundaries
# itself each frame in main+0xcebdf4: d[0] at main+0xcec2ac, d[1..n-1] at main+0xcec314 and the far d[n] at
# main+0xcec36c (d = [cascade set + 0x308], read by main+0xa2d6ec). The set multiplies d[1..n] where they are stored,
# by page +64 (20 m times shadow_range / 100) over 20; d[0], the first cascade's start, stays. x3, s16 and s17 are
# dead at both sites.
site cascade main cec314 bd000446 @page:x3 bd404070 1e269011 1e311a10 1e3008d0 bd000450 # str s6, [x2, #4] -> adrp x3, page; ldr s16, [x3, #64]; fmov s17, #20.0; fdiv s16, s16, s17; fmul s16, s6, s16; str s16, [x2, #4]
site cascade main cec36c bc29d945 @page:x3 bd404070 1e269011 1e311a10 1e3008b0 bc29d950 # str s5, [x10, w9, sxtw #2] -> the same with fmul s16, s5, s16; str s16, [x10, w9, sxtw #2]
# Grass range (runtime/resolution.c res_grass_range; patches-v143.txt describes the set and the page). The near grass
# map's constructor loads its extent, step and texture sizes at main+0xfe58b4..0xfe5950, and main+0x1a30a28 sets the
# extent to 62.5 or 31.25 m, as on 1.4.3.
site grass main fe58b4 52a84f48 @page:x8 b9408108 # mov w8, #62.5 -> ldr w8, [page+128]
site grass main fe58c0 52a80f48 @page:x8 b9408508 # mov w8, #3.90625 -> ldr w8, [page+132]
site grass main fe58ec 52802002 @page:x2 b9408842 # mov w2, #0x100 -> ldr w2, [page+136]
site grass main fe5950 52801002 @page:x2 b9408c42 # mov w2, #0x80 -> ldr w2, [page+140]
site grass main 1a30a8c 52a84f48 @page:x8 b9408108 # mov w8, #62.5 -> ldr w8, [page+128]
site grass main 1a30a98 52a83f48 @page:x8 b9409108 # mov w8, #31.25 -> ldr w8, [page+144]
# Optional reference with an invalid value (#1005). The same guard as set optref in patches-v143.txt (main+0x1bd01c0),
# here for 1.2.1's main+0x1622bec: ldr x8, [x19, #0x6b0]; cbz x8; ldr x21, [x8]. A negative value counts as absent.
# x8 and x9 are dead at the branch target 0x1622c1c, which loads x8 again.
set optref TOTK_OPTREF_GUARD 1
site optref main 1622bec b4000188 937ffd09 8a290108 b4000188 # cbz x8 -> asr x9, x8, #63; bic x8, x8, x9; cbz x8
# Recall and Ultrahand target that is stale memory: set ability in patches-v143.txt, here for 1.2.1's main+0x1622bf0
# (function main+0x1622b60; the callees main+0x809ecc, 0x842aa4 and 0x842d10 read the same actor offsets). The model
# scene report-row guard (set report there) has no 1.2.1 site: this version does not have that loop's code shape.
set ability TOTK_ABILITY_GUARD 1
site ability main 1622bf0 f9400115 94c424dc # ldr x21, [x8] -> bl page+0xf60
site ability main 1622bf4 b4000155 aa0903f5 b4000155 # cbz x21 -> mov x21, x9; cbz x21 (x9 dead after it)
# Sound command lists above 200 updates a second (issue #337). The game thread hands its sound commands to the audio
# thread in lists: 16 of them, of which 4 are always held (one being filled by the game thread, the others on the audio
# thread's side), so at most 12 wait in the command ring. The game thread submits at most one list per update
# (main+0x9bd144, when a free list is there), and the audio thread takes one per pass of its loop, one 5 ms audio frame:
# after a list main+0x883780 goes on past the ring's check (b 0x883318). Above about 200 updates a second the ring
# fills. A guard in the game (main+0x9bcdc4, at the end of each update) 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 goes back to 0 whenever a free
# list is there (0x9bce00), which takes two audio frames between two updates: the game thread picks up one of the two
# lists, the other is still free at the guard. At every multiple of 300 (10 s at 30 fps, 1.25 s at 240) the guard clears
# the sound command switch, the byte at [[engine + 0x1a0] + 8] (main+0x2268bfc), and stops every active voice
# (main+0x226f29c). The switch is set to 1 only by its constructor (main+0xf31ce8, from the engine's init
# main+0xf31530), so the game stays silent until it is restarted. By this reading the guard fires only when the audio
# frames come evenly, 5 ms apart, through 300 updates in a row at more than 200 a second: that is the mixer pacing its
# render thread by its own timer (runtime/audio_mixer.c, audio_mixer_pace_ns), with audio = none or while a device takes
# nothing. While a device paces the rendering the frames come in bursts after each device period: on Linux with
# PipeWire's 1024-frame periods 76% of the frames were measured 4 ms after the one before (audren.c, gap_ns), two of
# them fall between two updates several times a second, and the game kept its sound in every run. On Windows gap_ns is 0
# and the frames of a burst are rendered back to back: read from the code, not measured here. A device with periods of
# 240 frames or less was not tried and may pace as evenly as the timer. The count and the switch have not been read in a
# run. The site sends the audio thread back to the ring's check (0x8832e8, where the game's own 0x883c18 also branches;
# x21, the engine, is not written between the check and the site), so it takes every queued list in the pass and the
# ring does not stay full. Measured on 1.2.1 at fps_limit 240 (Linux, PipeWire), same save and input script, seconds
# with sound in the mix with the set off and on: without a device 6 of 119 and 111 of 119; with a device 111 of 119 and
# 112 of 119; with the game's stream paused for 5 s from outside (pw-cli, not a real device stalling) while the game ran
# at 240 fps 4 of 120 (silent from the pause on, also after the device resumed) and 113 of 119. A pause of 2 s silenced
# the game with the set off in two runs of two, a pause of 1 s in none of one.
set audiodrain TOTK_AUDIO_DRAIN_FIX 1
site audiodrain main 883780 17fffee6 17fffeda # b 0x883318 -> b 0x8832e8
+172
View File
@@ -12,6 +12,14 @@ set output TOTK_PATCH_OUTPUT 0
set scene TOTK_PATCH_SCENE 0
set shadow TOTK_PATCH_SHADOW 0
set cascade TOTK_PATCH_CASCADE 0
set grass TOTK_PATCH_GRASS 0
# Load-dependent quality (patches-v121.txt, set steady). The graphics settings setup (main+0x5868c4) inlines the
# three getters 1.2.1 calls: the value 1.2.1 reads at
# main+0xc7eb24 is the ldr w10, [x10, #0x38] at main+0x58692c, and the getters' slow paths (main+0x586bc8, 0x586c18,
# 0x586f44) come back before the compare. So the site is the compare, which every path reaches: w10 = 9 skips the
# list walk to the epilogue (main+0x58729c), which does not read w10.
set steady TOTK_LOD_STEADY 0
site steady main 586954 7100215f 5280012a 7100215f # cmp w10, #8 -> mov w10, #9; cmp w10, #8 (b.gt 0x58729c taken)
# 60 fps: the adaptive present-interval controller (main+0x2db174, 1.2.1 0x8f26c8) gets the minimum interval 1.
site fps60 main 2db204 6b08015f 7100055f # clamp: cmp w10, #1 (was cmp w10, w8 = minimum)
@@ -41,6 +49,16 @@ site realtime main 2daa78 1e210800 d503201f # fmul s0, s0, s1 -> nop
# keeps equipment locked until a load. Stepping while above 0 takes the remainder below 0 like any other last step.
site realtime main 2b036c 0f016681 0f000401 # movi v1.2s, #0x34, lsl #24 (FLT_EPSILON) -> movi v1.2s, #0
# Attack hit processing (main+0x2906a24) builds a list of this frame's hit records on its stack (count at [sp], slots
# at [sp+8] -> an inline array that is never cleared). The record insert (main+0x86e1d8) returns null when the
# attacker's record map (+0x190) is full, so a full map leaves the list empty. After its two loops the function
# passes slot 0 to the hit handler (main+0x870158, which dereferences it) unconditionally at main+0x2906de0 and only
# then checks count == 0 at main+0x2906df0; with an empty list slot 0 is stale stack data and the handler faults.
# Charged spear hits above 60 fps fill the map. Both count == 0 branches go to the check instead, which reloads the
# count and leaves through main+0x2906ce8; x19 and x20 are the only registers read there. A non-empty list is unchanged.
site realtime main 2906d98 34000248 340002c8 # cbz w8, 0x2906de0 -> 0x2906df0 (first loop's empty check)
site realtime main 2906dc0 34000108 34000188 # cbz w8, 0x2906de0 -> 0x2906df0 (second loop's empty check)
# Hair and cloth: the actor animation update builds a second clock {seconds = factor / 30, ratio = factor} per
# rendered frame. 1.4.3 inlines it in two actor paths, where the factor was just stored to the ratio slot: the
# replacement stores measured ratio * factor there and computes measured seconds * factor. Two other callers share the
@@ -82,6 +100,13 @@ site scene main 585e50 bd0cc660 2d420460 # str s0, [x19, #0xcc4] -> ldp s0, s
site scene main 585e54 1e220140 bd0cc660 # scvtf s0, w10 -> str s0, [x19, #0xcc4]
site scene main 585e60 bd0cca60 bd0cca61 # str s0, [x19, #0xcc8] -> str s1, [x19, #0xcc8]
# Fixed scene size (MacNativeGames game_patches_v143.c patch_fixed_res; runtime/resolution.c res_dynres_live switches
# the set on unless TOTK_DYNAMIC_RES=1). The dynamic resolution controller (main+0x584300, 1.2.1 0xcc26f4) steps the
# scene through tiers of 100, 90 and 80 % by a cost model that grows with the scene width squared; at its one epilogue the tier's scale moves into
# the result, and 1.0 there makes every tier 100 %. The original word is MacNativeGames' check against 1.4.3.
set fixres TOTK_FIXED_RES_PATCH 0
site fixres main 5848a8 2a1703e9 52a7f009 # mov w9, w23 -> mov w9, #0x3f800000 (1.0f)
# Camera aspect ratio for a game resolution that is not 16:9 (upstream game_patches_v143.c and aspect_patch.h
# aspect_install / aspect_stub; runtime/resolution.c res_init writes the output's width / height to page +56 and
# switches the set on). Each site leaves the ratio sead's perspective projection (+0xb0) takes in s0: two camera sites
@@ -1079,3 +1104,150 @@ site cascade main 6fabb8 52a83408 @page:x8 b9404108 # mov w8, #20.0 -> ldr w8
site cascade main 6fac40 52a84408 @page:x8 b9404508 # mov w8, #40.0 -> ldr w8, [page+68]
site cascade main 6facc8 52a85408 @page:x8 b9404908 # mov w8, #80.0 -> ldr w8, [page+72]
site cascade main 6fad4c 52a86408 @page:x8 b9404d08 # mov w8, #160.0 -> ldr w8, [page+76]
# The four sites above reach the cascades only through the copy of the parameters into the cascade boundaries
# (main+0x5680ec, in the per-view update). The game's shadow controller sets bit 1 of the scene's depth shadow flags
# when it starts (main+0xb74494), with that bit the per-view update skips the copy (main+0x567f6c), and the controller
# writes the boundaries itself each frame in main+0x68318c: d[0] at main+0x683680, d[1..n-1] at main+0x6836ec and the
# far d[n] at main+0x683740 (d = [cascade set + 0x308]). In Hyrule Field the four sites alone leave the cascades as
# they are at 100 (issue #606 has the same on 1.2.1). These two multiply d[1..n] where the controller stores them, by
# page +64 (20 m times shadow_range / 100) over 20; d[0], the first cascade's start, stays. The function computes the
# boundaries from the controller's own fields and its arguments and reads neither the parameters nor d, so a boundary
# is scaled once on either path. x25 (written at main+0x683704 before any read), x16, s18 and s19 are dead at the
# sites.
site cascade main 6836ec bd000711 @page:x25 bd404332 1e269013 1e331a52 1e320a32 bd000712 # str s17, [x24, #4] -> adrp x25, page; ldr s18, [x25, #64]; fmov s19, #20.0; fdiv s18, s18, s19; fmul s18, s17, s18; str s18, [x24, #4]
site cascade main 683740 bc2ed9b0 @page:x16 bd404212 1e269013 1e331a52 1e320a12 bc2ed9b2 # str s16, [x13, w14, sxtw #2] -> the same through x16 with fmul s18, s16, s18; str s18, [x13, w14, sxtw #2]
# Climbing (issues #35, #276, #1001): the climb controller's velocity step (main+0x1f49754, shared by wall and ladder
# climbing, climb jumps and climb-overs) multiplies the requested velocity by a factor that makes up for a movement loss
# growing with the frame rate. Below ratio 1 the factor is 1.272 + 1.189 (1 - r) clamped to [1, 2] (r = VFR +0, the
# 30 Hz ratio times the time scale): Nintendo's fit for 30 and 60 fps, flat at 2 from about 77 fps, so Link climbs at
# 63% of the speed at 120 fps and 34% at 240. Below r = 0.5 take g(r) = 0.66265 / r + 0.4982 + 0.0848 r instead,
# fitted to the replayed ladder climb at 120 and 240 fps and equal to the shipping 1.8665 at r = 0.5; at most 8. The
# site computes g with 16 * max(r - 0.5, 0) subtracted, so g stays under the shipping factor for r >= 0.5, and folds it
# into the existing clamp without flags: s0 = max(s0, g) (the value clamped), s1 = max(2, g) (the bound). r >= 0.5
# keeps the shipping factor bit for bit. x8 is dead after the constant load at 0x1f497e8, s2-s4 are loaded again at
# 0x1f49844 before any read.
# g takes u = max(page +0, r): the patch page's 30 Hz frame ratio without the time scale (runtime/frame_rate.c), so
# slow motion at 30 or 60 fps keeps the shipping factor and only a real frame rate above 60 raises it; the runtime
# switches the set off without the real-time step, where the page is not written.
set climb TOTK_CLIMB_FIX 1
site climb main 1f497f4 1e201001 @page:x8 bd400104 1e286884 52946dc8 72a7e528 1e270102 1e241842 52828248 72a7dfe8 1e270103 1e232842 529573e8 72a7b5a8 1e270103 1f040862 1e2a3883 2f00e404 1e246863 1e261004 1f048862 1e241004 1e247842 1e226800 1e201001 1e226821 # fmov s1, #2.0 -> s2 = g(u); s0 = max(s0, s2); s1 = max(2.0, s2)
# Grass range (runtime/resolution.c res_grass_range switches the set on). Grass blades grow from the near grass map, a
# square texture the game draws around the camera (GrassShader.sharcb). Its constructor (main+0xa38e58) gives it a
# 62.5 m extent, a 3.90625 m step (1/16 of it) and 256x256 and 128x128 textures; main+0x206340c later sets the extent
# to 62.5 or 31.25 m. With the set on all of them come from page +128..+144, scaled together so the map keeps its
# texels per metre; resolution.c grows the grass heap of the HeapDef for the larger textures.
site grass main a38e58 52a84f48 @page:x8 b9408108 # mov w8, #62.5 -> ldr w8, [page+128]
site grass main a38e64 52a80f48 @page:x8 b9408508 # mov w8, #3.90625 -> ldr w8, [page+132]
site grass main a38e94 52802002 @page:x2 b9408842 # mov w2, #0x100 -> ldr w2, [page+136]
site grass main a38ef4 52801002 @page:x2 b9408c42 # mov w2, #0x80 -> ldr w2, [page+140]
site grass main 2063454 52a84f48 @page:x8 b9408108 # mov w8, #62.5 -> ldr w8, [page+128]
site grass main 2063460 52a83f48 @page:x8 b9409108 # mov w8, #31.25 -> ldr w8, [page+144]
# Optional reference with an invalid value (#1005). main+0x1bd0138 reads an optional reference at object +0x6b0 (null or
# a holder whose first word is the target, bit 0 a tag) and checks it only for null: ldr x8, [x19, #0x6b0]; cbz x8;
# ldr x21, [x8]. Players' crash reports show the field holding 0xffffffffffffffff after minutes to hours of play, and
# the load of the holder faults. MacNativeGames (games/totk/runtime/loader.c, crash) met the same field holding
# 0xffff0000ffffffff during a save load and treats the reference as absent there. Every valid holder is a heap address
# below 2^63, so the cbz becomes a test for null or negative: x9 = x8 >> 63 (arithmetic, all ones when negative),
# x8 &= ~x9, cbz x8. Both x8 and x9 are dead at the branch target 0x1bd01f0, which loads x8 again and writes x9 before
# any read; on the fall-through path x8 is unchanged.
set optref TOTK_OPTREF_GUARD 1
site optref main 1bd01c0 b4000188 937ffd09 8a290108 b4000188 # cbz x8 -> asr x9, x8, #63; bic x8, x8, x9; cbz x8
# Recall and Ultrahand target that is stale memory. The same function reads the target actor from the holder
# (ldr x21, [x8]) and follows it into main+0x155ec, main+0x9a89d4 and main+0x2b8464 (an atomic write at +0x90). The
# holder can be reused memory by then, so the actor points into .rodata, outside the address space or at other heap
# data, and the game crashes reading 0xffffffffffffffff. UltraTears (kuraeow/ultratears, ability target guard) found
# the class. The load becomes a call to runtime/ov_ability.c host_ability_target (page+0xf60): x21 is the holder's
# first word, or 0 where the game's own code would fault on the target (holder, actor or component unreadable, the
# reference word not writable), which the game's cbz x21 skips for this frame. Every other target goes on unchanged.
# The answer comes back in x9 and the cbz site moves it to x21: the lifted code keeps x21 (callee-saved) in a C local
# across the call. x9 is dead after 0x1bd01c8 on every path (written or clobbered by a bl before any read); x30 is saved by the
# prologue and clobbered by the next bl anyway.
set ability TOTK_ABILITY_GUARD 1
site ability main 1bd01c4 f9400115 947c3f67 # ldr x21, [x8] -> bl page+0xf60
site ability main 1bd01c8 b4000155 aa0903f5 b4000155 # cbz x21 -> mov x21, x9; cbz x21
# Model scene report rows (WoE, daniel-madrid-07/weeping-of-the-empire, MIT, games/totk/patches/sites_v143.py
# reportguard; their #52 and #73: crashes while using Ultrahand and aiming). gsys::ModelScene::calcGPU_ is inlined in
# main+0xa1f84; its per-object loop (0xa22bc..0xa234c) takes the object's report handle h (int16 at obj+0x98 + 2 * side),
# exits for -1 only, reads row 2h+1 and then u32 n from row 2h, and follows n to row 2n with no bound (WoE's crash had
# n = the float 0.05, a read 32 GB past the rows). n indexes a row pair as h does, so a valid one is below 0x8000.
# A negative h (other than -1) or n >= 0x8000 goes to 0xa2340, where the game resets the handle to -1 after every use:
# the object has coverage 0 this frame (stored at 0xa22cc) and the game asks for a new report, as after a normal read.
# WoE's veneers exit at 0xa2344 instead, which keeps the bad handle for the next frames. No flags change; w4 is never
# used in main+0xa1f84; x1, x16, x15 and w13, which 0xa2340 reads, hold what they hold on the game's own path there.
set report TOTK_REPORT_GUARD 1
site report main a22d8 2a010571 2a010571 37f80341 # orr w17, w11, w1, lsl #1; tbnz w1, #31, 0xa2340
site report main a2310 531f7821 530f7c24 531f7821 35000184 # lsr w4, w1, #15; lsl w1, w1, #1; cbnz w4, 0xa2340
# Depth query results one frame older (TOTK_SYNC_AHEAD). A compute pass at the start of each frame samples the scene
# depth for the world queries and writes their results, with the frame number of the request, into a 23232-byte
# CPU-cached buffer that main+0x6e1220 invalidates and reads two frames later. It takes the results as this frame's
# (bit 2 of obj+0x10) only when the number at buffer +0x58e4 is exactly the frame counter (obj+0x14) - 2. With
# sync_ahead the game's frame wait covers the frame before, so on frames where the GPU runs behind the number read is
# the counter - 3 (the frame after it has not come back yet) and the results were refused: in shrines the reflections
# of the lamps on the floor went out on those frames, every other frame where the GPU was slow, which looked like
# flicker at some camera angles. The set also accepts the counter - 3: d = counter - 2 - number, unsigned d <= 1.
# Waiting for that frame when the buffer is invalidated (vk_memory.c vk_mem_shadow_read) also ends the flicker, but
# gives back the frame rate sync_ahead brings (63 against 86 fps on a field macro at 4K).
# w11 is loaded again on both paths at 0x6e1340 before any read; x8, the number's address, stays for 0x6e1420.
set qstamp TOTK_SYNC_AHEAD 0
site qstamp main 6e1320 6b0b015f 4b0b014b 7100057f # cmp w10, w11 -> sub w11, w10, w11; cmp w11, #1
site qstamp main 6e1324 540000c1 540000c8 # b.ne 0x6e133c -> b.hi 0x6e133c
# Function-entry hooks (FN_ENTER, runtime/cpu.h): only these functions check g_fnprof on entry, the others carry no
# hook. main+0x585bd0 sets the render size (runtime/resolution.c SET_RENDER_SIZE): res_fn_hit takes the renderer from
# the game's own call at start, so a DLSS mode can change while the game runs.
hook main 585bd0
# Sound command lists above 200 updates a second (issue #337): as in patches-v121.txt, which also says when the game's
# guard fires. The audio thread's check of the command ring is main+0x148aec, which wants x8 = the engine (as 0x148ae0
# loads it from [x19]); after a list the site goes back to it instead of on to 0x148b14, with the two instructions the
# game itself has at 0x149700. Measured on 1.4.3 at fps_limit 240 (Linux, PipeWire), same save and input script, seconds
# with sound in the mix: without a device 3 of 119 with the set off and 113 of 120 with it on; with a device 111 of 119
# with the set off; with the game's stream paused for 5 s from outside at 240 fps, in 60 s runs, 3 of 59 with the set
# off (silent from the pause on) and 51 of 59 with it on; a pause of 2 s with the set off, 4 of 59.
set audiodrain TOTK_AUDIO_DRAIN_FIX 1
site audiodrain main 149244 17fffe34 f9400268 17fffe2a # b 0x148b14 -> ldr x8, [x19]; b 0x148aec
# Tenbez Shrine launchers (issue #1215). The two DgnObj_BoxShutter_4x4x4 that throw the stone ball across the room move
# 3 m at Speed (1.0 m per 30 Hz frame, 30 m/s): their AI (AI/ShutterFence.root.ainb) advances the target by Speed *
# frame ratio each frame and sets the kinematic body's velocity to reach it. The shorter the frame, the slower the ball
# leaves. Measured on the flight's apex (the ball rests at y = -4.42): 6.33 at 30 fps, 6.11 at 45, 6.00 at 60, 5.79 at
# 90, 5.61 at 120. Below about 6.1 the ball lands more and more often on the rim of the receiving launcher instead
# of its seat, and the next shots juggle it there or knock it into the pit. The data suggest Nintendo tuned this by
# hand for a 60 fps build ("Ounce", which looks like the Switch 2): in
# the shrine's map both actors carry SpeedForOunce = 1.01 and shouldUseOunceSpeed, read by the node
# QueryBlackboardGetF32FromActorForOunce (also in AI/ShutterFence_WithVibration.root.ainb of the
# FldObj_RuinStoneWall_A_20/30_Shutter walls, where the flag is never set). The Switch build of the node ignores the
# pair: its evaluation (main+0x25e557c) looks up the base key alone. With 1.01 the apex is 6.20 at 60 fps, but 5.96 at 90 and
# 5.81 at 120, so the site scales by the frame instead. It is where the evaluation loads the value: when the node's
# shouldUseOunceKey input (+0x58) is true, the value is multiplied by 1 + 0.065 * (1 - ratio)^2, ratio being the time
# object's +0x38 (the frame in 30 Hz frames; [[main+0x3ad27c8] + 0xc8], the object the set bounce reads) clamped to
# 0..1. That is 1.016 at 60 fps and 1.037 at 120, and exactly 1 at 30 fps and below. Measured apex with it: 6.25 at
# 45 fps, 6.33 at 60, 6.23 at 90, 6.33 at 120, 6.35 at 144. Every other user of the node has the input false and gets
# its value unchanged. x9, x10 and s1-s4 are free: after the site the function only moves x19 to x0, restores the
# saved registers and tail-calls the output setter (main+0xb9b818), which reads x0 and s0. Its own switch,
# shutter_fix (TOTK_SHUTTER_FIX); 0 runs the game's instruction.
set shutter TOTK_SHUTTER_FIX 1
site shutter main 25e55d0 bc605900 bc605900 f9402ea9 927ef529 39400129 1e230123 b000a76a f943e54a f940654a bd403941 1e2e1002 1e213841 2f00e404 1e246821 1e227821 1e210821 5283d709 72a7b0a9 1e270124 1e240821 1e230821 1f010000
# ldr s0, [x8, w0, uxtw #2]; ldr x9, [x21, #0x58]; and x9, x9, #~3; ldrb w9, [x9]; ucvtf s3, w9 (the input, 0 or 1);
# adrp x10, main+0x3ad2000; ldr x10, [x10, #0x7c8]; ldr x10, [x10, #0xc8]; ldr s1, [x10, #0x38] (ratio);
# fmov s2, #1.0; fsub s1, s2, s1; movi d4, #0; fmaxnm s1, s1, s4; fminnm s1, s1, s2; fmul s1, s1, s1;
# mov w9, #0x1eb8; movk w9, #0x3d85, lsl #16; fmov s4, w9 (0.065); fmul s1, s1, s4; fmul s1, s1, s3;
# fmadd s0, s0, s1, s0
# Free camera (runtime/freecam.c freecam_hook, page +0xf50). The camera component update (main+0x628460, the routine of
# the first fov and aspect sites) copies the component's eye, target and up into its sead camera; every path to that
# copy runs this load of the component's link first. The hook performs the load and, while the free camera is on,
# writes the component's one-shot eye and target overrides (+0x180, +0x198). The function saves x30 in its prologue, so
# the bl's link write is harmless. Off by default (freecam_patch, the Free camera row of the Controls tab, read at start):
# with it off the site runs the game's load and nothing else. It sits at the end of the table, so the sets before it
# keep their numbers.
set freecam TOTK_FREECAM_PATCH 0
site freecam main 6286d4 f9400e68 94d2de1f # ldr x8, [x19, #0x18]
+194 -14
View File
@@ -1,13 +1,21 @@
"""Code patch table for the generator: guest instructions replaced in the lifted C, switchable at run time.
Lifted code cannot be byte-patched when the game runs, so a patch is applied when the C is generated. A patch file
(gen.py --patches) has two kinds of lines; `#` starts a comment, fields are separated by whitespace:
(gen.py --patches) has these kinds of lines; `#` starts a comment, fields are separated by whitespace:
set <name> <env> <default> a patch set: a run-time switch <env>=0/1, <default> when it is unset
set <name> <env> <default> [ordered] a patch set: a run-time switch <env>=0/1, <default> when it is unset
site <set> <module> <address> <original> <replacement> [<replacement> ...]
spin <module> <head> <back-edge> [<back-edge> ...]
hook <module> <function> [<function> ...]
plugin <set> <module> <text sha256> <image>
expect <set> <module> <offset> <old> <new>
stub <module> <offset>
seed <module> <offset> [<offset> ...]
orig <set> <module> <offset> <function module> <function offset>
<address> is a module offset (hex), <original> the instruction word the module has there (checked; a mismatch stops
the generator), each <replacement> an instruction word (hex) or `@page:x<n>`, which is `adrp x<n>, <patch page>`
encoded for the site's address. The patch page is the first 4 KiB page after main's image (layout.py leaves the rest
@@ -20,19 +28,59 @@ the field-of-view factor (runtime/resolution.c res_fov_live, set fov), +92..95 t
The replacement words are lifted at the site's address in place of the original instruction, and the generated C reads
`if (rt_patch_on[<set>]) { replacement } else { original }`: one byte load and a branch per executed site. Several
sets may patch one address (cheats that write different values there): `if (a) {..} else if (b) {..} else {..}`, the
first set in file order wins. The original may be any instruction but br, blr and ret; a replacement's last word may be
first set in file order wins.
An `ordered` set belongs to something the player puts in an order (a mod of the Mods tab: tools/exefs_patches.py marks
its sets so). A site that two or more ordered sets patch is contested: the run time, not the file order, picks which
of them runs. Each contested site gets a byte rt_patch_pick[<n>] (n counts the contested sites, by module name and
offset), and each of its ordered alternatives tests `rt_patch_pick[<n>] == <j>`, j being the alternative's place
among the site's ordered sets in file order (1 up; 0 runs none of them): one byte load for the whole group. The
runtime fills the bytes from the sets that are on and their ranks (runtime/patches.c rt_patch_picks: the lowest rank
wins, a tie goes to the set later in the file). The other alternatives of a contested site keep their place and
their rt_patch_on test, so a cheat before the mods' sets still wins while it is on. A site with at most one ordered
set, and a table without contested sites, is emitted exactly as without the keyword.
The original may be any instruction but br, blr and ret; a replacement's last word may be
a bl (lifted with the site's return address), a b or b.cond / cbz / tbz (its target joins the function's labels when
inside it) or a ret; earlier words must not branch. Every alternative of a site writes the same flags. The generator
writes patches.h (set names, switches, the page address) next to layout.h for the runtime.
writes patches.h (set names, switches, the page address, the contested sites) next to layout.h for the runtime.
A `spin` line names a spin wait found by tools/spin_waits.py: a loop with head <head> that only another thread can end,
and the direct branches back to it (module offsets). Each back-edge (checked: a b, b.cond, cbz / cbnz or tbz / tbnz to
<head>) is lifted as `rt_spin_gate(c, <head>); goto <head>`, which keeps every register and only adds time
(runtime/kernel.c kern_spin_gate).
The plugin lines carry a mod's exlaunch plugin (layout.py plugin<N>), whose init runs at every start
(runtime/plugin_init.c) and whose hooks are sites of its set (tools/exefs_plugins.py writes them from the plugin service
run's record; the design follows #845 by itaskaev2):
- `plugin`: <module> belongs to the set <set>; it is lifted from <image>, the plugin's image after its init (the
service run's plugin<N>.img), whose .text holds the hook stubs and trampolines the NSO file has as zeros. <text
sha256> is that .text's hash: the runtime compares it with the .text its own run of the init leaves, and keeps the
set off when they differ.
- `expect`: one word the init writes into a game module (the hook branches into main's .text); the runtime compares
the words its run of the init wrote with these, all or nothing per plugin.
- `stub`: an exlaunch inline-hook entry stub (stur x30; bl impl; ldur x30; b trampoline; .quad callback). Its fourth
word is lifted as a `ret`: the generated site calls the stub and runs its own original instruction after it
(`@call` below), so the trampoline (the original relocated, b site+4) never runs.
- `seed`: function starts of the module the lift must have (the callbacks, the hook impls, branch targets).
- `orig`: the plugin calls its replace hook's original through the trampoline at <module>+<offset>; the generator
lifts the function at <function module>+<function offset> a second time without its patched sites
(fo_<address>) and lists that copy at the trampoline's address in <module>'s function table, so the call reaches
the original code and not the hook again.
A replacement word `@call:<module>+<offset>` is a call of the function there that writes no x30: every register in
the Cpu at the call and all read back after it (the callback may change any of them, as exlaunch's hook context
allows); the flags stay as they were. It may stand before the site's last word, which is then the original
instruction.
A `hook` line names guest functions (module offsets of function starts; gen.py stops on any other address) whose
entry the runtime watches: their lifted C starts with FN_ENTER (runtime/cpu.h), a load of g_fnprof and a predicted
branch to fnprof_hit while the runtime sets it. A table with hook lines puts FN_ENTER into these functions only; a table
without any keeps it in every function, as does gen.py --fn-enter-all (a whole-game function-entry profile).
"""
from pathlib import Path
PAGE = 0x1000
PICK_MAX = 255 # ordered sets on one site: rt_patch_pick is a byte, 0 for none
class PatchError(ValueError):
@@ -49,41 +97,106 @@ def adrp(pc, target, rd):
class Table:
"""sets: [(name, env, default)]; sites: {module: {offset: [(set index, [word | ('page', reg)], original)]}} (the
alternatives of a site in file order); page."""
alternatives of a site in file order); page; ordered: the indices of the ordered sets. What the generated C takes
from here (for_module, picks_for, spins_for, hooks_for) is in the lift cache's key (recomp/gen.py chunk_key); a new
kind of line the Emitter reads must go there too."""
def __init__(self, sets=(), sites=None, page=0, spins=None):
def __init__(self, sets=(), sites=None, page=0, spins=None, hooks=None, ordered=(), plugins=None):
self.sets = list(sets)
self.sites = sites or {}
self.page = page
self.spins = spins or {} # {module: {back-edge offset: head offset}}
self.hooks = hooks or {} # {module: {function offset}}; empty: FN_ENTER in every function
self.ordered = set(ordered)
# {module: {'set', 'sha256', 'image', 'expect': [(module, offset, old, new)], 'stubs': {offset},
# 'seeds': {offset}, 'origs': {trampoline offset: (function module, function offset)}}}; empty without
# plugin lines
self.plugins = plugins or {}
self.bases = {} # {module: base} of the layout load() read
def plugin_inputs(self, name):
"""What the lift of module name takes from its plugin lines (for the lift cache's key), or None."""
p = self.plugins.get(name)
if not p:
return None
return [p['image'], p['sha256'], sorted(p['stubs']), sorted(p['seeds']), sorted(p['origs'])]
def origs_for(self, name, base):
"""The absolute addresses of module name's functions that a plugin's `orig` line copies."""
return {base + fo for p in self.plugins.values() for fm, fo in p['origs'].values() if fm == name}
def orig_entries(self, name, bases):
"""{trampoline address in module name: absolute address of the function it reaches} (`orig`)."""
p = self.plugins.get(name)
if not p:
return {}
return {bases[name] + t: bases[fm] + fo for t, (fm, fo) in p['origs'].items()}
def picks(self):
"""The contested sites, by module name and offset: [(module, offset, [ordered set index in file order])]; the
list index is the site's rt_patch_pick byte."""
out = []
for name in sorted(self.sites):
for off in sorted(self.sites[name]):
sets = [k for k, _, _ in self.sites[name][off] if k in self.ordered]
if len(sets) > 1:
if len(sets) > PICK_MAX:
raise PatchError(f'{name}+{off:#x}: {len(sets)} ordered sets, at most {PICK_MAX}')
out.append((name, off, sets))
return out
def picks_for(self, name, base):
"""{absolute address of a contested site: (its pick index, {ordered set index: the value that runs it})}."""
return {base + off: (n, {k: j + 1 for j, k in enumerate(sets)})
for n, (mod, off, sets) in enumerate(self.picks()) if mod == name}
def hooks_for(self, name, base):
"""The absolute addresses of the module's hooked functions, or None when the table has no hook line at all
(FN_ENTER in every function)."""
if not self.hooks:
return None
return {base + o for o in self.hooks.get(name, ())}
def spins_for(self, name, base):
"""{absolute back-edge address: absolute head address}."""
return {base + b: base + h for b, h in self.spins.get(name, {}).items()}
def for_module(self, name, base):
"""{absolute address: [(set index, [words])]} with @page resolved."""
def for_module(self, name, base, bases=None):
"""{absolute address: [(set index, [words])]} with @page resolved; an @call word becomes ('call', absolute
address), which needs bases ({module: base})."""
out = {}
def word(a, w):
if not isinstance(w, tuple):
return w
if w[0] == 'page':
return adrp(a, self.page, w[1])
known = bases or self.bases
if w[1] not in known:
raise PatchError(f'{name}+{a - base:#x}: @call into {w[1]}, which is not in the layout')
return ('call', known[w[1]] + w[2])
for off, alts in self.sites.get(name, {}).items():
a = base + off
out[a] = [(k, [adrp(a, self.page, w[1]) if isinstance(w, tuple) else w for w in repl])
for k, repl, _ in alts]
out[a] = [(k, [word(a, w) for w in repl]) for k, repl, _ in alts]
return out
def load(path, mods):
"""Table from a patch file; mods is layout() output [(name, base, size)]."""
sets, index, sites, spins = [], {}, {}, {}
sets, index, sites, spins, hooks, ordered, plugins = [], {}, {}, {}, {}, set(), {}
bases = {n: (b, s) for n, b, s in mods}
for no, raw in enumerate(Path(path).read_text().splitlines(), 1):
for no, raw in enumerate(Path(path).read_text(encoding='utf-8').splitlines(), 1):
f = raw.split('#', 1)[0].split()
if not f:
continue
where = f'{path}:{no}'
if f[0] == 'set' and len(f) == 4:
if f[0] == 'set' and (len(f) == 4 or len(f) == 5 and f[4] == 'ordered'):
if f[1] in index:
raise PatchError(f'{where}: set {f[1]} defined twice')
index[f[1]] = len(sets)
if len(f) == 5:
ordered.add(len(sets))
sets.append((f[1], f[2], int(f[3])))
elif f[0] == 'site' and len(f) >= 6:
if f[1] not in index:
@@ -95,6 +208,11 @@ def load(path, mods):
for w in f[5:]:
if w.startswith('@page:x'):
repl.append(('page', int(w[7:])))
elif w.startswith('@call:') and '+' in w:
target, at = w[6:].split('+', 1)
if target not in bases:
raise PatchError(f'{where}: @call into {target}, which is not in the layout')
repl.append(('call', target, int(at, 16)))
else:
repl.append(int(w, 16))
alts = sites.setdefault(f[2], {}).setdefault(off, [])
@@ -112,6 +230,19 @@ def load(path, mods):
if b in mod:
raise PatchError(f'{where}: {f[1]}+{b:#x} is a back-edge twice')
mod[b] = head
elif f[0] == 'plugin' and len(f) == 5:
if f[1] not in index or f[2] not in bases:
raise PatchError(f'{where}: unknown set {f[1]} or module {f[2]}')
if f[2] in plugins:
raise PatchError(f'{where}: module {f[2]} has two plugin lines')
plugins[f[2]] = {'set': index[f[1]], 'sha256': f[3], 'image': f[4], 'expect': [], 'stubs': set(),
'seeds': set(), 'origs': {}}
elif f[0] in ('expect', 'stub', 'seed', 'orig'):
plugin_line(f, where, index, bases, plugins)
elif f[0] == 'hook' and len(f) >= 3:
if f[1] not in bases:
raise PatchError(f'{where}: module {f[1]} not in the layout')
hooks.setdefault(f[1], set()).update(int(o, 16) for o in f[2:])
else:
raise PatchError(f'{where}: cannot parse {raw!r}')
base, size = bases['main'][0], bases['main'][1]
@@ -119,7 +250,36 @@ def load(path, mods):
nxt = min((b for _, b, _ in mods if b > base), default=None)
if nxt is not None and page + PAGE > nxt:
raise PatchError(f'no room for the patch page after main ({page:#x})')
return Table(sets, sites, page, spins)
table = Table(sets, sites, page, spins, hooks, ordered, plugins)
table.bases = {n: b for n, (b, _) in bases.items()}
return table
def plugin_line(f, where, index, bases, plugins):
"""An expect, stub, seed or orig line into the plugin entry it belongs to (its `plugin` line comes first)."""
def plugin(name):
if name not in plugins:
raise PatchError(f'{where}: {name} has no plugin line before this one')
return plugins[name]
if f[0] == 'expect' and len(f) == 6:
if f[1] not in index or f[2] not in bases:
raise PatchError(f'{where}: unknown set {f[1]} or module {f[2]}')
owner = [p for p in plugins.values() if p['set'] == index[f[1]]]
if not owner:
raise PatchError(f'{where}: set {f[1]} owns no plugin')
owner[0]['expect'].append((f[2], int(f[3], 16), int(f[4], 16), int(f[5], 16)))
elif f[0] == 'stub' and len(f) == 3:
plugin(f[1])['stubs'].add(int(f[2], 16))
elif f[0] == 'seed' and len(f) >= 3:
plugin(f[1])['seeds'].update(int(o, 16) for o in f[2:])
elif f[0] == 'orig' and len(f) == 6:
p = plugin(f[2])
if f[1] not in index or p['set'] != index[f[1]] or f[4] not in bases:
raise PatchError(f'{where}: orig of set {f[1]} for {f[2]}, which another set owns, or module {f[4]}')
p['origs'][int(f[3], 16)] = (f[4], int(f[5], 16))
else:
raise PatchError(f'{where}: cannot parse {" ".join(f)!r}')
def check(table, mod, name):
@@ -155,4 +315,24 @@ def header_text(table, marker):
'// X(index, name, env switch, default)',
'#define RT_PATCH_SETS(X) ' + ' '.join(f'X({i}, {n}, "{e}", {d})' for i, (n, e, d) in
enumerate(table.sets)), '']
if table.plugins: # none: the header is what it was before plugins
names = sorted(table.plugins)
writes = [f'X({i}, "{m}", {o:#x}, {old:#010x}u, {new:#010x}u)' for i, n in enumerate(names)
for m, o, old, new in sorted(table.plugins[n]['expect'])]
lines += [f'#define RT_PLUGIN_COUNT {len(names)}',
'// X(index, module, its set, SHA-256 of its .text after the init)',
'#define RT_PLUGINS(X) ' + ' '.join(f'X({i}, "{n}", {table.plugins[n]["set"]}, '
f'"{table.plugins[n]["sha256"]}")' for i, n in enumerate(names)),
f'#define RT_PLUGIN_WRITE_COUNT {len(writes)}',
'// X(plugin index, module, offset, old word, new word): what the init writes into game modules',
'#define RT_PLUGIN_WRITES(X) ' + ' '.join(writes),
'// X(module, offset): the hook entries (seed lines) TOTK_PLUGIN_TRACE counts (runtime/plugin_init.c)',
'#define RT_PLUGIN_ROOTS(X) ' + ' '.join(f'X("{n}", {o:#x})' for n in names
for o in sorted(table.plugins[n]['seeds'])), '']
picks = table.picks()
if picks: # none: the header is what it was before ordered sets
lines += [f'#define RT_PATCH_PICK_COUNT {len(picks)}',
'// X(index, module, module offset, its ordered sets in the order its C tests them: rt_patch_pick 1 up)',
'#define RT_PATCH_PICKS(X) ' + ' '.join(f'X({i}, "{m}", {o:#x}, {", ".join(map(str, s))})'
for i, (m, o, s) in enumerate(picks)), '']
return '\n'.join(lines)
+246
View File
@@ -0,0 +1,246 @@
"""V registers in C locals (gen.py --v-locals K): a rewrite of one emitted function's C.
The lifter writes V registers as `c->v[n]`, lane forms `((T *)&c->v[n])[i]`, the register macros of runtime/simd.h
(VREG, VQ, VW, VS32, ...) and helper calls that name registers by number (fp_op_s(c, op, d, n, m), ...). A chunk
generated with K > 0 defines RT_VLOCALS, under which those macros and helpers reach a register through a local array
`u128 vr[32]` when its bit in the function's VMASK is set, else through c->v; every access is a whole-vector load or
store, so clang's SROA keeps each local register in an XMM register. This module
- turns the direct forms into the accessors (c->v[n] = e -> VSET, c->v[n] -> VGET, lane forms -> VLANE/VLSET),
- picks the K registers the function names most often (VMASK),
- loads them at entry; before every call, rt_dispatch, rt_svc/rt_udf/rt_brk, rt_spin_gate and exit stores the ones
the function writes (VSYNC_OUT_D: only if the dirty mask may have the bit; the mask folds to a constant on most
paths); after a call reloads them, except V8-V15 with trust (AAPCS64: a callee preserves their low 64 bits, and a
conforming caller does not read their upper halves after the call).
Why the cap: 32 guest registers on 16 XMM registers spill (all 32 cost +20% instructions, the stack traffic tripled),
while K = 6..8 removed a quarter of the c->v traffic and kept dependent FP chains in registers; build/v143-vloc
NOTES.md has the measurements.
"""
import re
from collections import Counter
# Default K: 8 cut guest time 3.9-6.2% in the town on a 7900X against K = 0 (build/v143-vloc NOTES.md, series s1 and g1).
LOCALS = 8
# runtime/simd.h helpers that take VCTX, with their parameters after c. Register-number parameters are d (written,
# also read by some), n, m, a (read) and t (the first of up to 4 consecutive registers; written by the sl_ld* loads).
HELPERS = {
'fp_op_s': ['op', 'd', 'n', 'm'],
'fp_op_d': ['op', 'd', 'n', 'm'],
'fp_fma_s': ['na', 'nn', 'd', 'n', 'm', 'a'],
'fp_fma_d': ['na', 'nn', 'd', 'n', 'm', 'a'],
'sl_gen': ['op', 'sz', 'ne', 'd', 'szd', 'offd', 'keep', 'n', 'szn', 'offn', 'm', 'szm', 'offm', 'bidx', 'bimm'],
'sl_addlp': ['u', 'acc', 'Q', 'sz', 'd', 'n'],
'sl_across': ['op', 'u', 'Q', 'sz', 'd', 'n'],
'sl_pmull64': ['part', 'd', 'n', 'm'],
'sv_fred_s': ['op', 'd', 'n'],
'sv_fcvtl': ['sz', 'part', 'd', 'n'],
'sv_fcvtn': ['sz', 'part', 'odd', 'd', 'n'],
'sv_tbl': ['Q', 'len', 'tbx', 'd', 'n', 'm'],
'sv_aes': ['op', 'd', 'n'],
'sv_sha1hash': ['op', 'd', 'n', 'm'],
'sv_sha256hash': ['part1', 'd', 'n', 'm'],
'sv_sha_misc': ['op', 'd', 'n', 'm'],
'sl_ldm': ['Q', 'sz', 'selem', 'rpt', 't', 'ea'],
'sl_stm': ['Q', 'sz', 'selem', 'rpt', 't', 'ea'],
'sl_lds': ['sz', 'selem', 'idx', 't', 'ea'],
'sl_sts': ['sz', 'selem', 'idx', 't', 'ea'],
'sl_ldr': ['Q', 'sz', 'selem', 't', 'ea'],
}
REG_PARAMS = ('d', 'n', 'm', 'a', 't')
LANE_T = {'sa16': 'vu16', 'sa32': 'vu32', 'sa64': 'vu64', 'saf32': 'vf32', 'saf64': 'vf64', 'uint8_t': 'vu8',
'uint16_t': 'vu16', 'uint32_t': 'vu32', 'uint64_t': 'vu64', 'float': 'vf32', 'double': 'vf64'}
CALLEE_SAVED = frozenset(range(8, 16))
PLAIN = '\n const unsigned VMASK = 0; u128 *const vr = c->v; unsigned vd_ = 0, *const vdp = &vd_; (void)vr; (void)vdp;'
FN = re.compile(r'^(?:static )?void (?:f|fb)_[0-9a-f]+\(Cpu \*c\) \{$', re.M)
CALL = re.compile(r'\b(?:f|fb)_[0-9a-f]+\(c\);|\brt_dispatch\(c\);|\brt_(?:svc|udf|brk|spin_gate)\(c,[^;]*;')
RET = re.compile(r'(?:__attribute__\(\(musttail\)\)\s*)?\breturn\b[^;]*;')
RET_BLOCK = re.compile(r'(\{ [^{}]*?(?:__attribute__\(\(musttail\)\) )?return\b[^;]*; \})')
LANE = re.compile(r'\(\((\w+) \*\)&c->v\[')
WHOLE = re.compile(r'c->v\[')
USES = re.compile(r'\b(' + '|'.join(['VSET', 'VLSET', 'VGET', 'VLANE', 'VS8', 'VS16', 'VS32', 'VS64', 'VSF32', 'VSF64',
'VHI64', 'VREG', 'VQ', 'VW', 'FP_SETS', 'FP_SETD', 'SV_FOP_S', 'SV_FOP_D']
+ sorted(HELPERS)) + r')\(')
class Unsupported(ValueError):
pass
def _close(s, i):
"""s[i-1] opens a bracket; the index after its match"""
d = 1
while d:
d += {'[': 1, ']': -1}.get(s[i], 0)
i += 1
return i
def _stmt_end(s, i):
"""index of the ';' that ends the expression starting at s[i]"""
d = 0
while True:
ch = s[i]
if ch in '([{':
d += 1
elif ch in ')]}':
d -= 1
elif ch == ';' and d == 0:
return i
i += 1
def _args(s, i):
"""arguments of the call whose '(' is s[i]"""
d, cur, out = 0, '', []
while True:
ch = s[i]
if ch == '(':
d += 1
if d == 1:
i += 1
continue
elif ch == ')':
d -= 1
if d == 0:
out.append(cur.strip())
return out
elif ch == ',' and d == 1:
out.append(cur.strip())
cur = ''
i += 1
continue
cur += ch
i += 1
def accessors(t):
"""c->v forms of emitted C -> the RT_VLOCALS accessors of runtime/simd.h"""
out, i = [], 0
while True:
m1, m2 = LANE.search(t, i), WHOLE.search(t, i)
m = min((x for x in (m1, m2) if x), key=lambda x: x.start(), default=None)
if not m:
out.append(t[i:])
return ''.join(out)
out.append(t[i:m.start()])
if m is m1:
e = _close(t, m.end())
if m.group(1) not in LANE_T or t[e:e + 2] != ')[':
raise Unsupported(f'V register pointer form {t[m.start():e + 10]!r}')
je = _close(t, e + 2)
reg, lane, vt = accessors(t[m.end():e - 1]), t[e + 2:je - 1], LANE_T[m.group(1)]
a = re.match(r'\s*=(?!=)', t[je:])
if a:
se = _stmt_end(t, je + a.end())
out.append(f'VLSET({reg}, {vt}, {lane}, {accessors(t[je + a.end():se]).strip()})')
i = se
else:
out.append(f'VLANE({reg}, {vt}, {lane})')
i = je
continue
if t[m.start() - 1:m.start()] == '&':
raise Unsupported(f'V register address {t[m.start() - 1:m.start() + 20]!r}')
e = _close(t, m.end())
reg = accessors(t[m.end():e - 1])
a = re.match(r'\s*=(?!=)', t[e:])
if a:
se = _stmt_end(t, e + a.end())
out.append(f'VSET({reg}, {accessors(t[e + a.end():se]).strip()})')
i = se
else:
out.append(f'VGET({reg})')
i = e
def _lit(a):
a = a.strip().rstrip('uUlL')
if re.fullmatch(r'-\d+', a):
return -1
return int(a, 0) if re.fullmatch(r'0x[0-9a-fA-F]+|\d+', a) else None
def registers(body):
"""(Counter of register uses, set of written registers) of a body in accessor form"""
used, wr = Counter(), set()
for m in USES.finditer(body):
name = m.group(1)
args = _args(body, m.end() - 1)
if name in HELPERS:
for p, a in zip(['c'] + HELPERS[name], args):
if p not in REG_PARAMS:
continue
v = _lit(a)
if v == -1:
continue
if v is None:
raise Unsupported(f'register argument {a!r} of {name}')
span = 4 if p == 't' or (name == 'sv_tbl' and p == 'n') else 1
rs = [(v + k) & 31 for k in range(span)]
used.update(rs)
if p == 'd' or (p == 't' and name.startswith('sl_ld')):
wr.update(rs)
continue
pos, write = {'VREG': (1, False), 'VQ': (2, False), 'VW': (2, True), 'SV_FOP_S': (2, True),
'SV_FOP_D': (2, True), 'VSET': (0, True), 'VLSET': (0, True), 'FP_SETS': (0, True),
'FP_SETD': (0, True)}.get(name, (0, False))
v = _lit(args[pos])
if v is None or v < 0:
raise Unsupported(f'register {args[pos]!r} of {name}')
used[v] += 1
if write:
wr.add(v)
return used, wr
def rewrite_one(body, k, trust, stats):
"""Body of one C function (text between its braces)."""
try:
new = accessors(body)
cnt, written = registers(new)
except Unsupported:
# a form this rewrite does not know: every register stays in c->v (VMASK 0)
stats['v_unsupported_functions'] += 1
return PLAIN + body
body = new
if not cnt:
return body
local = {r for r, _ in sorted(cnt.items(), key=lambda x: (-x[1], x[0]))[:k]}
written &= local
load = ''.join(f'VSYNC_IN({r}); ' for r in sorted(local))
reload = ''.join(f'VSYNC_IN({r}); ' for r in sorted(local - (CALLEE_SAVED if trust else set())))
store = ''.join(f'VSYNC_OUT_D({r}); ' for r in sorted(written))
stats['v_local_functions'] += 1
stats['v_local_registers'] += len(local)
def at_ret(m):
stats['v_exit_syncs'] += 1
return '{ ' + store + m.group(0) + ' }'
def at_call(m):
stats['v_call_syncs'] += 1
return '{ ' + store + m.group(0) + ' ' + reload + 'vd_ = 0; }'
body = RET.sub(at_ret, body)
parts = RET_BLOCK.split(body)
body = ''.join(p if i % 2 else CALL.sub(at_call, p) for i, p in enumerate(parts))
mask = sum(1 << r for r in local)
return (f'\n const unsigned VMASK = {mask:#x}u; u128 vr[32]; unsigned vd_ = 0, *const vdp = &vd_; {load.rstrip()}'
+ body + ('\n ' + store.rstrip() if store else ''))
def rewrite(text, k, trust, stats):
"""C text of one emitted guest function (an f_ and, for a computed branch, its fb_) with K registers local."""
out, pos = [], 0
for m in FN.finditer(text):
d, i = 1, m.end()
while d:
d += {'{': 1, '}': -1}.get(text[i], 0)
i += 1
out.append(text[pos:m.end()])
out.append(rewrite_one(text[m.end():i - 1], k, trust, stats) + text[i - 1])
pos = i
out.append(text[pos:])
return ''.join(out)
+289
View File
@@ -0,0 +1,289 @@
// Sound categories (music, effects, voices) for the volume_music / volume_sfx / volume_voice settings.
//
// The audio renderer only sees sample memory, so the category is learned where the game loads its sounds:
// - RomFS opens and reads of Sound/Resource/ files (romfs.c romfs_open / romfs_read): the file name gives the
// category (BGM_* music, NV_* and *_Vo_* / *Voice* voices, the rest effects);
// - zstd decodes of BARS banks (ov_zstd.c decode): each bank entry's AMTA name refines the bank's category;
// - Opus decodes (ov_media.c ov_decode): the decoded PCM inherits the category of the packet it came from.
// Two tables answer the mixer (audio_mixer.c voice_category):
// - DSP-ADPCM coefficient tables, by a hash of their 32 bytes, read from each BWAV channel header. The game copies
// these coefficients next to the voice, so a voice's own table names its sound wherever its samples live;
// - guest address ranges of loaded or decoded audio, newest first, for PCM voices (Opus output).
// Everything here runs only while one of the three settings is below 100 (audio_cat_active): at the defaults no table
// is written or read. A setting moved during play classifies what loads from then on; sounds loaded before (an area's
// effect banks, a stream opened earlier) are found when their next stream read lands, otherwise they count as effects.
#include "audio_cat.h"
#include "cfg.h"
#include "host.h"
#include "platform/platform.h"
#include <stdatomic.h>
#include <string.h>
#include <strings.h>
#define RANGE_CAP 4096 // address ranges, a ring: the oldest go first. Lookups scan it, so it stays small
#define COEF_CAP 65536 // coefficient tables, open addressing; a full probe run drops the new table (it counts as SFX)
#define COEF_PROBES 64
typedef struct {
uint64_t start, end;
uint8_t cat;
} Range;
static Range ranges[RANGE_CAP];
static uint32_t range_head; // ranges written so far; under range_lock
static PlatMutex range_lock = PLAT_MUTEX_INIT;
typedef struct {
_Atomic uint64_t hash; // 0 = free; a slot is claimed once and never freed
_Atomic uint8_t cat;
} Coef;
static Coef coefs[COEF_CAP];
typedef struct {
uint64_t guest;
uint8_t cat;
} Decoder;
static Decoder decoders[64]; // the category each Opus decoder produced last; under decoder_lock
static unsigned decoder_next;
static PlatMutex decoder_lock = PLAT_MUTEX_INIT;
static _Atomic uint64_t coef_count[4], range_count, bars_count;
int audio_cat_active(void) {
static _Atomic unsigned seen = ~0u;
static _Atomic int on;
unsigned ver = cfg_version();
if (atomic_load_explicit(&seen, memory_order_acquire) != ver) {
int a = cfg_double("TOTK_VOLUME_MUSIC") < 100 || cfg_double("TOTK_VOLUME_SFX") < 100 ||
cfg_double("TOTK_VOLUME_VOICE") < 100;
atomic_store_explicit(&on, a, memory_order_relaxed);
atomic_store_explicit(&seen, ver, memory_order_release);
}
return atomic_load_explicit(&on, memory_order_relaxed);
}
static int ci_str_has(const char *haystack, const char *needle) {
size_t nlen = strlen(needle);
for (; *haystack; haystack++)
if (strncasecmp(haystack, needle, nlen) == 0) return 1;
return 0;
}
static int all_zero32(const uint8_t *p) {
for (int i = 0; i < 32; i++)
if (p[i]) return 0;
return 1;
}
static uint64_t fnv1a32(const uint8_t *p) {
uint64_t h = 14695981039346656037ULL;
for (int i = 0; i < 32; i++) {
h ^= p[i];
h *= 1099511628211ULL;
}
return h ? h : 1;
}
// A table seen under several categories keeps music or voice over effects: one sample shared by a voice line and an
// effect bank follows the voice setting.
static void register_coef32(const uint8_t *coef, int cat) {
if (cat <= AUDIO_CAT_UNKNOWN || cat > AUDIO_CAT_VOICE || all_zero32(coef)) return;
uint64_t h = fnv1a32(coef);
for (uint32_t step = 0; step < COEF_PROBES; step++) {
Coef *e = &coefs[((uint32_t)h + step) & (COEF_CAP - 1)];
uint64_t cur = atomic_load_explicit(&e->hash, memory_order_acquire);
if (cur == 0 && atomic_compare_exchange_strong_explicit(&e->hash, &cur, h, memory_order_acq_rel,
memory_order_acquire)) {
atomic_store_explicit(&e->cat, (uint8_t)cat, memory_order_release);
atomic_fetch_add_explicit(&coef_count[cat], 1, memory_order_relaxed);
return;
}
if (cur == h) {
if (cat != AUDIO_CAT_SFX) atomic_store_explicit(&e->cat, (uint8_t)cat, memory_order_release);
return;
}
}
}
int audio_cat_lookup_coef(uint64_t extra_addr, uint64_t extra_size) {
if (!extra_addr || extra_size < 32 || extra_addr >= RT_ADDRESS_LIMIT || !mem_guest_readable(extra_addr, 32))
return AUDIO_CAT_UNKNOWN;
const uint8_t *p = (const uint8_t *)(uintptr_t)extra_addr;
if (all_zero32(p)) return AUDIO_CAT_UNKNOWN;
uint64_t h = fnv1a32(p);
for (uint32_t step = 0; step < COEF_PROBES; step++) {
Coef *e = &coefs[((uint32_t)h + step) & (COEF_CAP - 1)];
uint64_t cur = atomic_load_explicit(&e->hash, memory_order_acquire);
if (cur == h) return atomic_load_explicit(&e->cat, memory_order_acquire); // 0 while the writer is midway
if (cur == 0) break;
}
return AUDIO_CAT_UNKNOWN;
}
// BWAV: "BWAV", channel count at 0x0E, then 0x4C-byte channel infos from 0x10: codec u16 (1 = DSP-ADPCM) and the 16
// ADPCM coefficients at +0x10.
void audio_cat_scan_bwav(const void *data, uint64_t size, int cat) {
if (!data || size < 0x40 || cat <= AUDIO_CAT_UNKNOWN) return;
const uint8_t *b = data;
uint32_t magic;
uint16_t nch;
memcpy(&magic, b, 4);
memcpy(&nch, b + 0x0E, 2);
if (magic != 0x56415742u || nch == 0 || nch > 16) return;
for (uint16_t ch = 0; ch < nch; ch++) {
uint64_t at = 0x10ull + ch * 0x4Cull;
if (at + 0x30 > size) break;
uint16_t codec;
memcpy(&codec, b + at, 2);
if (codec == 1) register_coef32(b + at + 0x10, cat);
}
}
// Every sound bank and stream of the game is under Sound/Resource/ (Sound/Resource/*.bars.zs, Sound/Resource/Stream/
// *.bwav); everything else is not audio. Creature and player vocal banks (Bokoblin_Voice0, Player_Voice, *_Vo_*)
// count as voices, as do the NV_* character voice lines.
int audio_cat_from_path(const char *path) {
if (!path || strncmp(path, "Sound/Resource/", 15)) return AUDIO_CAT_UNKNOWN;
const char *name = strrchr(path, '/') + 1;
if (!strncasecmp(name, "nv_", 3) || !strncasecmp(name, "vo_", 3)) return AUDIO_CAT_VOICE;
if (ci_str_has(name, "bgm_")) return AUDIO_CAT_MUSIC;
if (ci_str_has(name, "_voice") || ci_str_has(name, "voice_") || ci_str_has(name, "_vo_") ||
ci_str_has(name, "shoutvoice") || ci_str_has(name, "shoutmsg"))
return AUDIO_CAT_VOICE;
return AUDIO_CAT_SFX;
}
void audio_cat_tag_range(uint64_t addr, uint64_t size, int cat) {
if (!addr || !size || cat <= AUDIO_CAT_UNKNOWN || cat > AUDIO_CAT_VOICE) return;
plat_mutex_lock(&range_lock);
// A stream refills the same buffers: the same range read again only changes its category.
uint32_t depth = range_head < 64 ? range_head : 64;
for (uint32_t k = 0; k < depth; k++) {
Range *r = &ranges[(range_head - 1 - k) & (RANGE_CAP - 1)];
if (r->start == addr && r->end == addr + size) {
r->cat = (uint8_t)cat;
plat_mutex_unlock(&range_lock);
return;
}
}
Range *r = &ranges[range_head & (RANGE_CAP - 1)];
r->start = addr;
r->end = addr + size;
r->cat = (uint8_t)cat;
range_head++;
plat_mutex_unlock(&range_lock);
atomic_fetch_add_explicit(&range_count, 1, memory_order_relaxed);
}
// The newest range holding addr; newer loads into reused memory win over older ones.
int audio_cat_lookup(uint64_t addr) {
if (!addr) return AUDIO_CAT_UNKNOWN;
int cat = AUDIO_CAT_UNKNOWN;
plat_mutex_lock_shared(&range_lock);
uint32_t n = range_head < RANGE_CAP ? range_head : RANGE_CAP;
for (uint32_t k = 0; k < n; k++) {
const Range *r = &ranges[(range_head - 1 - k) & (RANGE_CAP - 1)];
if (addr >= r->start && addr < r->end) {
cat = r->cat;
break;
}
}
plat_mutex_unlock_shared(&range_lock);
return cat;
}
// BARS: "BARS", entry count at 0x0C, then count CRC32 name hashes and count (AMTA offset, BWAV offset) pairs. The AMTA
// block holds the entry's name; music and voice names inside an effects bank (a boss bank with its BGM) get their own
// category. ADPCM entries register their coefficients; other entries tag their bytes.
void audio_cat_scan_bars(uint64_t dst, uint64_t size, int fallback_cat) {
if (!dst || size < 16) return;
atomic_fetch_add_explicit(&bars_count, 1, memory_order_relaxed);
if (fallback_cat != AUDIO_CAT_UNKNOWN) audio_cat_tag_range(dst, size, fallback_cat);
const uint8_t *base = (const uint8_t *)(uintptr_t)dst;
uint32_t count;
memcpy(&count, base + 0x0C, 4);
if (count > 16384 || 0x10ull + (uint64_t)count * 12ull > size) return;
const uint8_t *pairs = base + 0x10 + (uint64_t)count * 4;
for (uint32_t k = 0; k < count; k++) {
uint32_t amta_off, bwav_off;
memcpy(&amta_off, pairs + k * 8ull, 4);
memcpy(&bwav_off, pairs + k * 8ull + 4, 4);
if (bwav_off >= size) continue;
int cat = fallback_cat != AUDIO_CAT_UNKNOWN ? fallback_cat : AUDIO_CAT_SFX;
if (amta_off < size) {
uint64_t limit = size - amta_off < 512 ? size - amta_off : 512;
const char *a = (const char *)(base + amta_off);
for (uint64_t s = 0; s + 4 <= limit; s++) {
if (!memcmp(a + s, "BGM_", 4)) { cat = AUDIO_CAT_MUSIC; break; }
if (!memcmp(a + s, "Vo_", 3) || !memcmp(a + s, "NV_", 3)) { cat = AUDIO_CAT_VOICE; break; }
if (s + 5 <= limit && !memcmp(a + s, "Voice", 5)) { cat = AUDIO_CAT_VOICE; break; }
}
}
const uint8_t *w = base + bwav_off;
uint32_t magic = 0;
uint16_t codec = 0;
if (bwav_off + 0x40 <= size) {
memcpy(&magic, w, 4);
memcpy(&codec, w + 0x10, 2);
}
if (magic == 0x56415742u) audio_cat_scan_bwav(w, size - bwav_off, cat);
if (cat == fallback_cat || (magic == 0x56415742u && codec == 1)) continue;
// The entry ends where the next BWAV starts: one pass over the offsets, only for the few entries tagged here.
uint64_t next = size;
for (uint32_t j = 0; j < count; j++) {
uint32_t o;
memcpy(&o, pairs + j * 8ull + 4, 4);
if (o > bwav_off && o < next) next = o;
}
audio_cat_tag_range(dst + bwav_off, next - bwav_off, cat);
}
}
// The PCM out of one Opus packet takes the packet's category, else the decoder's last one, else effects. Consecutive
// packets of one decoder fill one buffer, so the output grows the newest matching range instead of adding one each.
void audio_cat_on_opus_decode(uint64_t decoder_guest, uint64_t in_addr, uint64_t out_addr, uint64_t out_size) {
if (!out_addr || !out_size) return;
int cat = audio_cat_lookup(in_addr);
plat_mutex_lock(&decoder_lock);
int slot = -1;
for (int i = 0; i < 64 && decoder_guest; i++)
if (decoders[i].guest == decoder_guest) slot = i;
if (cat == AUDIO_CAT_UNKNOWN && slot >= 0) cat = decoders[slot].cat;
if (cat == AUDIO_CAT_UNKNOWN) cat = AUDIO_CAT_SFX;
if (decoder_guest) {
if (slot < 0) {
slot = (int)(decoder_next++ & 63);
decoders[slot].guest = decoder_guest;
}
decoders[slot].cat = (uint8_t)cat;
}
plat_mutex_unlock(&decoder_lock);
plat_mutex_lock(&range_lock);
uint32_t depth = range_head < 32 ? range_head : 32;
for (uint32_t k = 0; k < depth; k++) {
Range *r = &ranges[(range_head - 1 - k) & (RANGE_CAP - 1)];
if (r->cat != (uint8_t)cat) continue;
uint64_t lo = r->start > 65536 ? r->start - 65536 : 0, hi = r->end + 65536;
if (out_addr >= lo && out_addr + out_size <= hi) {
if (out_addr < r->start) r->start = out_addr;
if (out_addr + out_size > r->end) r->end = out_addr + out_size;
plat_mutex_unlock(&range_lock);
return;
}
}
plat_mutex_unlock(&range_lock);
audio_cat_tag_range(out_addr, out_size, cat);
}
void audio_cat_log_tables(void) {
rt_log("audio: categories known: coefficient tables music %llu, sfx %llu, voice %llu; address ranges %llu "
"(ring %d); BARS banks scanned %llu",
(unsigned long long)atomic_load(&coef_count[AUDIO_CAT_MUSIC]),
(unsigned long long)atomic_load(&coef_count[AUDIO_CAT_SFX]),
(unsigned long long)atomic_load(&coef_count[AUDIO_CAT_VOICE]), (unsigned long long)atomic_load(&range_count),
RANGE_CAP, (unsigned long long)atomic_load(&bars_count));
}
+30
View File
@@ -0,0 +1,30 @@
// Sound categories for the music / effects / voice volume settings (audio_cat.c).
#ifndef TOTK_AUDIO_CAT_H
#define TOTK_AUDIO_CAT_H
#include <stddef.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
enum {
AUDIO_CAT_UNKNOWN = 0,
AUDIO_CAT_MUSIC = 1,
AUDIO_CAT_SFX = 2,
AUDIO_CAT_VOICE = 3,
};
int audio_cat_active(void); // one of volume_music / volume_sfx / volume_voice is below 100
int audio_cat_from_path(const char *path); // a RomFS-relative path; UNKNOWN outside Sound/Resource/
void audio_cat_tag_range(uint64_t addr, uint64_t size, int cat);
void audio_cat_scan_bars(uint64_t dst, uint64_t size, int fallback_cat);
void audio_cat_scan_bwav(const void *data, uint64_t size, int cat);
void audio_cat_on_opus_decode(uint64_t decoder_guest, uint64_t in_addr, uint64_t out_addr, uint64_t out_size);
int audio_cat_lookup(uint64_t addr);
int audio_cat_lookup_coef(uint64_t extra_addr, uint64_t extra_size);
void audio_cat_log_tables(void);
#ifdef __cplusplus
}
#endif
#endif
+212 -23
View File
@@ -28,6 +28,7 @@
#include "cfg.h"
#include "audio_effects.h"
#include "audio_reverb.h"
#include "audio_cat.h"
#include "audren.h"
#include "host.h"
#include "ipc.h"
@@ -52,7 +53,10 @@ typedef struct Mixer {
float *buf; int nbuf, frame;
int *offset; // first mix buffer of each mix id
SplitInfo *split; int nsplit; SplitDest *dest; int ndest;
SDL_AudioStream *stream; int device_ok, rate;
SDL_AudioStream *stream; int device_ok, rate; // stream: output_open's, then the output worker's alone
SDL_AudioDeviceID open_id, failed_id; // the device the stream plays on; the last one that failed to open
PlatThread *worker; PlatEvent wake; // output_worker, NULL until a device is chosen; wake: a cfg change
_Atomic int worker_quit; unsigned watch_ver; // watch_ver: the render thread's last cfg_version (output_watch)
int channels; // output channels, 2 or 6 (output_channels)
float ring[RING_FRAMES * OUT_MAX];
_Atomic uint64_t wr, rd, underruns, overruns, missing_frames, callback_frames, callback_nonzero, skipped_frames;
@@ -83,6 +87,64 @@ static float host_volume(void) {
v = (float)((pct < 0 ? 0 : pct > 100 ? 100 : pct) / 100);
return v;
}
// TOTK_VOLUME_MUSIC / _SFX / _VOICE: per-category volumes in percent on top of TOTK_VOLUME, live like it. Render thread
// only.
static float category_volume(int cat) {
static const char *const names[4] = {NULL, "TOTK_VOLUME_MUSIC", "TOTK_VOLUME_SFX", "TOTK_VOLUME_VOICE"};
static float v[4] = {1, 1, 1, 1};
static unsigned seen = ~0u;
unsigned ver = cfg_version();
if (ver != seen) {
seen = ver;
for (int k = 1; k < 4; k++) {
double pct = cfg_double(names[k]);
v[k] = (float)((pct < 0 ? 0 : pct > 100 ? 100 : pct) / 100);
}
}
return v[cat >= AUDIO_CAT_MUSIC && cat <= AUDIO_CAT_VOICE ? cat : AUDIO_CAT_SFX];
}
// What the voice plays (audio_cat.c): an ADPCM voice by its coefficient table, any voice by the newest loaded or decoded
// range holding its current wave buffer, else effects. Kept per voice until it moves to another buffer or table, so a
// table lookup runs once per wave buffer, not once per frame. The counts feed category_report.
static uint64_t cat_counts[4], cat_by_coef, cat_by_range, cat_ns;
static int voice_category(ServerVoice *v) {
uint64_t addr = v->buffers[v->index].address, extra = v->in.extra_address;
if (v->cat && v->cat_address == addr && v->cat_extra == extra) return v->cat;
uint64_t t0 = kern_now_ns();
int cat = AUDIO_CAT_UNKNOWN;
if (v->in.sample_format == FMT_ADPCM) cat = audio_cat_lookup_coef(extra, v->in.extra_size);
if (cat != AUDIO_CAT_UNKNOWN) cat_by_coef++;
else if ((cat = audio_cat_lookup(addr)) != AUDIO_CAT_UNKNOWN) cat_by_range++;
else cat = AUDIO_CAT_SFX;
cat_counts[cat]++;
v->cat = (uint8_t)cat;
v->cat_address = addr;
v->cat_extra = extra;
cat_ns += kern_now_ns() - t0;
return cat;
}
// While a category volume is set, once a minute: how the wave buffers played were classified and what it cost.
static void category_report(void) {
static uint64_t next;
uint64_t now = kern_now_ns();
if (!next) next = now + 60000000000ull;
if (now < next) return;
next = now + 60000000000ull;
uint64_t n = cat_counts[AUDIO_CAT_MUSIC] + cat_counts[AUDIO_CAT_SFX] + cat_counts[AUDIO_CAT_VOICE];
rt_log("audio: categories over the last minute: %llu wave buffers, music %llu, sfx %llu, voice %llu; by coefficients "
"%llu, by address %llu, unmatched (played as sfx) %llu; %.1f us classifying",
(unsigned long long)n, (unsigned long long)cat_counts[AUDIO_CAT_MUSIC],
(unsigned long long)cat_counts[AUDIO_CAT_SFX], (unsigned long long)cat_counts[AUDIO_CAT_VOICE],
(unsigned long long)cat_by_coef, (unsigned long long)cat_by_range,
(unsigned long long)(n - cat_by_coef - cat_by_range), cat_ns / 1000.0);
audio_cat_log_tables();
memset(cat_counts, 0, sizeof cat_counts);
cat_by_coef = cat_by_range = cat_ns = 0;
}
static unsigned audio_revision(const AudioRenderer *r) { unsigned byte = r->revision >> 24; return byte >= '0' ? byte - '0' : 0; }
static void report_once(Mixer *m, unsigned bit, const char *msg, int value) {
if (m->reported & (1u << bit)) return;
@@ -108,8 +170,41 @@ static int prefill_blocks_for(const char *e) {
return (int)ceil(ms / 5.0);
}
// TOTK_AUDIO_DEVICE: the playback device by the name SDL reports (SDL_GetAudioDeviceName), since SDL's device ids
// change between runs. Unset, empty or "default": the system default, which SDL follows when Windows changes it.
static int device_is_default(const char *want) { return !want || !*want || !strcmp(want, "default"); }
// The device for `want`: the first playback device of that name, *found 1; else the system default, *found 0 for a name
// SDL does not list (unplugged). The default asks SDL nothing.
static SDL_AudioDeviceID device_pick(const char *want, int *found) {
*found = 1;
if (device_is_default(want)) return SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK;
int n = 0;
SDL_AudioDeviceID *ids = SDL_GetAudioPlaybackDevices(&n), id = 0;
for (int i = 0; ids && i < n && !id; i++) {
const char *name = SDL_GetAudioDeviceName(ids[i]);
if (name && !strcmp(name, want)) id = ids[i];
}
SDL_free(ids);
*found = id != 0;
return id ? id : SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK;
}
int audio_output_devices(char (*names)[AUDIO_DEVICE_NAME_MAX], int max) {
if (!SDL_WasInit(SDL_INIT_AUDIO)) return 0; // TOTK_AUDIO=none or no output: nothing to pick
int n = 0, k = 0;
SDL_AudioDeviceID *ids = SDL_GetAudioPlaybackDevices(&n);
for (int i = 0; ids && i < n && k < max; i++) {
const char *name = SDL_GetAudioDeviceName(ids[i]);
if (name && *name && strlen(name) < AUDIO_DEVICE_NAME_MAX) snprintf(names[k++], AUDIO_DEVICE_NAME_MAX, "%s", name);
}
SDL_free(ids);
return k;
}
// TOTK_AUDIO_CHANNELS: the output channels of this run, decided once. stereo gives 2; 5.1 gives 6 (FL FR C LFE RL RR,
// the device sink's order and SDL's); auto gives 6 when the default playback device has at least six channels (a 5.1
// the device sink's order and SDL's); auto gives 6 when the chosen playback device (TOTK_AUDIO_DEVICE at start, the
// system default without one) has at least six channels (a 5.1
// or 7.1 speaker setup in Windows; SDL places 5.1 on 7.1) and 2 otherwise. IAudioDevice reports the same count to the
// game (GetActiveChannelCount), which picks its sink layout from it. TOTK_AUDIO=none: 2, without touching SDL.
static int output_channels(void) {
@@ -122,10 +217,12 @@ static int output_channels(void) {
else if (!strcmp(want, "stereo")) n = 2;
else {
SDL_AudioSpec dev = {0};
n = SDL_InitSubSystem(SDL_INIT_AUDIO) && SDL_GetAudioDeviceFormat(SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK, &dev, NULL) &&
dev.channels >= 6 ? 6 : 2;
rt_log("audio: TOTK_AUDIO_CHANNELS=auto: the default device has %d channels, output %s", dev.channels,
n == 6 ? "5.1" : "stereo");
int found, ok = SDL_InitSubSystem(SDL_INIT_AUDIO);
SDL_AudioDeviceID id = ok ? device_pick(cfg_get("TOTK_AUDIO_DEVICE"), &found) : 0;
n = ok && SDL_GetAudioDeviceFormat(id, &dev, NULL) && dev.channels >= 6 ? 6 : 2;
const char *name = ok ? SDL_GetAudioDeviceName(id) : NULL;
rt_log("audio: TOTK_AUDIO_CHANNELS=auto: device '%s' has %d channels, output %s", name ? name : "?",
dev.channels, n == 6 ? "5.1" : "stereo");
}
int expected = 0;
return atomic_compare_exchange_strong(&decided, &expected, n) ? n : expected;
@@ -207,6 +304,28 @@ static void SDLCALL sdl_pull(void *user, SDL_AudioStream *stream, int additional
}
}
// The pacing figures of the stream's device: its period, the output target and the stall time. Set before the stream
// is resumed; the render thread reads target and stall_ns while a switch sets them (audio_mixer_pace_ns).
static void output_timing(Mixer *m, SDL_AudioSpec *dev) {
int period = 0;
if (!SDL_GetAudioDeviceFormat(SDL_GetAudioStreamDevice(m->stream), dev, &period) || period <= 0) period = m->frame;
m->period = period;
int target = m->frame * m->prefill > 2 * period ? m->frame * m->prefill : 2 * period;
__atomic_store_n(&m->target, target > RING_FRAMES / 2 ? RING_FRAMES / 2 : target, __ATOMIC_RELAXED);
uint64_t period_ns = (uint64_t)period * 1000000000ull / (uint64_t)m->rate;
__atomic_store_n(&m->stall_ns, 4 * period_ns > STALL_MS * 1000000ull ? 4 * period_ns : STALL_MS * 1000000ull,
__ATOMIC_RELAXED);
}
static void output_log(Mixer *m, const char *what, const SDL_AudioSpec *dev) {
const char *name = SDL_GetAudioDeviceName(SDL_GetAudioStreamDevice(m->stream));
rt_log("audio: SDL device '%s' %s, %d Hz %s float (device %d channels), prefill %d ms, device period %d frames; "
"the device paces rendering at %.1f ms queued", name ? name : "?", what, m->rate,
m->channels == 6 ? "5.1" : "stereo", dev->channels, m->prefill * 5, m->period, m->target * 1000.0 / m->rate);
}
static void output_worker_start(Mixer *m);
static void output_open(Mixer *m, int rate) {
const char *mode = cfg_get("TOTK_AUDIO");
if ((mode && !strcmp(mode, "none")) || cfg_get("TOTK_AUDIO_OFF")) {
@@ -217,12 +336,18 @@ static void output_open(Mixer *m, int rate) {
rt_log("audio: SDL audio init failed (%s): mixing without sound", SDL_GetError());
return;
}
const char *want = cfg_get("TOTK_AUDIO_DEVICE");
int found;
m->open_id = device_pick(want, &found);
if (!found) rt_log("audio: TOTK_AUDIO_DEVICE '%s' is not connected: the system default plays", want);
SDL_AudioSpec spec = {SDL_AUDIO_F32, m->channels, rate};
m->stream = SDL_OpenAudioDeviceStream(SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK, &spec, sdl_pull, m);
m->stream = SDL_OpenAudioDeviceStream(m->open_id, &spec, sdl_pull, m);
if (!m->stream) {
rt_log("audio: no output device (%s): mixing without sound", SDL_GetError());
return;
}
SDL_AudioSpec dev = {0};
output_timing(m, &dev);
if (!SDL_ResumeAudioStreamDevice(m->stream)) {
rt_log("audio: starting the output failed (%s): mixing without sound", SDL_GetError());
SDL_DestroyAudioStream(m->stream);
@@ -230,28 +355,84 @@ static void output_open(Mixer *m, int rate) {
return;
}
m->device_ok = 1;
output_log(m, "opened", &dev);
m->watch_ver = cfg_version();
if (!device_is_default(want)) output_worker_start(m); // watches the chosen device from the start
}
// ---- switching the output device while the game plays (TOTK_AUDIO_DEVICE is live)
// One worker thread per mixer, started when a device is first chosen, owns the stream from then on: it opens the new
// device (tens of ms) off the render thread, so the game's audio never waits for it. Once a second, and at once when
// cfg changes, it resolves the setting again: a chosen device that disappears falls back to the system default, and the
// output returns to it within a second of it being plugged in again. SDL's device events are not used: on Windows
// nothing pumps SDL's event queue (the window is Win32, gfx_window_win.c), while SDL's device list stays current.
// Moves the output to device `id` with the same spec; SDL converts to the device's own format and channels.
static void output_switch(Mixer *m, SDL_AudioDeviceID id) {
SDL_AudioSpec spec = {SDL_AUDIO_F32, m->channels, m->rate};
SDL_AudioStream *s = SDL_OpenAudioDeviceStream(id, &spec, sdl_pull, m); // opens paused: no callback yet
if (!s) {
const char *name = SDL_GetAudioDeviceName(id);
rt_log("audio: opening device '%s' failed (%s): the output stays where it was", name ? name : "?",
SDL_GetError());
m->failed_id = id; // not tried again until the setting or the device list leads elsewhere
return;
}
SDL_DestroyAudioStream(m->stream); // closes the old device; returns once its callback has finished
m->stream = s;
m->open_id = id;
m->failed_id = 0;
// No callback runs until the resume: its prefill starts over, and the render thread paces by its timer (pulled_ns
// 0) until the new device asks for audio. The ring and the game go on; ring_pull trims what piled up meanwhile.
m->ready = 0;
atomic_store_explicit(&m->pulled_ns, 0, memory_order_release);
SDL_AudioSpec dev = {0};
int period = 0;
if (!SDL_GetAudioDeviceFormat(SDL_GetAudioStreamDevice(m->stream), &dev, &period) || period <= 0) period = m->frame;
m->period = period;
m->target = m->frame * m->prefill > 2 * period ? m->frame * m->prefill : 2 * period;
if (m->target > RING_FRAMES / 2) m->target = RING_FRAMES / 2;
uint64_t period_ns = (uint64_t)period * 1000000000ull / (uint64_t)rate;
m->stall_ns = 4 * period_ns > STALL_MS * 1000000ull ? 4 * period_ns : STALL_MS * 1000000ull;
const char *name = SDL_GetAudioDeviceName(SDL_GetAudioStreamDevice(m->stream));
rt_log("audio: SDL device '%s' opened, %d Hz %s float (device %d channels), prefill %d ms, device period %d frames; "
"the device paces rendering at %.1f ms queued", name ? name : "?", rate, m->channels == 6 ? "5.1" : "stereo",
dev.channels, m->prefill * 5, period, m->target * 1000.0 / rate);
output_timing(m, &dev);
if (!SDL_ResumeAudioStreamDevice(s)) rt_log("audio: starting the output failed (%s)", SDL_GetError());
output_log(m, "switched to", &dev);
}
static void output_worker(void *p) {
Mixer *m = p;
while (!atomic_load(&m->worker_quit)) {
const char *want = cfg_get("TOTK_AUDIO_DEVICE");
int found;
SDL_AudioDeviceID id = device_pick(want, &found);
if (id != m->open_id && id != m->failed_id) {
if (!found) rt_log("audio: TOTK_AUDIO_DEVICE '%s' is not connected: switching to the system default", want);
output_switch(m, id);
}
if (id == m->open_id) m->failed_id = 0;
plat_event_wait_ns(&m->wake, 1000000000ull);
}
}
static void output_worker_start(Mixer *m) {
plat_event_init(&m->wake, 0, 0);
m->worker = plat_thread_new(output_worker, m, "audio-out");
if (!m->worker) rt_log("audio: no output worker thread: the device stays as it is until the next start");
}
// Render thread: wakes the worker when cfg changed, or starts it when a device is chosen for the first time. Until the
// worker runs the stream plays on the system default (output_open), so an unset setting costs this check alone.
static void output_watch(Mixer *m) {
unsigned ver = cfg_version();
if (ver == m->watch_ver) return;
m->watch_ver = ver;
if (m->worker) plat_event_set(&m->wake);
else if (!device_is_default(cfg_get("TOTK_AUDIO_DEVICE"))) output_worker_start(m);
}
int64_t audio_mixer_pace_ns(AudioRenderer *r, uint64_t now) {
Mixer *m = r->mixer;
if (m && m->device_ok) output_watch(m);
if (!m || !m->device_ok || !atomic_load_explicit(&m->playing, memory_order_acquire)) return -1;
uint64_t pulled = atomic_load_explicit(&m->pulled_ns, memory_order_acquire);
if (!pulled || (now > pulled && now - pulled > m->stall_ns)) return -1;
if (!pulled || (now > pulled && now - pulled > __atomic_load_n(&m->stall_ns, __ATOMIC_RELAXED))) return -1;
uint64_t have = atomic_load(&m->wr) - atomic_load_explicit(&m->rd, memory_order_acquire);
if (have < (uint64_t)m->target) return 0;
int64_t ns = (int64_t)((have - (uint64_t)m->target + 1) * 1000000000ull / (uint64_t)m->rate);
uint64_t target = (uint64_t)__atomic_load_n(&m->target, __ATOMIC_RELAXED);
if (have < target) return 0;
int64_t ns = (int64_t)((have - target + 1) * 1000000000ull / (uint64_t)m->rate);
return ns < 500000 ? 500000 : ns; // until the device has taken it below the target
}
@@ -379,6 +560,11 @@ void audio_mixer_set_running(AudioRenderer *r, int running) {
void audio_mixer_close(AudioRenderer *r) {
Mixer *m = r->mixer;
if (!m) return;
if (m->worker) { // the render thread is joined: nothing wakes or starts the worker any more
atomic_store(&m->worker_quit, 1);
plat_event_set(&m->wake);
plat_thread_join(m->worker);
}
if (m->stream) { // destroying the stream closes the device and waits for the callback to finish
SDL_DestroyAudioStream(m->stream);
SDL_QuitSubSystem(SDL_INIT_AUDIO);
@@ -812,10 +998,13 @@ void audio_mixer_render(AudioRenderer *r, double seconds) {
if (at > m->nbuf) { rt_log("audio: mixes use %d buffers, renderer has %d", at, m->nbuf); rt_fatal("audio mix buffer layout"); }
float (*vs)[MAX_FRAME]=m->voice_scratch,*filtered=m->filter_scratch;
const int by_category = audio_cat_active(); // the defaults (all 100) skip the category lookups
if (by_category) category_report();
for (int i = 0; i < r->param.voice_count; i++) {
ServerVoice *v = &r->voices[i];
if (!v->in.in_use || v->state != SV_STARTED || !v->in.sample_rate || !v->valid[v->index]) continue;
int cc = (int)v->in.channel_count; if (cc < 1 || cc > 6) { report_once(m, 2, "voice channel count unsupported", cc); continue; }
const float vvol = by_category ? v->in.volume * category_volume(voice_category(v)) : v->in.volume;
voice_render(r, v, vs, frames);
for (int f = 0; f < 2; f++) if (v->in.biquads[f].enable) {
const AudrenBiquad *b = &v->in.biquads[f];
@@ -841,13 +1030,13 @@ void audio_mixer_render(AudioRenderer *r, double seconds) {
SplitDest *d = &m->dest[s->ids[k]];
if (!d->used || !mix_valid(r, d->dest)) continue;
const float *source=splitter_filter(d,vs[c],filtered,frames);
for (int b = 0; b < r->mixes[d->dest].buffer_count && b < 24; b++) accumulate(m, m->offset[d->dest] + b, source, d->vol[b] * v->in.volume, frames);
for (int b = 0; b < r->mixes[d->dest].buffer_count && b < 24; b++) accumulate(m, m->offset[d->dest] + b, source, d->vol[b] * vvol, frames);
}
} else if (mix_valid(r, v->in.mix_id)) {
for (int c = 0; c < cc; c++) {
int32_t id = v->in.channel_ids[c]; if (id < 0 || id >= r->param.voice_count * 6) continue;
const AudrenChannelIn *ch = &r->channels[id];
for (int b = 0; b < r->mixes[v->in.mix_id].buffer_count && b < 24; b++) accumulate(m, m->offset[v->in.mix_id] + b, vs[c], ch->mix[b] * v->in.volume, frames);
for (int b = 0; b < r->mixes[v->in.mix_id].buffer_count && b < 24; b++) accumulate(m, m->offset[v->in.mix_id] + b, vs[c], ch->mix[b] * vvol, frames);
}
}
}
+1
View File
@@ -86,6 +86,7 @@ static void voice_reset(ServerVoice *v) {
v->loops_done = 0;
memset(&v->adpcm, 0, sizeof v->adpcm);
memset(v->biquad_state, 0, sizeof v->biquad_state);
v->cat = 0;
}
static void update_voice(AudioRenderer *r, const AudrenVoiceIn *in) {
+6
View File
@@ -145,6 +145,8 @@ typedef struct {
uint32_t consumed, drops;
struct { int16_t history[2]; int32_t buffer; uint64_t at; } adpcm; // DSP-ADPCM decode cursor (buffer slot, next sample) and history
float biquad_state[2][6][2]; // filter, channel: transposed direct-form II delays
uint64_t cat_address, cat_extra; // the wave buffer and coefficients voice_category (audio_mixer.c) last classified
uint8_t cat; // their AUDIO_CAT_*, 0 until classified; voice_reset clears it
} ServerVoice;
enum { SV_STOPPED, SV_STARTED, SV_PAUSED, SV_STOPPING };
@@ -184,6 +186,10 @@ void audio_mixer_render(AudioRenderer *r, double seconds); // after audio_voic
// many ns (the ring is at its target), -1 leaves the pace to the render thread's timer (no device, renderer stopped,
// device stalled).
int64_t audio_mixer_pace_ns(AudioRenderer *r, uint64_t now);
// The playback devices SDL lists now, by name (TOTK_AUDIO_DEVICE takes one), at most max; 0 while SDL audio is not up
// (TOTK_AUDIO=none). Any thread; the Sound tab of the menu lists them.
enum { AUDIO_DEVICE_NAME_MAX = 256 };
int audio_output_devices(char (*names)[AUDIO_DEVICE_NAME_MAX], int max);
uint64_t audio_voice_consumed(const AudioRenderer *r, ServerVoice *v, int frames); // source samples over one frame; advances v->fraction
int audio_buffer_empty(const AudrenWaveBuffer *b); // no samples to decode: played as soon as it is reached
void audio_device_handler(IpcSession *s, const IpcRequest *rq, IpcResponse *rs); // IAudioDevice
+46 -8
View File
@@ -22,7 +22,7 @@
#include "nvn_api.h"
#include "platform/platform.h"
#include "vk.h"
#include "platform/platform.h"
#include "gameplay_tweaks.h"
#define SYM_INIT_START "_ZN2nn4init5StartEmmPFvvES2_S2_"
// main: return addresses of nnMain's SetFocusHandlingMode call (1.1.0 and 1.2.1 from this port's analysis of main;
@@ -30,6 +30,7 @@
#define CHECKPOINT_RET (RT_V143 ? 0xbdb48cull : RT_V110 ? 0xeb8c14ull : 0xe7a954ull)
#define NVN_RET (RT_V143 ? 0xbe0360ull : RT_V110 ? 0xebcdecull : 0xe7eb2cull)
#define CTOR_DONE 2 // a module's constructor flag after its DT_INIT ran the init_array
#define CTOR_WAITING 1 // after a DT_INIT that musl deferred (sdk's, called before main's)
// The init_array sizes (1.1.0 and 1.2.1: counted in the modules; 1.4.3: DT_INIT_ARRAYSZ); MacNativeGames' boot check
// expects the same. The three tables carry the same rows, so cb_module_inits walks them by the size of one.
@@ -40,6 +41,7 @@ static const InitCount inits_143[] = {{"main", 10717}, {"subsdk0", 45}, {"sdk",
#define expected_inits (RT_V143 ? inits_143 : RT_V110 ? inits_110 : inits_121)
static volatile int32_t inits_done, checkpoint_seen;
static int sdk_first; // a mod plugin ran: sdk's DT_INIT came first (cb_module_inits)
uint64_t rt_guest_start_ns;
static const RtLoaded *module_named(const char *name) {
@@ -77,15 +79,28 @@ static void cb_loader_ready(Cpu *c) {
// afterwards (MacNativeGames loader.c:458-462).
static void cb_module_inits(Cpu *c) {
if (plat_cas32(&inits_done, 0, 0)) rt_fatal("boot: module constructors requested twice");
if (rt_config()->plugin_init) plugin_init_run(c, module_named("sdk")); // the plugin service run ends there
// A mod plugin's init runs after sdk's and before the game's (plugin_init.c plugins_start): sdk's DT_INIT then
// comes first, as on the Switch; without a plugin the order stays main, subsdk0, sdk. Called first, sdk's DT_INIT
// only registers sdk with its own musl (__nnmusl_init_dso returns 1: deferred), and main's DT_INIT then finishes
// sdk from musl's list of waiting modules (the log shows sdk's RELRO protected and 44 pages of sdk's data written
// during it on 1.4.3): sdk's flag stays 1 and its DT_INIT is not called again (a second call would protect its
// locked RELRO again, and the SDK aborts).
sdk_first = plugins_start(c, module_named("sdk"));
for (unsigned k = 0; k < sizeof inits_121 / sizeof *inits_121; k++) {
const RtLoaded *m = module_named(expected_inits[k].name);
uint64_t entries = m->init_array_size / 8;
if (!m->init) rt_fatal("boot: %s has no DT_INIT", m->name);
rt_log("boot: ENTER %s DT_INIT (%llu init_array entries)", m->name, (unsigned long long)entries);
rt_call(c, m->init, 0);
int deferred = sdk_first && m == module_named("sdk");
if (!deferred) {
rt_log("boot: ENTER %s DT_INIT (%llu init_array entries)", m->name, (unsigned long long)entries);
rt_call(c, m->init, 0);
}
uint32_t state = ctor_state(m);
rt_logf("boot: DT_INIT %s state=%u (%llu)\n", m->name, state, (unsigned long long)entries);
if (state != CTOR_DONE) rt_fatal("boot: %s DT_INIT left its constructor flag at %u, not 2", m->name, state);
if (state != (deferred ? CTOR_WAITING : CTOR_DONE))
rt_fatal("boot: %s DT_INIT left its constructor flag at %u, not %d", m->name, state,
deferred ? CTOR_WAITING : CTOR_DONE);
if (entries != expected_inits[k].entries)
rt_fatal("boot: %s has %llu init_array entries, this game version has %llu", m->name, (unsigned long long)entries,
(unsigned long long)expected_inits[k].entries);
@@ -101,8 +116,11 @@ static void cb_module_finis(Cpu *c) {
// ---- checkpoints (host.h)
static void stats_line(void) {
RtStats s = rt_stats();
rt_logf("boot: passed (%llu SVCs, %llu threads, %llu host calls)\n", (unsigned long long)s.svcs,
(unsigned long long)s.threads, (unsigned long long)s.host_calls);
if (rt_trace & (RT_TRACE_HOSTCALL | RT_TRACE_HOSTCOUNT)) // counted only then (hostfn.c hostfn_entry)
rt_logf("boot: passed (%llu SVCs, %llu threads, %llu host calls)\n", (unsigned long long)s.svcs,
(unsigned long long)s.threads, (unsigned long long)s.host_calls);
else
rt_logf("boot: passed (%llu SVCs, %llu threads)\n", (unsigned long long)s.svcs, (unsigned long long)s.threads);
}
void rt_boot_event(const char *what, Cpu *c, const char *detail) {
@@ -115,8 +133,9 @@ void rt_boot_event(const char *what, Cpu *c, const char *detail) {
rt_fatal("boot: checkpoint %s reached from %s, expected main+%#llx", detail, at,
(unsigned long long)CHECKPOINT_RET);
if (!plat_cas32(&inits_done, 0, 0)) rt_fatal("boot: checkpoint %s before DT_INIT", detail);
for (int i = 0; i < ldr_count(); i++)
if (ctor_state(ldr_module(i)) != CTOR_DONE)
for (int i = 0; i < ldr_count(); i++) // a plugin's init does not run at play time (plugin_init.c)
if (!ldr_module(i)->plugin && ctor_state(ldr_module(i)) != CTOR_DONE &&
!(sdk_first && !strcmp(ldr_module(i)->name, "sdk") && ctor_state(ldr_module(i)) == CTOR_WAITING))
rt_fatal("boot: checkpoint %s: %s constructor flag reads %u", detail, ldr_module(i)->name,
ctor_state(ldr_module(i)));
plat_xchg32(&checkpoint_seen, 1);
@@ -338,15 +357,34 @@ static void prewarm_main(void *arg) {
return;
}
// --plugin-init DIR: the modules load and nn::init::Start runs as at boot, and its module-init callback runs sdk's
// DT_INIT and each plugin's instead of the game's constructors, writes the record and exits (plugin_init.c). No game
// constructor, nnMain, shader prewarm, graphics or audio runs.
void rt_boot_plugin_init(void) {
check_npdm();
plugin_init_setup();
ldr_load(rt_config()->exefs);
rt_patches_init(); // the generated code reads the patch page
cb_addr[0] = hostfn_register("<rtld loader_ready>", cb_loader_ready);
cb_addr[1] = hostfn_register("<rtld module_inits>", cb_module_inits);
cb_addr[2] = hostfn_register("<rtld module_finis>", cb_module_finis);
hostfn_seal();
rt_guest_start_ns = kern_now_ns();
kern_run_on_guest_main(guest_main);
rt_fatal("boot: the guest main thread ended");
}
void rt_boot(void) {
check_npdm();
if (!rt_config()->shot) vk_pipeline_async_enable(); // a --shot image must not depend on build timing
// Shaders and pipelines recorded in earlier runs are made ready while the modules load; the guest waits for them.
PlatThread *warm = plat_thread_new(prewarm_main, NULL, "prewarm");
plugins_setup(); // a mod plugin's environment (plugin_init.c), before its imports bind
ldr_load(rt_config()->exefs);
rt_patches_init();
mods_exefs_switch(); // after the patch sets' settings: an enabled mod's ExeFS patches on
frame_step_init();
gameplay_tweaks_init();
res_init();
cheats_init(); // after the patch sets: a cheat's set follows its setting
cb_addr[0] = hostfn_register("<rtld loader_ready>", cb_loader_ready);
+171 -59
View File
@@ -14,6 +14,7 @@
#include "cfg.h"
#include "host.h"
#include "input_map.h"
#include "platform/platform.h"
#define PREFIX "TOTK_"
@@ -32,80 +33,98 @@ static int save_ok = 1; // the last cfg_save_to wrote (o
// logged as unknown. A new variable goes here too, or its ini key logs a harmless "unknown key" line, and gets a
// description in totk.ini.example or docs/settings.md (tests/settings_doc_check.py checks both).
static const char *const known[] = {
"AB", "AMIIBO_DIR", "ANISO", "APP_POOL", "ASPECT", "ASPECT_PATCH", "ASSUME_FOCUS", "ASTC", "ASTC_BC", "ASTC_TIME", "ASYNC_PREEMPT", "AUDIO", "AUDIO_CHANNELS", "AUDIO_OFF", "AUDIO_PREFILL_MS",
"AB", "ABILITY_GUARD", "ADDR_REPORT", "AMIIBO_DIR", "ANISO", "APP_POOL", "ASPECT", "ASPECT_PATCH", "ASSUME_FOCUS", "ASTC", "ASTC_BC", "ASTC_TIME", "ASYNC_PREEMPT", "AUDIO", "AUDIO_CHANNELS", "AUDIO_DEVICE", "AUDIO_DRAIN_FIX", "AUDIO_OFF", "AUDIO_PREFILL_MS",
"BACKGROUND_WINDOW", "BIND_A", "BIND_B", "BIND_DOWN", "BIND_L", "BIND_LCLICK", "BIND_LEFT", "BIND_LSTICK_DOWN", "BIND_LSTICK_LEFT",
"BIND_LSTICK_RIGHT", "BIND_LSTICK_UP", "BIND_MINUS",
"BIND_PLUS", "BIND_R", "BIND_RCLICK", "BIND_RIGHT", "BIND_RSTICK_DOWN", "BIND_RSTICK_LEFT", "BIND_RSTICK_RIGHT", "BIND_RSTICK_UP",
"BIND_SHAKE",
"BIND_SKIP", "BIND_STATS", "BIND_UP", "BIND_X", "BIND_Y",
"BIND_ZL", "BIND_ZR", "BLOCK_VIEWS_3D", "CLOTH_REALTIME", "COLOR_BRIGHTNESS", "COLOR_CONTRAST", "COLOR_GAMMA",
"BIND_INC", "BIND_SKIP", "BIND_STATS", "BIND_UP", "BIND_X", "BIND_Y",
"BIND_ZL", "BIND_ZR", "BARRIER_MERGE", "BLOCK_VIEWS_3D", "CLIMB_FIX", "CLOTH_REALTIME", "COLOR_BRIGHTNESS", "COLOR_CONTRAST", "COLOR_GAMMA",
"COLOR_PRESET", "COLOR_SATURATION", "CONTACT_DEBUG", "CONTACT_SHADOWS", "CORE_DIAG", "CRIT", "CRIT_OUT",
"DESC_TEMPLATE", "DESWIZZLE", "DEVICE_PROFILE", "DISCORD_APP_ID", "DISCORD_IMAGE", "DISCORD_RPC", "DLAA", "DLAA_JITTER", "DLAA_MV", "DLAA_MASKDEBUG", "DLAA_MVDEBUG", "DLAA_OBJMV", "DLAA_SURVEY", "DLAA_TIMES", "DLSS", "DLSS_CHAR_MASK", "DLSS_PRESET", "DLSS_REACTIVE", "DUMP", "DUMP_BUF", "DUMP_DIR",
"DUMP_LOG", "DYN_DELTA", "EXEFS", "FEEDBACK", "FIX_C0", "FIX_ZERO", "FLIGHT", "FLIGHT_AT", "FLIGHT_DIR", "FLIGHT_FRAMES",
"FLIGHT_SPIKE_MS", "FLIGHT_THUMBS", "FLUSH_SPAN", "FOV", "FOV_PATCH", "FPS60", "FPS_LIMIT", "FRAME_QUEUE",
"FREEZE_IDLE", "FREE_CORES",
"FULLSCREEN", "FXAA", "GPL", "GPL_DRAW_BUILD", "GPU", "GPU_INDEX", "GPU_NAME", "HDR", "HDR_GAME_NITS", "HDR_HUE",
"HDR_PEAK_NITS", "HDR_UI_NITS", "HIGHFPS_FIX", "INPUT", "INPUT_RECORD", "INPUT_SCRIPT", "LANG", "LIB_PREBUILD",
"LIB_PREBUILD_KEEP", "LIB_PREBUILD_THREADS", "LOCALE", "LOD_GUARD", "LSTICK_DEADZONE", "MEMORY", "MENU_LANG", "MENU_TEST",
"MENU_CURSOR", "MENU_CURSOR_LOG", "MENU_TEST_DIR", "MENU_TEST_SET", "MINIMAL_LAYOUT", "MIRROR_GAP", "MODS_DIR", "MODS_DISABLED", "MODS_ORDER", "MODS_REBUILD", "MOTION", "MOUSE_AIM_SCALE", "MOUSE_MODE", "MOUSE_DIRECT_PATCH", "MOUSE_SENS", "MOVIE_ASPECT", "MOVIE_HOST", "MOVIE_PACE",
"DESC_TEMPLATE", "DESWIZZLE", "DEVICE_PROFILE", "DIALOGUE_CLICK", "DISCORD_APP_ID", "DISCORD_IMAGE", "DISCORD_RPC", "DLAA", "DLAA_CAM_JITTER", "DLAA_EFFECTS_AFTER", "DLAA_JITTER", "DLAA_MV", "DLAA_MASKDEBUG", "DLAA_MVDEBUG", "DLAA_OBJMV", "DLAA_SURVEY", "DLAA_TIMES", "DLSS", "DLSS_CHAR_MASK", "DLSS_FIXED_EXPOSURE", "DLSS_PRESET", "DLSS_REACTIVE", "DUMP", "DUMP_BUF", "DUMP_DIR",
"DUMP_LOG", "DYNAMIC_RES", "DYN_DELTA", "EXEFS", "FEEDBACK", "FG_DEBUG", "FG_OBJECTS", "FG_SHOT", "FG_SHOT_DIR", "FG_TEST", "FG_TIMES", "FIXED_RES_PATCH", "FIX_C0", "FIX_ZERO", "FLIGHT", "FLIGHT_AT", "FLIGHT_DIR", "FLIGHT_FRAMES",
"FLIGHT_SPIKE_MS", "FLIGHT_THUMBS", "FLUSH_SPAN", "FOV", "FOV_PATCH", "FPS60", "FPS_LIMIT", "FRAME_GEN", "FRAME_QUEUE", "FREECAM_KEY", "FREECAM_PAD", "FREECAM_PATCH",
"FREEZE_IDLE", "FREE_CORES", "FSR3_DEBUG", "FSR3_VIEW", "FSR_SHARPNESS",
"FULLSCREEN", "FXAA",
"GAMEPLAY_DISTANCE_SENSITIVITY", "GAMEPLAY_ITEM_AD", "GAMEPLAY_ITEM_SENSITIVITY", "GAMEPLAY_ITEM_WHEEL",
"GAMEPLAY_MAP_ZOOM", "GAMEPLAY_MAP_ZOOM_SENSITIVITY", "GAMEPLAY_ROTATION_SENSITIVITY", "GAMEPLAY_TWEAKS_ENABLED",
"GAMEPLAY_ULTRAHAND_C_AXIS", "GAMEPLAY_ULTRAHAND_DISTANCE", "GAMEPLAY_ULTRAHAND_ROTATE", "GAMEPLAY_WEAPON_SENSITIVITY",
"GAMEPLAY_WEAPON_WHEEL",
"GPL", "GPL_DRAW_BUILD", "GPU", "GPU_INDEX", "GPU_NAME", "GRASS_RANGE",
"GYRO_AUTO_BIAS", "GYRO_BIAS_PAD", "GYRO_BIAS_X", "GYRO_BIAS_Y", "GYRO_BIAS_Z", "GYRO_CALIBRATION", "HDR", "HDR_GAME_NITS", "HDR_HUE",
"HDR_PEAK_NITS", "HDR_UI_NITS", "HIGHFPS_FIX", "HUD_WIDTH", "INPUT", "INPUT_RECORD", "INPUT_SCRIPT", "KSPIN_US", "LANG", "LIB_PREBUILD",
"LIB_PREBUILD_KEEP", "LIB_PREBUILD_THREADS", "LOCALE", "LOD_GUARD", "LOD_STEADY", "LSTICK_DEADZONE", "MAP_CLICK", "MEMORY", "MEMX", "MENU_LANG", "MENU_TEST", "MENU_FONT_FONTCONFIG",
"MEM_RESERVE_MIB", "MENU_CURSOR", "MENU_CURSOR_LOG", "MENU_TEST_DIR", "MENU_TEST_SET", "MINIMAL_LAYOUT", "MIRROR_GAP", "MODS_DIR", "MODS_DISABLED", "MODS_NO_CODE", "MODS_ORDER", "MODS_REBUILD", "MODS_WITHOUT_CODE", "MOTION", "MOUSE_AIM_SCALE", "MOUSE_MODE", "MOUSE_DIRECT_PATCH", "MOUSE_SENS", "MOVIE_ASPECT", "MOVIE_HOST", "MOVIE_PACE",
"MVOBJ_ALL", "MVOBJ_BANKS", "MVOBJ_EQUAL", "MVOBJ_EXACT", "MVOBJ_EXEC", "MVOBJ_NOC4", "MVOBJ_ONLY", "MVOBJ_TIMES", "MVPREV_CHECK", "MVPREV_GROW", "MVPREV_SKIP", "MVPREV_TRUST", "MV_CHECK",
"MV_SURVEY",
"ONE_PER_CORE", "OPERATION_MODE", "OUTPUT_RES", "PAD_LAYOUT", "PASS_CRUMBS", "PATCH_OUTPUT", "PATCH_SCENE", "PCSS", "PCSS_K", "PERF_OVERLAY", "PERF_SLOW_MS", "PIPELINE_CACHE", "PIPE_MEMO", "PIPE_PREBUILD", "PIPE_SKIP", "PIPE_SYNC", "PIPE_WAIT",
"ONE_PER_CORE", "OPERATION_MODE", "OPTREF_GUARD", "OUTPUT_RES", "PAD_LAYOUT", "PASS_CRUMBS", "PATCH_OUTPUT", "PATCH_SCENE", "PCORE", "PCSS", "PCSS_K", "PERF_CENSUS", "PERF_OVERLAY", "PERF_SLOW_MS", "PIPELINE_CACHE", "PIPE_MEMO", "PIPE_PREBUILD", "PIPE_SKIP", "PIPE_SYNC", "PIPE_WAIT", "PLUGIN_TICK_OFFSET", "PLUGIN_TRACE", "POINTER_IMAGE",
"PREWARM_XLATE", "PROBE_MOVIE", "PROBE_MOVIE_BENCH", "PROBE_MOVIE_SHOT", "PROFILE", "PROFILE_CHAINS", "PROFILE_DIR", "PROFILE_FRAMES",
"PROFILE_MAIN", "PROFILE_RENDER", "PROMPTS", "PUSH_SKIP", "PUSH_STAGE", "RDOC", "RDOC_DIR", "RDOC_DLL", "REALTIME", "REC_END", "REEXEC",
"RENDER_SCALE", "REPLAY_ASYNC",
"REPLAY_CHECK", "RESOLVE_CHECK", "RESTART_WAIT", "ROMFS", "ROMFS_INDEX", "ROMFS_MMAP", "ROMFS_MODS", "ROMFS_PATCHES",
"ROMFS_PROOF_DIR", "ROMFS_VERIFY", "RSTICK_DEADZONE", "RUMBLE", "RUMBLE_CURVE", "RUMBLE_STRENGTH", "RUMBLE_TRIGGERS", "SHADER_CACHE",
"SHADER_MEMO", "SHADOW_RANGE", "SHADOW_RES", "SHADOW_SCALE", "SHARED_FONTS", "SHARPNESS", "SHOTS", "SHOTS_DIR",
"PROFILE_MAIN", "PROFILE_RENDER", "PROMPTS", "PUSH_SKIP", "PUSH_STAGE", "QUICKLOAD_KEY", "QUICKSAVE", "QUICKSAVE_KEY", "RDOC", "RDOC_DIR", "RDOC_DLL", "REALTIME", "REC_ASYNC", "REC_END", "REC_SPIN_US", "REEXEC", "REFLEX",
"RENDER_SCALE", "REPLAY_ASYNC", "REPLAY_CHUNKS", "REPLAY_CHUNK_DRAWS", "REPLAY_SKEW_US", "REPLAY_STATE_CHECK", "REPLAY_WORKERS",
"REPLAY_CHECK", "REPORT_GUARD", "RESOLVE_CHECK", "RESTART_WAIT", "ROMFS", "ROMFS_INDEX", "ROMFS_MMAP", "ROMFS_MODS", "ROMFS_PATCHES",
"ROMFS_PROOF_DIR", "ROMFS_VERIFY", "RSTICK_DEADZONE", "RUMBLE", "RUMBLE_CURVE", "RUMBLE_STRENGTH", "RUMBLE_TRIGGERS", "SCENE_UPSCALER", "SHADER_CACHE",
"SHADER_MEMO", "SHADOW", "SHADOW_DEFER", "SHADOW_RANGE", "SHADOW_RES", "SHADOW_SCALE", "SHADOW_SNAP", "SHARED_FONTS", "SHARPNESS", "SHOTS", "SHOTS_DIR", "SHUTTER_FIX",
"SHOTS_FULL", "SPEED_PROBE", "SPIN", "SPIN_HANDOFF_US", "SPLIT_DRAWS", "SPLIT_US", "STICK_DEADZONE", "STICK_SENS",
"SWKBD_ANSWER",
"SWKBD_TEST", "TEST_PAD", "TEST_PREPARE_SHADERS", "TEX_ALIAS", "TEX_HEAP_EXTRA_MB", "TEX_MEMO", "TEX_VRAM_PRESSURE", "TIMER_1MS", "TRACE", "TXD_TRANSPOSE", "UBO_SNAPSHOT", "UB_OVERLAY", "UB_OVERLAY_OUT", "UPSCALER", "VB_USED", "VK_DYN_A2C", "VK_DYN_VERTEX", "VK_NO_FLOAT64",
"VK_PRESENT", "VK_RECORDER", "VK_SSBO_ALIGN", "VK_SUBGROUP", "VK_SUBGROUP_PIN", "VK_VALIDATION", "VOLUME", "VRAM_HEADROOM", "VRAM_LIMIT_MIB", "VS_OUTS",
"WALK_KEY", "WALK_SCALE", "WB_EXACT", "WB_FENCE_LIMIT", "WB_MERGE", "WINDOW_SIZE", "XLATE", "XLATE_ID", "XLATE_KEEP", "XLATE_PROCS",
"SWKBD_ANSWER", "SYNC_AHEAD",
"SWKBD_TEST", "TEST_OOM", "TEST_PAD", "TEST_PAD_RUMBLE_MS", "TEST_PREPARE_SHADERS", "TEX_ALIAS", "TEX_BLOCK_MIB", "TEX_HEAP_EXTRA_MB", "TEX_MEMO", "TEX_RELEASED_MIB", "TEX_VRAM_PRESSURE", "TIMER_1MS", "TRACE", "TXD_TRANSPOSE", "UBO_SNAPSHOT", "UB_OVERLAY", "UB_OVERLAY_OUT", "UPSCALER", "VB_USED", "VK_DYN_A2C", "VK_DYN_VERTEX", "VK_NO_FLOAT64",
"VK_PRESENT", "VK_RECORDER", "VK_SSBO_ALIGN", "VK_SUBGROUP", "VK_SUBGROUP_PIN", "VK_VALIDATION", "VMA_BLOCK_MIB", "VOLUME", "VOLUME_MASK_BIAS", "VOLUME_MUSIC", "VOLUME_SFX", "VOLUME_VOICE", "VRAM_HEADROOM", "VRAM_LIMIT_MIB", "VS_OUTS",
"WALK_KEY", "WALK_SCALE", "WB_EAGER", "WB_EXACT", "WB_FENCE_LIMIT", "WB_MERGE", "WINDOW_SIZE", "XLATE", "XLATE_ID", "XLATE_KEEP", "XLATE_PROCS",
"ZSTD_CHECK", "ZSTD_NATIVE",
};
// The totk.ini section a key cfg_set may write goes to when the file lacks it (totk.ini.example's sections).
static const struct { const char *key, *section; } sections[] = {
{"FPS_LIMIT", "frame rate"}, {"FPS60", "frame rate"}, {"FRAME_QUEUE", "frame rate"},
{"FPS_LIMIT", "frame rate"}, {"FPS60", "frame rate"}, {"FRAME_QUEUE", "frame rate"}, {"FRAME_GEN", "frame rate"},
{"REALTIME", "frame rate"}, {"CLOTH_REALTIME", "frame rate"}, {"HIGHFPS_FIX", "frame rate"},
{"CLIMB_FIX", "frame rate"}, {"AUDIO_DRAIN_FIX", "frame rate"}, {"SHUTTER_FIX", "frame rate"},
{"FULLSCREEN", "display"}, {"WINDOW_SIZE", "display"}, {"PERF_OVERLAY", "display"}, {"VK_PRESENT", "display"},
{"GPU_INDEX", "display"}, {"OUTPUT_RES", "display"}, {"RENDER_SCALE", "display"}, {"UPSCALER", "display"},
{"SHARPNESS", "display"}, {"ASPECT", "display"}, {"MOVIE_ASPECT", "display"}, {"FOV", "display"}, {"ANISO", "display"},
{"COLOR_PRESET", "display"},
{"HUD_WIDTH", "display"},
{"SHARPNESS", "display"}, {"DYNAMIC_RES", "display"}, {"ASPECT", "display"}, {"MOVIE_ASPECT", "display"}, {"FOV", "display"}, {"ANISO", "display"},
{"LOD_STEADY", "display"}, {"COLOR_PRESET", "display"},
{"COLOR_BRIGHTNESS", "display"}, {"COLOR_CONTRAST", "display"}, {"COLOR_SATURATION", "display"},
{"COLOR_GAMMA", "display"}, {"HDR", "display"}, {"HDR_PEAK_NITS", "display"}, {"HDR_GAME_NITS", "display"},
{"HDR_UI_NITS", "display"}, {"HDR_HUE", "display"}, {"SHADOW_RES", "display"},
{"DLAA", "display"}, {"DLSS", "display"}, {"DLSS_PRESET", "display"}, {"DLSS_CHAR_MASK", "display"}, {"FXAA", "display"},
{"SCENE_UPSCALER", "display"}, {"DLAA", "display"}, {"DLSS", "display"}, {"FSR_SHARPNESS", "display"}, {"DLSS_PRESET", "display"}, {"DLSS_CHAR_MASK", "display"}, {"DLSS_FIXED_EXPOSURE", "display"}, {"DLAA_EFFECTS_AFTER", "display"}, {"REFLEX", "display"}, {"FXAA", "display"},
{"DEVICE_PROFILE", "display"}, {"ASSUME_FOCUS", "display"},
{"DISCORD_RPC", "discord"}, {"DISCORD_APP_ID", "discord"}, {"DISCORD_IMAGE", "discord"},
{"SHADOW_SCALE", "display"}, {"SHADOW_RANGE", "display"}, {"CONTACT_SHADOWS", "display"},
{"SHADOW_SCALE", "display"}, {"SHADOW_RANGE", "display"}, {"GRASS_RANGE", "display"}, {"CONTACT_SHADOWS", "display"},
{"PCSS", "display"},
{"MODS_DIR", "mods"}, {"MODS_ORDER", "mods"}, {"MODS_DISABLED", "mods"}, {"MODS_REBUILD", "mods"},
{"MODS_DIR", "mods"}, {"MODS_ORDER", "mods"}, {"MODS_DISABLED", "mods"}, {"MODS_NO_CODE", "mods"}, {"MODS_REBUILD", "mods"}, {"MODS_WITHOUT_CODE", "mods"},
{"TEX_HEAP_EXTRA_MB", "mods"},
{"MENU_LANG", "language"}, {"LANG", "language"}, {"OPERATION_MODE", "language"},
{"VOLUME", "audio"}, {"AUDIO_CHANNELS", "audio"},
{"MOTION", "input"}, {"RUMBLE_STRENGTH", "input"}, {"RUMBLE_CURVE", "input"}, {"RUMBLE_TRIGGERS", "input"},
{"MENU_LANG", "language"}, {"MENU_FONT_FONTCONFIG", "language"}, {"LANG", "language"}, {"OPERATION_MODE", "language"},
{"VOLUME", "audio"}, {"VOLUME_MUSIC", "audio"}, {"VOLUME_SFX", "audio"}, {"VOLUME_VOICE", "audio"}, {"AUDIO_CHANNELS", "audio"},
{"AUDIO_DEVICE", "audio"},
{"MOTION", "input"}, {"GYRO_CALIBRATION", "input"}, {"GYRO_AUTO_BIAS", "input"}, {"RUMBLE_STRENGTH", "input"}, {"RUMBLE_CURVE", "input"}, {"RUMBLE_TRIGGERS", "input"},
{"GYRO_BIAS_X", "input"}, {"GYRO_BIAS_Y", "input"}, {"GYRO_BIAS_Z", "input"}, {"GYRO_BIAS_PAD", "input"},
{"PAD_LAYOUT", "input"}, {"PROMPTS", "input"}, {"STICK_DEADZONE", "input"}, {"LSTICK_DEADZONE", "input"}, {"RSTICK_DEADZONE", "input"},
{"STICK_SENS", "input"},
{"MENU_CURSOR", "input"}, {"MOUSE_MODE", "input"}, {"MOUSE_SENS", "input"}, {"MOUSE_AIM_SCALE", "input"}, {"WALK_KEY", "input"}, {"WALK_SCALE", "input"}, {"INPUT_RECORD", "input"},
{"MENU_CURSOR", "input"}, {"MAP_CLICK", "input"}, {"DIALOGUE_CLICK", "input"}, {"POINTER_IMAGE", "input"}, {"QUICKSAVE", "input"}, {"QUICKSAVE_KEY", "input"}, {"QUICKLOAD_KEY", "input"}, {"MOUSE_MODE", "input"}, {"MOUSE_SENS", "input"}, {"MOUSE_AIM_SCALE", "input"}, {"WALK_KEY", "input"}, {"WALK_SCALE", "input"}, {"FREECAM_PATCH", "input"}, {"FREECAM_PAD", "input"}, {"FREECAM_KEY", "input"}, {"INPUT_RECORD", "input"},
{"BIND_A", "input"}, {"BIND_B", "input"}, {"BIND_X", "input"}, {"BIND_Y", "input"}, {"BIND_LCLICK", "input"},
{"BIND_RCLICK", "input"}, {"BIND_L", "input"}, {"BIND_R", "input"}, {"BIND_ZL", "input"}, {"BIND_ZR", "input"},
{"BIND_PLUS", "input"}, {"BIND_MINUS", "input"}, {"BIND_LEFT", "input"}, {"BIND_UP", "input"},
{"BIND_RIGHT", "input"}, {"BIND_DOWN", "input"}, {"BIND_LSTICK_LEFT", "input"}, {"BIND_LSTICK_UP", "input"},
{"BIND_LSTICK_RIGHT", "input"}, {"BIND_LSTICK_DOWN", "input"}, {"BIND_RSTICK_LEFT", "input"},
{"BIND_RSTICK_UP", "input"}, {"BIND_RSTICK_RIGHT", "input"}, {"BIND_RSTICK_DOWN", "input"}, {"BIND_SHAKE", "input"},
{"ASYNC_PREEMPT", "performance"}, {"REPLAY_ASYNC", "performance"}, {"FREE_CORES", "performance"},
{"ASYNC_PREEMPT", "performance"}, {"REPLAY_ASYNC", "performance"}, {"REPLAY_WORKERS", "performance"}, {"FREE_CORES", "performance"},
{"TIMER_1MS", "performance"}, {"PIPE_WAIT", "performance"}, {"PIPE_SKIP", "performance"},
{"LIB_PREBUILD", "performance"}, {"LIB_PREBUILD_THREADS", "performance"}, {"PIPE_PREBUILD", "performance"},
{"BARRIER_MERGE", "performance"}, {"LIB_PREBUILD", "performance"}, {"LIB_PREBUILD_THREADS", "performance"}, {"PIPE_PREBUILD", "performance"},
{"PREWARM_XLATE", "performance"}, {"GPL", "performance"}, {"ASTC", "performance"}, {"MEMORY", "performance"},
{"TEX_ALIAS", "performance"}, {"TEX_VRAM_PRESSURE", "performance"}, {"ASTC_BC", "performance"}, {"LOD_GUARD", "performance"}, {"FIX_C0", "performance"}, {"FIX_ZERO", "performance"},
{"BIND_SKIP", "performance"}, {"SHADER_MEMO", "performance"}, {"PIPE_MEMO", "performance"}, {"TEX_MEMO", "performance"}, {"VB_USED", "performance"}, {"DESC_TEMPLATE", "performance"},
{"PUSH_SKIP", "performance"}, {"SPLIT_DRAWS", "performance"}, {"SPLIT_US", "performance"}, {"VK_VALIDATION", "performance"},
{"TEX_ALIAS", "performance"}, {"TEX_VRAM_PRESSURE", "performance"}, {"TEX_RELEASED_MIB", "performance"}, {"TEX_BLOCK_MIB", "performance"}, {"VMA_BLOCK_MIB", "performance"}, {"ASTC_BC", "performance"}, {"LOD_GUARD", "performance"}, {"FIX_C0", "performance"}, {"FIX_ZERO", "performance"},
{"BIND_SKIP", "performance"}, {"SHADER_MEMO", "performance"}, {"PIPE_MEMO", "performance"}, {"MEMX", "performance"}, {"BIND_INC", "performance"}, {"TEX_MEMO", "performance"}, {"VB_USED", "performance"}, {"DESC_TEMPLATE", "performance"},
{"SYNC_AHEAD", "performance"}, {"SHADOW_DEFER", "performance"}, {"PUSH_SKIP", "performance"}, {"SPLIT_DRAWS", "performance"}, {"SPLIT_US", "performance"}, {"VK_VALIDATION", "performance"},
{"VK_DYN_VERTEX", "performance"}, {"VK_DYN_A2C", "performance"}, {"VK_SUBGROUP_PIN", "performance"},
{"TRACE", "diagnostics"}, {"FLIGHT", "diagnostics"}, {"PASS_CRUMBS", "diagnostics"}, {"FLIGHT_SPIKE_MS", "diagnostics"},
{"WB_FENCE_LIMIT", "diagnostics"}, {"WB_MERGE", "diagnostics"}, {"WB_EXACT", "diagnostics"},
{"MV_SURVEY", "diagnostics"},
{"OPTREF_GUARD", "performance"}, {"ABILITY_GUARD", "performance"}, {"REPORT_GUARD", "performance"},
{"TRACE", "diagnostics"}, {"FLIGHT", "diagnostics"}, {"PASS_CRUMBS", "diagnostics"}, {"ADDR_REPORT", "diagnostics"}, {"FLIGHT_SPIKE_MS", "diagnostics"},
{"WB_FENCE_LIMIT", "diagnostics"}, {"WB_MERGE", "diagnostics"}, {"WB_EXACT", "diagnostics"}, {"WB_EAGER", "diagnostics"},
{"MV_SURVEY", "diagnostics"}, {"PLUGIN_TRACE", "diagnostics"},
{"GAMEPLAY_TWEAKS_ENABLED", "gameplay tweaks"}, {"GAMEPLAY_ULTRAHAND_ROTATE", "gameplay tweaks"},
{"GAMEPLAY_ULTRAHAND_C_AXIS", "gameplay tweaks"}, {"GAMEPLAY_ULTRAHAND_DISTANCE", "gameplay tweaks"},
{"GAMEPLAY_ITEM_WHEEL", "gameplay tweaks"}, {"GAMEPLAY_ITEM_AD", "gameplay tweaks"},
{"GAMEPLAY_MAP_ZOOM", "gameplay tweaks"}, {"GAMEPLAY_MAP_ZOOM_SENSITIVITY", "gameplay tweaks"},
{"GAMEPLAY_ROTATION_SENSITIVITY", "gameplay tweaks"}, {"GAMEPLAY_DISTANCE_SENSITIVITY", "gameplay tweaks"},
{"GAMEPLAY_ITEM_SENSITIVITY", "gameplay tweaks"},
{"GAMEPLAY_WEAPON_WHEEL", "gameplay tweaks"}, {"GAMEPLAY_WEAPON_SENSITIVITY", "gameplay tweaks"},
};
// The settings the menu shows: the value in effect when the key is unset, and what the key accepts. The only place a
@@ -119,10 +138,15 @@ static const CfgMeta metas[] = {
{"VK_PRESENT", "mailbox", "mailbox|fifo|immediate", LIVE}, {"GPU_INDEX", "", NULL, RESTART},
{"PERF_OVERLAY", "off", "off|fps|full", LIVE},
{"OUTPUT_RES", "1920x1080", NULL, RESTART}, {"RENDER_SCALE", "game", "game|50|67|75|100|125|150|200", RESTART},
{"HUD_WIDTH", "full", "full|21:9|16:9", RESTART},
{"DYNAMIC_RES", "1", "0|1", LIVE}, // resolution.c res_dynres_live
{"UPSCALER", "fsr", "fsr|bilinear", LIVE}, {"SHARPNESS", "80", "0..100", LIVE},
{"DLAA", "0", "0|1", RESTART}, {"DLSS", "dlaa", "dlaa|quality|balanced|performance|ultra_performance", LIVE},
{"DLSS_PRESET", "default", "default|k|j", LIVE},
{"DLSS_CHAR_MASK", "65", "0|35|65|100", LIVE}, {"FXAA", "1", "0|1", LIVE},
{"SCENE_UPSCALER", "off", "off|dlss|fsr3", RESTART}, {"DLAA", "0", "0|1", RESTART},
{"DLSS", "dlaa", "dlaa|quality|balanced|performance|ultra_performance", LIVE},
{"FSR_SHARPNESS", "80", "0..100", LIVE}, // vk_dlaa.c fsr_evaluate
{"DLSS_PRESET", "default", "default|k|j", LIVE}, {"DLSS_FIXED_EXPOSURE", "0", "0|1", LIVE}, {"DLAA_EFFECTS_AFTER", "0", "0|1", LIVE},
{"DLSS_CHAR_MASK", "65", "0|35|65|100", LIVE}, {"REFLEX", "off", "off|on|boost", RESTART}, {"FXAA", "1", "0|1", LIVE},
{"LOD_STEADY", "0", "0|1", RESTART}, // sets steady
{"ASPECT", "fit", "fit|stretch", LIVE}, {"MOVIE_ASPECT", "keep", "keep|stretch", LIVE}, {"FOV", "100", "70..140", LIVE},
{"ANISO", "game", "game|2|4|8|16", RESTART}, // vk_texture.c sampler_features
// colour adjustment (vk_color.c); the preset is the menu's, the four values are what the present uses
@@ -131,31 +155,58 @@ static const CfgMeta metas[] = {
{"COLOR_GAMMA", "1", "0.8..1.2", LIVE},
// HDR output (vk_hdr.c): on at start (the tonemap shader is swapped as shaders load); the nits apply at once
{"HDR", "0", "0|1", RESTART}, {"HDR_PEAK_NITS", "1000", "400..10000", LIVE}, {"HDR_GAME_NITS", "203", "80..500", LIVE},
{"HDR_UI_NITS", "203", "80..500", LIVE}, {"HDR_HUE", "80", "0..100", LIVE},
{"HDR_UI_NITS", "203", "80..500", LIVE}, {"HDR_HUE", "70", "0..100", LIVE},
{"DEVICE_PROFILE", "auto", "auto|desktop|deck", RESTART},
{"SHADOW_RES", "game", "game|256|512|768|1024|1536|2048", RESTART},
{"SHADOW_SCALE", "1", "1..4", RESTART},
{"SHADOW_RANGE", "100", "50..400", RESTART}, {"CONTACT_SHADOWS", "0", "0..100", RESTART},
{"SHADOW_RANGE", "100", "50..400", RESTART}, {"GRASS_RANGE", "100", "50..400", RESTART}, {"CONTACT_SHADOWS", "0", "0..100", RESTART},
{"PCSS", "0", "0..200", RESTART},
// Game
{"FPS_LIMIT", "60", "30|40|45|60|90|120|144|display", LIVE}, {"FPS60", "1", "0|1", LIVE}, {"FRAME_QUEUE", "0", "0|1", LIVE},
{"FRAME_GEN", "off", "off|fsr3", LIVE}, // the generator; vk_fg.cpp vk_fg_engine maps it
{"REALTIME", "1", "0|1", RESTART}, {"CLOTH_REALTIME", "1", "0|1", RESTART},
{"MODS_REBUILD", "auto", "auto|off", RESTART},
{"HIGHFPS_FIX", "1", "0|1", RESTART},
{"MODS_WITHOUT_CODE", "0", "0|1", RESTART}, // 1: a mod is used without the code module it cannot run (mods.c)
{"HIGHFPS_FIX", "1", "0|1", RESTART}, {"CLIMB_FIX", "1", "0|1", RESTART}, {"AUDIO_DRAIN_FIX", "1", "0|1", RESTART},
{"SHUTTER_FIX", "1", "0|1", RESTART},
{"LANG", "", "ja|en-US|fr|de|it|es|zh-CN|ko|nl|pt|ru|zh-TW|en-GB|fr-CA|es-419|zh-Hans|zh-Hant|pt-BR", RESTART},
{"OPERATION_MODE", "docked", "docked|handheld", RESTART},
{"ASSUME_FOCUS", "1", "0|1", LIVE}, // read on every focus change (ov_system.c)
// Sound, Controls, Menu
{"VOLUME", "100", "0..100", LIVE}, {"AUDIO_CHANNELS", "stereo", "auto|stereo|5.1", RESTART},
{"MOTION", "1", "0|1", LIVE}, {"RUMBLE_STRENGTH", "130", "0..300", LIVE}, {"RUMBLE_CURVE", "0.6", "0.2..1.5", LIVE},
{"VOLUME", "100", "0..100", LIVE}, {"VOLUME_MUSIC", "100", "0..100", LIVE}, {"VOLUME_SFX", "100", "0..100", LIVE}, {"VOLUME_VOICE", "100", "0..100", LIVE}, {"AUDIO_CHANNELS", "stereo", "auto|stereo|5.1", RESTART},
{"AUDIO_DEVICE", "", NULL, LIVE}, // audio_mixer.c output_worker: a device name, empty for the system default
{"MOTION", "1", "0|1", LIVE}, {"GYRO_CALIBRATION", "1", "0|1", LIVE}, {"GYRO_AUTO_BIAS", "0", "0|1", LIVE},
{"RUMBLE_STRENGTH", "130", "0..300", LIVE}, {"RUMBLE_CURVE", "0.6", "0.2..1.5", LIVE},
// Written by the Calibrate gyro row (motion_fusion.c save_bias), not by hand; read by input.c pad_bias_select when a
// controller connects and gyro_bias_pad names it.
{"GYRO_BIAS_X", "", NULL, RESTART}, {"GYRO_BIAS_Y", "", NULL, RESTART}, {"GYRO_BIAS_Z", "", NULL, RESTART},
{"GYRO_BIAS_PAD", "", NULL, RESTART},
{"RUMBLE_TRIGGERS", "0", "0|1", LIVE}, {"PAD_LAYOUT", "auto", "auto|nintendo|xbox", LIVE},
{"PROMPTS", "nintendo", "nintendo|xbox|pc", RESTART},
{"PROMPTS", "nintendo", "nintendo|xbox|playstation|pc", RESTART},
{"STICK_DEADZONE", "8", "0..50", LIVE}, {"STICK_SENS", "1", "0.1..3", RESTART},
{"LSTICK_DEADZONE", "", "0..50", LIVE}, {"RSTICK_DEADZONE", "", "0..50", LIVE},
{"MOUSE_MODE", "direct", "stick|direct", LIVE},
{"MOUSE_SENS", "1", "0..10", LIVE}, {"MOUSE_AIM_SCALE", "1", "0.1..3", LIVE}, {"MENU_CURSOR", "1", "0|1", LIVE},
{"MAP_CLICK", "0", "0|1", LIVE}, // input.c: the left mouse button is A on the Purah Pad's map
{"DIALOGUE_CLICK", "0", "0|1", LIVE}, // menu_cursor.c: in a dialogue box left click is B, right click A
{"POINTER_IMAGE", "0", "0|1", LIVE}, // input_win.c / input_sdl.c: the game window's own pointer (cursor_art.c)
{"QUICKSAVE", "0", "0|1", LIVE}, // quicksave.c: one key saves (an autosave), another loads it
{"QUICKSAVE_KEY", "f6", NULL, LIVE}, {"QUICKLOAD_KEY", "f7", NULL, LIVE}, // Half-Life's keys; a key name or none
{"WALK_KEY", "none", NULL, LIVE}, {"WALK_SCALE", "0.51", "0.2..0.9", LIVE},
// freecam.c: the patch set of its hook (off: the game's camera code as shipped), then the combo and key that step it
{"FREECAM_PATCH", "0", "0|1", RESTART}, {"FREECAM_PAD", "none", NULL, LIVE}, {"FREECAM_KEY", "none", NULL, LIVE},
// Gameplay Tweaks
{"GAMEPLAY_TWEAKS_ENABLED", "0", "0|1", LIVE},
{"GAMEPLAY_ULTRAHAND_ROTATE", "1", "0|1", LIVE}, {"GAMEPLAY_ULTRAHAND_C_AXIS", "1", "0|1", LIVE},
{"GAMEPLAY_ULTRAHAND_DISTANCE", "1", "0|1", LIVE}, {"GAMEPLAY_ITEM_WHEEL", "1", "0|1", LIVE},
{"GAMEPLAY_ITEM_AD", "1", "0|1", LIVE}, {"GAMEPLAY_MAP_ZOOM", "1", "0|1", LIVE},
{"GAMEPLAY_MAP_ZOOM_SENSITIVITY", "1", "0.25..4", LIVE}, {"GAMEPLAY_ROTATION_SENSITIVITY", "1", "0.25..4", LIVE},
{"GAMEPLAY_DISTANCE_SENSITIVITY", "1", "0.25..4", LIVE}, {"GAMEPLAY_ITEM_SENSITIVITY", "1", "0.25..4", LIVE},
{"GAMEPLAY_WEAPON_WHEEL", "1", "0|1", LIVE}, {"GAMEPLAY_WEAPON_SENSITIVITY", "1", "0.25..4", LIVE},
{"MENU_LANG", "", "en|ru|pt-BR|zh-Hans", LIVE},
// plat_font_path on Linux: 1 asks fontconfig which file draws the language, 0 keeps the fixed distribution
// paths. A rebuild of the atlas reads it, so a change shows on the next window size or language switch.
{"MENU_FONT_FONTCONFIG", "1", "0|1", LIVE},
{"AMIIBO_DIR", "", NULL, LIVE},
// Discord Rich Presence (discord_rpc.c): off by default, the Menu tab of the settings menu switches it.
{"DISCORD_RPC", "0", "0|1", LIVE},
@@ -163,17 +214,24 @@ static const CfgMeta metas[] = {
{"DISCORD_IMAGE", "totk_512x512", NULL, LIVE},
// Advanced: scheduling
{"ASYNC_PREEMPT", "1", "0|1|2", RESTART}, {"REPLAY_ASYNC", "0", "0|1", RESTART},
{"REPLAY_WORKERS", "0", "0..16", RESTART}, {"REPLAY_CHUNKS", "0", "0..64", RESTART},
{"REPLAY_CHUNK_DRAWS", "128", "1..100000", RESTART}, {"REPLAY_STATE_CHECK", "0", "0|1", RESTART},
{"REPLAY_SKEW_US", "0", "0..100000", RESTART},
{"SYNC_AHEAD", "0", "0|1|check", RESTART}, {"SHADOW_DEFER", "1", "0|1", RESTART},
{"FREE_CORES", "0", "0|1", RESTART}, {"TIMER_1MS", "1", "0|1", RESTART},
// shaders and pipelines
{"PIPE_WAIT", "default", "default|draw", RESTART}, {"PIPE_SKIP", "fullscreen", "strict|any|fullscreen", RESTART},
{"LIB_PREBUILD", "1", "0|1", RESTART}, {"LIB_PREBUILD_THREADS", "", "1..64", RESTART},
{"BARRIER_MERGE", "0", "0|1", RESTART}, {"LIB_PREBUILD", "1", "0|1", RESTART}, {"LIB_PREBUILD_THREADS", "", "1..64", RESTART},
{"PIPE_PREBUILD", "1", "0|1", RESTART}, {"PREWARM_XLATE", "", "1..64", RESTART}, {"GPL", "1", "0|1", RESTART},
// textures and memory
{"ASTC", "auto", "auto|gpu|native|cpu", RESTART}, {"MEMORY", "auto", "auto|import|mirror|verify", RESTART},
{"TEX_ALIAS", "1", "0|1", RESTART}, {"TEX_VRAM_PRESSURE", "90", "0..100", RESTART}, {"ASTC_BC", "", "0|1", RESTART}, {"ZSTD_NATIVE", "1", "0|1", RESTART}, {"ZSTD_CHECK", "0", "0|1", RESTART},
{"TEX_ALIAS", "1", "0|1", RESTART}, {"TEX_VRAM_PRESSURE", "90", "0..100", RESTART},
{"TEX_RELEASED_MIB", "256", "0..65536", RESTART}, {"TEX_BLOCK_MIB", "64", "0..1024", RESTART}, {"VMA_BLOCK_MIB", "64", "0..1024", RESTART}, {"ASTC_BC", "", "0|1", RESTART}, {"ZSTD_NATIVE", "1", "0|1", RESTART}, {"ZSTD_CHECK", "0", "0|1", RESTART},
// crash guards: code patch sets (recomp/patches-v*.txt) over game reads that crash on stale data
{"OPTREF_GUARD", "1", "0|1", RESTART}, {"ABILITY_GUARD", "1", "0|1", RESTART}, {"REPORT_GUARD", "1", "0|1", RESTART},
// render fixes
{"LOD_GUARD", "1", "0|1", RESTART}, {"FIX_C0", "1", "0|1", RESTART}, {"FIX_ZERO", "1", "0|1", RESTART},
{"BIND_SKIP", "1", "0|1", RESTART}, {"SHADER_MEMO", "1", "0|1", RESTART}, {"PIPE_MEMO", "1", "0|1", RESTART}, {"TEX_MEMO", "1", "0|1", RESTART},
{"BIND_SKIP", "1", "0|1", RESTART}, {"SHADER_MEMO", "1", "0|1", RESTART}, {"PIPE_MEMO", "1", "0|1", RESTART}, {"MEMX", "1", "0|1|check", RESTART}, {"BIND_INC", "0", "0|1|check", RESTART}, {"TEX_MEMO", "1", "0|1", RESTART},
{"VB_USED", "1", "0|1", RESTART},
{"DESC_TEMPLATE", "1", "0|1", RESTART},
{"PUSH_SKIP", "1", "0|1", RESTART}, {"SPLIT_DRAWS", "64", "0..1000", RESTART},
@@ -184,7 +242,10 @@ static const CfgMeta metas[] = {
// diagnostics
{"TRACE", "", NULL, RESTART}, {"FLIGHT", "0", "0|1", RESTART}, {"FLIGHT_SPIKE_MS", "100", "0..60000", RESTART},
{"WB_FENCE_LIMIT", "65536", "0..1073741824", RESTART}, {"WB_MERGE", "1", "0|1", RESTART}, {"WB_EXACT", "1", "0|1", RESTART},
{"WB_EAGER", "1", "0|1|check", RESTART}, // vk_texture.c: part of sync_ahead; 0 and check for comparing
{"PASS_CRUMBS", "", "0|1", RESTART}, // vk_crumbs.c pass marks; unset: VK_AMD_buffer_marker only
{"ADDR_REPORT", "0", "0|1", RESTART}, // vk_device.c GPU address map for device faults
{"PLUGIN_TRACE", "0", "0|1", RESTART}, // plugin_init.c: the first call of each mod plugin hook entry
{"INPUT_RECORD", "", NULL, RESTART},
};
@@ -337,19 +398,52 @@ static const char *raw_get(const char *name) {
// picture between black bars. The sizes are the ones the installer lays the HUD out for (installer/steps.py
// ASPECT_SIZES, ui/menu.cpp row_output_res): of the display's shape within 1%, the smallest at least 1080 high that fits
// the display, else the largest that fits. A 16:9 display, an unknown one or one of another shape keeps 1920x1080.
// Xbox or keyboard prompts keep 1920x1080 too: the setup builds their folders for 16:9 only (romfs.c overlay_init), so
// a default of another shape would trade the prompts the player chose for the Switch ones.
// Xbox, PlayStation and keyboard prompts need their folder for that size's shape too (romfs-patches-<style>-<w>x<h>,
// written by installer/steps.py Shapes for the style totk.ini selects and the connected displays' shapes): they
// keep 1920x1080 when it is missing, as in a source build without make_romfs_patches.py --prompts <style> --aspect or
// after a switch of prompts in the menu, where a default of another shape would trade the prompts the player chose for
// the Switch ones.
static const unsigned SHAPED[][2] = {
{2560, 1080}, {3440, 1440}, {3840, 1600}, {5120, 2160}, // 21:9
{3840, 1080}, {5120, 1440}, // 32:9
{1280, 800}, {1680, 1050}, {1920, 1200}, {2560, 1600}, // 16:10
{1920, 1280}, {2160, 1440}, {2256, 1504}, {2880, 1920}, {3000, 2000}, // 3:2
};
static char screen_res[16]; // set once by cfg_init, "" for none
static int switch_prompts(void) {
const char *p = raw_get(PREFIX "PROMPTS"), *l = raw_get(PREFIX "PAD_LAYOUT");
return (!p || !strcasecmp(p, "nintendo")) && !(l && !strcasecmp(l, "xbox_prompts"));
// The folder size of w x h's shape: of SHAPED within 1% of its aspect ratio, the closest, the first of equal ones
// (5120x2160 takes 2560x1080). The UI layout depends on the aspect ratio alone (tools/ultrawide_layout.py apply), so
// the setup writes one romfs-patches-<w>x<h> per shape, named after this size (installer/screens.py shape_size, the
// same rule), and romfs.c overlay_init looks for it. 0 for 16:9 and for a shape without a layout.
int cfg_shape_size(unsigned w, unsigned h, unsigned out[2]) {
if (!w || !h) return 0;
double r = (double)w / h, err = 0;
if (fabs(r / (16.0 / 9.0) - 1) <= 0.01) return 0;
int best = -1;
for (int i = 0; i < (int)(sizeof SHAPED / sizeof *SHAPED); i++) {
double e = fabs((double)SHAPED[i][0] / SHAPED[i][1] / r - 1);
if (e <= 0.01 && (best < 0 || e < err)) best = i, err = e;
}
if (best < 0) return 0;
out[0] = SHAPED[best][0], out[1] = SHAPED[best][1];
return 1;
}
static char screen_res[16]; // set once by cfg_init, "" for none
// Which pad and keyboard prompts' folders have a manifest at screen_res's shape (<folder>-<screen_res>; set once by
// cfg_init): the folders input_map.c input_prompts_folder names
static const char *const screen_folders[5] = {"romfs-patches-xbox", "romfs-patches-xbox-label",
"romfs-patches-playstation", "romfs-patches-playstation-xbox",
"romfs-patches-pc"};
static int screen_prompts[5];
// Whether the prompts in effect have their folder at screen_res: the folder input_map.c input_prompts_pick and
// input_prompts_folder pick at start. The game's own prompts need none.
static int shape_keeps_prompts(void) {
const char *layout = raw_get(PREFIX "PAD_LAYOUT");
const char *want = input_prompts_folder(input_prompts_pick(raw_get(PREFIX "PROMPTS"), layout), layout);
for (int i = 0; want && i < 5; i++)
if (!strcmp(screen_folders[i], want)) return screen_prompts[i];
return 1;
}
static void screen_default(void) {
@@ -367,16 +461,26 @@ static void screen_default(void) {
if (best < 0) best = fit;
if (best < 0) return;
snprintf(screen_res, sizeof screen_res, "%ux%u", SHAPED[best][0], SHAPED[best][1]);
if (!raw_get(PREFIX "OUTPUT_RES") && switch_prompts())
for (int i = 0; i < 5; i++)
screen_prompts[i] = romfs_shaped_prompts_ready(screen_folders[i], SHAPED[best][0], SHAPED[best][1]);
if (!raw_get(PREFIX "OUTPUT_RES") && shape_keeps_prompts())
rt_log("cfg: the display is %dx%d: output_res defaults to %s, its shape (totk.ini output_res sets another)", sw,
sh, screen_res);
}
int cfg_screen_size(unsigned out[2]) {
unsigned w = 0, h = 0;
if (raw_get(PREFIX "OUTPUT_RES") || !screen_res[0] || sscanf(screen_res, "%ux%u", &w, &h) != 2) return 0;
out[0] = w, out[1] = h;
return 1;
}
const char *cfg_get(const char *name) {
const char *v = raw_get(name);
if (v || strncmp(name, PREFIX, PREFIX_LEN)) return v;
if (!profile_of())
return screen_res[0] && !strcasecmp(name + PREFIX_LEN, "OUTPUT_RES") && switch_prompts() ? screen_res : NULL;
return screen_res[0] && !strcasecmp(name + PREFIX_LEN, "OUTPUT_RES") && shape_keeps_prompts() ? screen_res
: NULL;
for (size_t i = 0; i < sizeof DECK / sizeof *DECK; i++)
if (!strcasecmp(DECK[i].key, name + PREFIX_LEN)) return DECK[i].value;
return NULL;
@@ -756,3 +860,11 @@ void cfg_init(void) {
rt_log("cfg: device profile Steam Deck: defaults for the keys totk.ini does not set (TOTK_DEVICE_PROFILE=desktop "
"turns it off)");
}
// scene_upscaler, or for a totk.ini that predates it the dlaa switch it replaced: dlaa = 1 is DLSS, anything else off.
// FSR 3.1 is never the answer for a player who did not pick it. An unknown value is off.
const char *cfg_scene_upscaler(void) {
if (!cfg_is_set("TOTK_SCENE_UPSCALER")) return cfg_bool("TOTK_DLAA") ? "dlss" : "off";
const char *v = cfg_value("TOTK_SCENE_UPSCALER");
return !strcmp(v, "dlss") ? "dlss" : !strcmp(v, "fsr3") ? "fsr3" : "off";
}
+21
View File
@@ -23,6 +23,15 @@ unsigned cfg_version(void);
int cfg_from_env(const char *name);
// 1 when the player set name (the environment or totk.ini), 0 when cfg_get gives a device profile's default or NULL.
int cfg_is_set(const char *name);
// The folder size of w x h's shape (cfg.c SHAPED: the closest aspect ratio within 1%, the first of equal ones), the
// one romfs-patches-<w>x<h> the setup writes for it. 0 for 16:9 and for a shape without a UI layout.
int cfg_shape_size(unsigned w, unsigned h, unsigned out[2]);
// The size output_res defaults to on this display (its shape, cfg.c screen_default) while the player set no
// output_res, also when the default stays 1920x1080 because that shape lacks the prompts' folder. The generator the game
// starts for missing folders (romfs.c romfs_folders_prepare) makes them for this size, so after a prompts change the
// next start takes the display's shape again. 0 when the player set output_res, a device profile is in use or the
// display is 16:9.
int cfg_screen_size(unsigned out[2]);
// The device profile in use, "deck" or "desktop" (TOTK_DEVICE_PROFILE, else what the machine is).
const char *cfg_device_profile(void);
// Writes the keys cfg_set changed since the last save into totk.ini next to totk.exe (cfg_save_to: the file at path).
@@ -60,3 +69,15 @@ const char *cfg_value(const char *name);
int cfg_int(const char *name);
double cfg_double(const char *name);
int cfg_bool(const char *name);
// The 3D scene upscaler the settings name now: "off", "dlss" or "fsr3" (scene_upscaler; without it dlaa = 1 is "dlss").
// The engine in use is the one named at start (vk_dlaa.c vk_upscaler_engine).
const char *cfg_scene_upscaler(void);
// vk_dlaa.c, the 3D scene upscaler (scene_upscaler): the engine picked at start (UPSCALER_*),
// 1 while the settings still name it (the menu switches it off at once), the engine that is running (it
// ran and has not failed; 0 none), and why an engine cannot run here (UPSCALER_MISSING_*, 0 it can).
enum { UPSCALER_OFF, UPSCALER_DLSS, UPSCALER_FSR3 };
enum { UPSCALER_MISSING_GPU = 1, UPSCALER_MISSING_DLL };
int vk_upscaler_engine(void);
int vk_upscaler_on(void);
int vk_upscaler_running(void);
int vk_upscaler_missing(int engine);
+119 -2
View File
@@ -6,6 +6,7 @@
#include <string.h>
#include "cfg.h"
#include "fs.h"
#include "host.h"
#include "input.h"
#include "input_map.h"
@@ -135,6 +136,9 @@ int probe_cfg(void) {
CHECK(m && EQ(m->def, "1") && m->live, "meta: fps60 defaults to 1 and is live");
m = cfg_meta("ASYNC_PREEMPT");
CHECK(m && EQ(m->values, "0|1|2") && !m->live, "meta: async_preempt takes 0|1|2 and needs a restart");
m = cfg_meta("HUD_WIDTH");
CHECK(m && EQ(m->def, "full") && EQ(m->values, "full|21:9|16:9") && !m->live,
"meta: HUD width defaults to full and changes after restart");
m = cfg_meta("totk_vk_present");
CHECK(m && EQ(m->key, "VK_PRESENT") && EQ(m->values, "mailbox|fifo|immediate") && m->live,
"meta: prefix and case are accepted");
@@ -330,14 +334,115 @@ int probe_cfg(void) {
EQ(input_prompts_folder(PROMPTS_XBOX, "auto"), "romfs-patches-xbox-label") &&
EQ(input_prompts_folder(PROMPTS_XBOX, NULL), "romfs-patches-xbox-label"),
"prompts: the face buttons by position for the Nintendo layout, by label for xbox and auto");
CHECK(input_prompts_pick("PlayStation", "nintendo") == PROMPTS_PLAYSTATION &&
input_prompts_pick("playstation", "xbox") == PROMPTS_PLAYSTATION &&
input_prompts_pick("ps", "auto") == PROMPTS_PLAYSTATION,
"prompts: PlayStation, any case");
CHECK(EQ(input_prompts_folder(PROMPTS_PLAYSTATION, "nintendo"), "romfs-patches-playstation") &&
EQ(input_prompts_folder(PROMPTS_PLAYSTATION, "xbox_prompts"), "romfs-patches-playstation") &&
EQ(input_prompts_folder(PROMPTS_PLAYSTATION, "xbox"), "romfs-patches-playstation-xbox") &&
EQ(input_prompts_folder(PROMPTS_PLAYSTATION, "auto"), "romfs-patches-playstation-xbox") &&
EQ(input_prompts_folder(PROMPTS_PLAYSTATION, NULL), "romfs-patches-playstation-xbox"),
"prompts: the PlayStation shapes by position for the Nintendo layout, by label for xbox and auto");
// romfs-patches-xbox shows A as B (tests/romfs_prompts_test.py checks the folders' contents). It is right exactly
// where the layout puts A on the east button, which an Xbox pad labels B.
// where the layout puts A on the east button, which an Xbox pad labels B. The PlayStation folder shows A as the
// circle there, so its name follows the same split.
input_map_reset();
static const char *const layouts[] = {"nintendo", "xbox", "auto", "xbox_prompts"};
for (int i = 0; i < 4; i++) {
int a_east = input_map_pad_buttons((uint8_t[PAD_COUNT]){[PAD_EAST] = 1}, input_pad_layout_pick(layouts[i], 0)) == 1ull << B_A;
CHECK(a_east == EQ(input_prompts_folder(PROMPTS_XBOX, layouts[i]), "romfs-patches-xbox"),
"prompts: the folder names A as B exactly when the layout puts A on the button labelled B");
CHECK(a_east == EQ(input_prompts_folder(PROMPTS_PLAYSTATION, layouts[i]), "romfs-patches-playstation"),
"prompts: the PlayStation folder puts A on the circle exactly when the layout puts A on the east button");
}
// One folder per screen shape (cfg.c cfg_shape_size, installer/screens.py shape_size): the closest aspect ratio of
// SHAPED within 1%, the first of equal ones; 16:9 and unlisted shapes have none.
unsigned sz[2] = {0, 0};
CHECK(cfg_shape_size(5120, 2160, sz) && sz[0] == 2560 && sz[1] == 1080, "shape: 5120x2160 takes 2560x1080's folder");
CHECK(cfg_shape_size(3440, 1440, sz) && sz[0] == 3440 && sz[1] == 1440, "shape: 3440x1440 keeps its own (0.8% off 2560x1080)");
CHECK(cfg_shape_size(1920, 800, sz) && sz[0] == 3840 && sz[1] == 1600, "shape: 1920x800 takes 3840x1600's folder");
CHECK(cfg_shape_size(2560, 1600, sz) && sz[0] == 1280 && sz[1] == 800 && cfg_shape_size(3000, 2000, sz) &&
sz[0] == 1920 && sz[1] == 1280 && cfg_shape_size(5120, 1440, sz) && sz[0] == 3840 && sz[1] == 1080,
"shape: 16:10, 3:2 and 32:9 take their first size");
CHECK(!cfg_shape_size(1920, 1080, sz) && !cfg_shape_size(2560, 1440, sz) && !cfg_shape_size(1024, 768, sz),
"shape: none for 16:9 and 4:3");
// romfs.c shaped_name: the exact size's folder (an older setup wrote every size) wins, else the shape's
{
char dir[1100], f[1200];
snprintf(dir, sizeof dir, "%.*scfg-probe-shapes", (int)(cut + 1 - path), path);
static const char *const made[] = {"romfs-patches-2560x1080", "romfs-patches-xbox-5120x2160"};
for (int i = 0; i < 2; i++) {
snprintf(f, sizeof f, "%s/%s", dir, made[i]);
plat_file_mkdir_p(f);
snprintf(f, sizeof f, "%s/%s/manifest.tsv", dir, made[i]);
plat_file_write(f, "#\n", 2);
}
snprintf(f, sizeof f, "%s/romfs-index.bin", dir);
plat_setenv("TOTK_ROMFS_INDEX", f);
plat_setenv("TOTK_HUD_WIDTH", NULL);
static const char *const capped[] = {"romfs-patches-2560x1080-hud16x9",
"romfs-patches-xbox-2560x1080-hud16x9",
"romfs-patches-3840x1080-hud21x9"};
for (size_t i = 0; i < sizeof capped / sizeof *capped; i++) {
snprintf(f, sizeof f, "%s/%s/manifest.tsv", dir, capped[i]);
plat_file_delete(f);
}
cfg_set("TOTK_HUD_WIDTH", "full");
CHECK(romfs_shaped_ready(2560, 1080) && romfs_shaped_ready(5120, 2160) && !romfs_shaped_ready(3440, 1440),
"shape: 5120x2160 finds 2560x1080's layout folder, 3440x1440 does not");
CHECK(romfs_shaped_prompts_ready("romfs-patches-xbox", 5120, 2160) &&
!romfs_shaped_prompts_ready("romfs-patches-xbox", 2560, 1080) &&
!romfs_shaped_prompts_ready("romfs-patches-pc", 5120, 2160),
"shape: an older install's exact-size prompts folder serves that size only");
cfg_set("TOTK_HUD_WIDTH", "16:9");
CHECK(romfs_shaped_ready(5120, 2160) && romfs_folders_missing(5120, 2160, NULL) == ROMFS_NEED_LAYOUT,
"HUD: a full layout allows wide output but does not hide a missing selected cap");
for (size_t i = 0; i < sizeof capped / sizeof *capped; i++) {
snprintf(f, sizeof f, "%s/%s", dir, capped[i]);
plat_file_mkdir_p(f);
snprintf(f, sizeof f, "%s/%s/manifest.tsv", dir, capped[i]);
plat_file_write(f, "#\n", 2);
}
CHECK(romfs_folders_missing(5120, 2160, "romfs-patches-xbox") == ROMFS_NEED_PROMPTS &&
romfs_folders_missing(5120, 2160, "romfs-patches-pc") ==
(ROMFS_NEED_PROMPTS | ROMFS_NEED_SHAPED_PROMPTS),
"HUD: canonical capped layouts serve aliases, including Xbox; missing PC prompts still need preparation");
cfg_set("TOTK_HUD_WIDTH", "21:9");
CHECK(romfs_folders_missing(5120, 2160, NULL) && !romfs_folders_missing(5120, 1440, NULL),
"HUD: a different cap needs a different folder; 5120x1440 uses the 3840x1080 shape");
cfg_set("TOTK_HUD_WIDTH", "full");
CHECK(!romfs_shaped_ready(5120, 1440), "HUD: switching to full does not reuse a capped-only layout");
cfg_set("TOTK_HUD_WIDTH", "21:9");
CHECK(!romfs_folders_missing(1920, 1080, NULL), "HUD: 16:9 output ignores a wider cap");
// The 16:9 prompts' folder is needed at every shape (an older setup or a failed step left it out); at 16:9
// nothing shaped is
CHECK(romfs_folders_missing(1920, 1080, "romfs-patches-playstation") == ROMFS_NEED_PROMPTS &&
romfs_folders_missing(2560, 1440, "romfs-patches-playstation") == ROMFS_NEED_PROMPTS,
"folders: missing 16:9 prompts are asked for at 16:9, without a shaped folder");
snprintf(f, sizeof f, "%s/romfs-patches-playstation", dir);
plat_file_mkdir_p(f);
snprintf(f, sizeof f, "%s/romfs-patches-playstation/manifest.tsv", dir);
plat_file_write(f, "#\n", 2);
CHECK(!romfs_folders_missing(1920, 1080, "romfs-patches-playstation") &&
(romfs_folders_missing(5120, 2160, "romfs-patches-playstation") &
(ROMFS_NEED_PROMPTS | ROMFS_NEED_SHAPED_PROMPTS)) == ROMFS_NEED_SHAPED_PROMPTS,
"folders: present 16:9 prompts leave only the shaped folder to make");
plat_file_delete(f);
plat_setenv("TOTK_ROMFS_PATCHES", "0");
CHECK(!romfs_folders_missing(5120, 2160, NULL) && !romfs_folders_missing(1920, 1080, "romfs-patches-pc"),
"HUD: explicit overlay overrides do not request generated layouts or prompts");
plat_setenv("TOTK_ROMFS_PATCHES", NULL);
// Without build-cache/rebuild.txt (a source build) nothing starts: the menu's notes keep "run the setup
// again" and the start spawns nothing (romfs.c overlay_init)
CHECK(!romfs_folders_can_prepare() && !romfs_folders_prepare(5120, 2160, "romfs-patches-pc"),
"folders: no setup's tools, no generator");
cfg_set("TOTK_HUD_WIDTH", "full");
for (size_t i = 0; i < sizeof capped / sizeof *capped; i++) {
snprintf(f, sizeof f, "%s/%s/manifest.tsv", dir, capped[i]);
plat_file_delete(f);
}
plat_setenv("TOTK_ROMFS_INDEX", NULL);
}
uint8_t pd[PAD_COUNT] = {0};
pd[PAD_SOUTH] = pd[PAD_NORTH] = 1;
@@ -360,6 +465,14 @@ int probe_cfg(void) {
input_map_pad_buttons((uint8_t[PAD_COUNT]){[PAD_ZL] = 1}, PAD_LAYOUT_NINTENDO) == 1ull << B_ZL,
"bind: pad:rpaddle1 adds a back paddle, pad:default keeps the trigger");
input_map_reset();
CHECK(input_map_pad_buttons((uint8_t[PAD_COUNT]){[PAD_TOUCHPAD] = 1}, PAD_LAYOUT_NINTENDO) == 0 &&
input_map_pad_buttons((uint8_t[PAD_COUNT]){[PAD_TOUCHPAD] = 1}, PAD_LAYOUT_XBOX) == 0,
"pad layout: the touchpad click is unbound by default");
CHECK(input_map_bind("MINUS", "pad:default, pad:touchpad") &&
input_map_pad_buttons((uint8_t[PAD_COUNT]){[PAD_TOUCHPAD] = 1}, PAD_LAYOUT_XBOX) == 1ull << B_MINUS &&
input_map_pad_buttons((uint8_t[PAD_COUNT]){[PAD_BACK] = 1}, PAD_LAYOUT_XBOX) == 1ull << B_MINUS,
"bind: pad:touchpad adds the touchpad click, pad:default keeps the button");
input_map_reset();
// Bind lines for stick directions and default parts; the remapping rows' edits (input_map.c)
memset(dn, 0, sizeof dn);
dn[KEY_I] = 1;
@@ -456,7 +569,11 @@ int probe_cfg(void) {
char name[96];
snprintf(name, sizeof name, "TOTK_%s", m->key);
plat_setenv(name, "");
CHECK(EQ(cfg_value(name), m->def), "cfg_value returns the table default");
// cfg_get may supply a display or device-profile default (notably OUTPUT_RES on an ultrawide monitor).
// The metadata default is used only when those leave the setting unset.
const char *effective = cfg_get(name);
CHECK(EQ(cfg_value(name), effective && *effective ? effective : m->def),
"cfg_value uses the effective default, falling back to the metadata table");
int ok = 0;
if (!m->values) ok = 1;
else if (strstr(m->values, "..")) {
+103 -17
View File
@@ -10,8 +10,9 @@
// (tools/cheats.py has the format). A cheat whose status line is missing or has another content hash was added or
// edited after the build: a data cheat runs anyway, a code cheat waits for the setup to run again.
//
// Data cheats run in a VM after Atmosphere's dmnt cheat VM (opcodes 0-A; the 0xC.. and 0xF.. extensions are not
// supported), every presented frame while their switch is on, with registers cleared before each cheat. Memory is the
// Data cheats run in a VM after Atmosphere's dmnt cheat VM (opcodes 0-A and C0-C3; C4 and the 0xF.. extensions are not
// supported), every presented frame while their switch is on, with registers and saved registers cleared before each
// cheat; the static registers (C3) stay, shared by all cheats, as dmnt keeps them. Memory is the
// guest's, mapped at its own addresses: main's image is written with its pages made writable for the write (read-only
// data included, as dmnt writes through the debugger), everything else after mem_query says the guest may read or write
// it. Buttons are input_poll's HidNpadButton bits, the same as the cheat format's key masks; they read 0 while the menu
@@ -53,6 +54,7 @@ static int g_n, g_cap, g_vm; // g_vm: some cheat needs cheats_frame
static char g_file[64]; // "<build id>.txt"
static char g_dir[PLAT_PATH_MAX]; // the folder of totk.exe, with a trailing separator
static int g_files; // mods whose file was read
static uint64_t g_static[256]; // C3's static registers: 0x00-0x7F loaded by cheats, 0x80-0xFF stored by them
static uint64_t g_main, g_main_size, g_code_end; // main's image; its code with the padding up to .rodata
static uint32_t fnv(const char *s, size_t n) {
@@ -96,6 +98,11 @@ static int op_len(const uint32_t *w, int left) {
case 5: case 7: n = 2; break;
case 9: n = 1 + (((f >> 8) & 0xF) ? (width == 8 ? 2 : 1) : 0); break;
case 0xA: n = ((f >> 8) & 0xF) == 2 || ((f >> 8) & 0xF) == 4 || ((f >> 8) & 0xF) == 5 ? 2 : 1; break;
case 0xC: // C0TcSX..: an address word for operand types 0 and 2, the value (two words at width 8) for 4
if (((f >> 24) & 0xF) != 0) n = 1;
else if (((f >> 8) & 0xF) == 0 || ((f >> 8) & 0xF) == 2) n = 2;
else n = ((f >> 8) & 0xF) == 4 ? (((f >> 20) & 0xF) == 8 ? 3 : 2) : 1;
break;
default: n = 1; break;
}
return n <= left ? n : 0;
@@ -105,12 +112,15 @@ static int op_len(const uint32_t *w, int left) {
static const char *vm_unsupported(const uint32_t *w, char *buf, int n) {
uint32_t f = w[0];
int t = f >> 28, width = (f >> 24) & 0xF;
if (t > 0xA || (t == 5 && ((f >> 12) & 0xF) > 1) || (t == 0xA && ((f >> 8) & 0xF) > 5)) {
int ext = f >> 24; // 0xC0-0xC3 run; C0's width is at bits 20-23 and its operand type (at most 5) at bits 8-11
if (ext == 0xC0) t = -1, width = (f >> 20) & 0xF;
if ((t > 0xA && (ext < 0xC1 || ext > 0xC3)) || (t == -1 && ((f >> 8) & 0xF) > 5) ||
(t == 5 && ((f >> 12) & 0xF) > 1) || (t == 0xA && ((f >> 8) & 0xF) > 5)) {
snprintf(buf, n, "opcode %08X is not supported", f);
return buf;
}
if ((t <= 1 || t == 5 || t == 6 || t == 7 || t == 9 || t == 0xA) && width != 1 && width != 2 && width != 4 &&
width != 8) {
width != 8) { // C0 too (t -1)
snprintf(buf, n, "opcode %08X has a bad width", f);
return buf;
}
@@ -227,7 +237,9 @@ static int compare(int cond, uint64_t a, uint64_t b) {
}
// From i (after a failed condition, or an else reached while running), the opcode to continue at: after the
// matching else (else_ok) or end.
// matching else (else_ok) or end. Conditions 1, 8 and C0 open a block, as in Atmosphere's dmnt
// (stratosphere/dmnt/source/cheat/impl/dmnt_cheat_vm.cpp, CheatVirtualMachine::SkipConditionalBlock), which steps
// over whole opcodes so that an operand word reading 20000000 ends nothing.
static int skip(const uint32_t *w, int n, int i, int else_ok) {
int depth = 0;
while (i < n) {
@@ -236,17 +248,41 @@ static int skip(const uint32_t *w, int n, int i, int else_ok) {
uint32_t f = w[i];
int t = f >> 28;
i += len;
if (t == 1 || t == 8) depth++;
else if (t == 2 && ((f >> 24) & 0xF) == 0 && depth-- == 0) return i;
else if (t == 2 && depth == 0 && else_ok) return i;
if (t == 1 || t == 8 || f >> 24 == 0xC0) depth++;
else if (t == 2 && ((f >> 24) & 0xF) == 1) { // else; any other 2x000000 ends, as dmnt decodes is_else
if (depth == 0 && else_ok) return i;
} else if (t == 2 && depth-- == 0) {
return i;
}
}
return n;
}
static uint64_t imm64(const uint32_t *w) { return (uint64_t)w[0] << 32 | w[1]; }
// C0TcSX..: if register S <cond c> operand X, all cut to width T; the operand as Atmosphere's dmnt reads it
// (stratosphere/dmnt/source/cheat/impl/dmnt_cheat_vm.cpp, CheatVirtualMachine::DecodeNextOpcode and Execute,
// BeginRegisterConditionalBlock). X: 0 region M + a, 1 region M + register r, 2 register R + a, 3 register R +
// register r, 4 the value V, 5 register R. M, R at bits 4-7, r and the top bits of a at bits 0-3. A read the guest
// cannot make compares as 0: dmnt ignores the read's result and compares the zero it started with.
static int reg_cond(const uint32_t *w, const uint64_t *r) {
uint32_t f = w[0];
int width = (f >> 20) & 0xF, cond = (f >> 16) & 0xF, a4 = (f >> 4) & 0xF, a0 = f & 0xF;
uint64_t src = masked(width, r[(f >> 12) & 0xF]), b = 0, addr;
switch ((f >> 8) & 0xF) { // w[1] exists for types 0, 2 and 4 only (op_len)
case 0: addr = region(a4) + (((uint64_t)a0 << 32) | w[1]); break;
case 1: addr = region(a4) + r[a0]; break;
case 2: addr = r[a4] + (((uint64_t)a0 << 32) | w[1]); break;
case 3: addr = r[a4] + r[a0]; break;
case 4: return compare(cond, src, width == 8 ? imm64(w + 1) : masked(width, w[1]));
default: return compare(cond, src, masked(width, r[a4]));
}
if (!rd(addr, width, &b)) b = 0;
return compare(cond, src, b);
}
static void run(const Cheat *c, uint64_t keys) {
uint64_t r[16] = {0};
uint64_t r[16] = {0}, saved[16] = {0};
int loop[16] = {0};
const uint32_t *w = c->words;
int n = c->n, budget = OPS_PER_RUN;
@@ -323,6 +359,44 @@ static void run(const Cheat *c, uint64_t keys) {
if (z) r[y] += (uint64_t)width;
break;
}
case 0xC: // C1-C3 as dmnt's Execute runs SaveRestoreRegister(Mask) and ReadWriteStaticRegister
switch (f >> 24) {
case 0xC0:
if (!reg_cond(w + i, r)) {
i = skip(w, n, i + len, 1);
continue;
}
break;
case 0xC1: { // C10D0Sx0: x 0 register D = saved S, 1 saved D = register S, 2 saved D = 0,
// 3 register D = 0
int d = (f >> 16) & 0xF, s = (f >> 8) & 0xF, op = (f >> 4) & 0xF;
if (op == 1) saved[d] = r[s];
else if (op == 2) saved[d] = 0;
else if (op == 3) r[d] = 0;
else r[d] = saved[s]; // dmnt restores for any other x too
break;
}
case 0xC2: { // C2x0XXXX: for each register in the mask X, x as C1 with D = S = that register
int op = (f >> 20) & 0xF;
for (int k = 0; k < 16; k++) {
if (!(f >> k & 1)) continue;
if (op == 1) saved[k] = r[k];
else if (op == 2) saved[k] = 0;
else if (op == 3) r[k] = 0;
else r[k] = saved[k];
}
break;
}
case 0xC3: { // C3000XXx: static register XX < 0x80 into register x, else register x into it
int s = (f >> 4) & 0xFF;
if (s < 0x80) r[f & 0xF] = g_static[s];
else g_static[s] = r[f & 0xF];
break;
}
default:
return;
}
break;
default:
return;
}
@@ -442,9 +516,13 @@ static void plain_name(char *s) {
// ---- rebuild: code cheats and ExeFS patches the build lacks
// The setup writes build-cache\rebuild.txt (installer/steps.py write_rebuild_command), the command that starts its
// window in rebuild mode on this install folder, one argument per line. When an enabled mod has code cheats this build
// lacks (CHEAT_REBUILD) or ExeFS patch files it lacks (mods_exefs_pending), the game runs it and exits; the setup lifts
// and compiles them in and starts the game again.
// window in rebuild mode on this install folder, one argument per line. The build kit's command (installer/layout.py)
// is relative to the install folder: its program is taken from this exe's folder, and the command runs with that
// folder as its working folder, against which the setup resolves its other arguments. When an enabled mod has code
// cheats this build
// lacks (CHEAT_REBUILD) or ExeFS patch files it lacks (mods_exefs_pending), or the build has a mod plugin whose file is
// gone (ldr_plugins_gone: its mod was removed), the game runs it and exits; the setup lifts and compiles them in (or the
// plugin out) and starts the game again.
// build-cache\rebuild.skip holds the key of the cheats a rebuild was started for: a rebuild that failed or was
// cancelled leaves them unbuilt, and the same set does not start it again. TOTK_MODS_REBUILD=off never starts it.
// Scripted runs (--seconds, --boot) never start it.
@@ -458,7 +536,7 @@ static void rebuild_if_needed(const char *dir) {
key = (key ^ fnv(c->info.key, strlen(c->info.key))) * 0x01000193u;
key = (key ^ c->content) * 0x01000193u;
}
int patches = mods_exefs_pending(&key);
int patches = mods_exefs_pending(&key) + ldr_plugins_gone(&key);
if (!need && !patches) return;
char cmd_path[PLAT_PATH_MAX + 64], skip_path[PLAT_PATH_MAX + 64], skip[16] = "", want[16];
snprintf(cmd_path, sizeof cmd_path, "%sbuild-cache" SEP "rebuild.txt", dir);
@@ -474,12 +552,13 @@ static void rebuild_if_needed(const char *dir) {
char *cmd = why ? NULL : read_text(cmd_path);
if (!why && !cmd) why = "no build-cache/rebuild.txt (a build without the setup)";
if (why) {
rt_log("cheats: %d code cheats and %d ExeFS patch files are not built into the game; no rebuild: %s", need,
rt_log("cheats: %d code cheats and %d ExeFS patch files or plugins differ from the build; no rebuild: %s", need,
patches, why);
free(cmd);
return;
}
const char *argv[32];
char program[PLAT_PATH_MAX + 64];
int argc = 0;
for (char *line = cmd; line && *line && argc < 31;) {
char *end = strchr(line, '\n'), *next = end ? end + 1 : NULL;
@@ -490,18 +569,25 @@ static void rebuild_if_needed(const char *dir) {
line = next;
}
argv[argc] = NULL;
// CreateProcess resolves a relative program against this process's working folder, which a shortcut may set
if (argc && !plat_path_absolute(argv[0]) &&
snprintf(program, sizeof program, "%s%s", dir, argv[0]) < (int)sizeof program)
argv[0] = program;
if (argc < 2 || !plat_file_write(skip_path, want, strlen(want))) {
rt_log("cheats: %d code cheats and %d ExeFS patch files are not built into the game; cannot start the "
rt_log("cheats: %d code cheats and %d ExeFS patch files or plugins differ from the build; cannot start the "
"rebuild (%s)", need, patches, cmd_path);
free(cmd);
return;
}
rt_log("cheats: %d code cheats and %d ExeFS patch files are not built into the game; starting the rebuild: %s",
rt_log("cheats: %d code cheats and %d ExeFS patch files or plugins differ from the build; starting the rebuild: %s",
need, patches, argv[0]);
int ok = plat_spawn(argv, dir);
free(cmd);
if (!ok) {
rt_log("cheats: the rebuild did not start; the game starts with the code it has");
// The skip key is for a rebuild that ran and failed or was cancelled. One that never started (a command whose
// program is gone) leaves no key, so the next start and "Rebuild the game now" try it again.
plat_fs_unlink(skip_path);
rt_log("cheats: the rebuild did not start (%s); the game starts with the code it has", cmd_path);
return;
}
prof_write(); // plat_exit runs no atexit handlers
+266 -148
View File
@@ -1,156 +1,274 @@
// Generated by tools/build_shaders.py from runtime/shaders/contact_shadow.comp; do not edit.
// source sha256 b452a1920e59c4d83b2c994b0c6573cc1e479f7032a1310a7432d11c5c2e9908
// source sha256 e44a73a42aed3d5c2ac3a0a7e8809234f6175f8e331d30f93331ae9ca32fda71
#pragma once
#include <stdint.h>
static const uint32_t contact_shadow_spv[] = {
0x07230203, 0x00010300, 0x000d000b, 0x000001b1, 0x00000000, 0x00020011, 0x00000001, 0x00020011,
0x07230203, 0x00010300, 0x000d000b, 0x0000040b, 0x00000000, 0x00020011, 0x00000001, 0x00020011,
0x00000031, 0x0006000b, 0x00000001, 0x4c534c47, 0x6474732e, 0x3035342e, 0x00000000, 0x0003000e,
0x00000000, 0x00000001, 0x0006000f, 0x00000005, 0x00000004, 0x6e69616d, 0x00000000, 0x00000069,
0x00060010, 0x00000004, 0x00000011, 0x00000008, 0x00000008, 0x00000001, 0x00030047, 0x00000027,
0x00000002, 0x00050048, 0x00000027, 0x00000000, 0x00000023, 0x00000000, 0x00050048, 0x00000027,
0x00000001, 0x00000023, 0x00000010, 0x00050048, 0x00000027, 0x00000002, 0x00000023, 0x00000020,
0x00050048, 0x00000027, 0x00000003, 0x00000023, 0x00000030, 0x00040047, 0x00000069, 0x0000000b,
0x0000001c, 0x00040047, 0x00000088, 0x00000021, 0x00000000, 0x00040047, 0x00000088, 0x00000022,
0x00000000, 0x00040047, 0x0000013f, 0x00000021, 0x00000001, 0x00040047, 0x0000013f, 0x00000022,
0x00000000, 0x00040047, 0x0000015c, 0x0000000b, 0x00000019, 0x00020013, 0x00000002, 0x00030021,
0x00000000, 0x00000001, 0x0006000f, 0x00000005, 0x00000004, 0x6e69616d, 0x00000000, 0x0000011f,
0x00060010, 0x00000004, 0x00000011, 0x00000008, 0x00000008, 0x00000001, 0x00030047, 0x00000033,
0x00000002, 0x00050048, 0x00000033, 0x00000000, 0x00000023, 0x00000000, 0x00050048, 0x00000033,
0x00000001, 0x00000023, 0x00000010, 0x00050048, 0x00000033, 0x00000002, 0x00000023, 0x00000020,
0x00050048, 0x00000033, 0x00000003, 0x00000023, 0x00000030, 0x00040047, 0x00000086, 0x00000021,
0x00000000, 0x00040047, 0x00000086, 0x00000022, 0x00000000, 0x00040047, 0x0000011f, 0x0000000b,
0x0000001c, 0x00040047, 0x00000162, 0x00000021, 0x00000002, 0x00040047, 0x00000162, 0x00000022,
0x00000000, 0x00040047, 0x00000172, 0x00000021, 0x00000001, 0x00040047, 0x00000172, 0x00000022,
0x00000000, 0x00040047, 0x00000242, 0x0000000b, 0x00000019, 0x00020013, 0x00000002, 0x00030021,
0x00000003, 0x00000002, 0x00030016, 0x00000006, 0x00000020, 0x00040017, 0x00000007, 0x00000006,
0x00000002, 0x00040017, 0x0000000a, 0x00000006, 0x00000003, 0x0004002b, 0x00000006, 0x0000001b,
0x40000000, 0x0004002b, 0x00000006, 0x0000001d, 0x3f800000, 0x00040015, 0x00000020, 0x00000020,
0x00000000, 0x0004002b, 0x00000020, 0x00000021, 0x00000000, 0x00040017, 0x00000026, 0x00000006,
0x00000004, 0x0006001e, 0x00000027, 0x00000026, 0x00000026, 0x00000026, 0x00000026, 0x00040020,
0x00000028, 0x00000009, 0x00000027, 0x0004003b, 0x00000028, 0x00000029, 0x00000009, 0x00040015,
0x0000002a, 0x00000020, 0x00000001, 0x0004002b, 0x0000002a, 0x0000002b, 0x00000000, 0x00040020,
0x0000002c, 0x00000009, 0x00000006, 0x0004002b, 0x00000020, 0x00000030, 0x00000001, 0x0004002b,
0x00000020, 0x0000003f, 0x00000002, 0x0004002b, 0x00000006, 0x00000043, 0x3f000000, 0x0004002b,
0x00000006, 0x00000059, 0x4253ee82, 0x0004002b, 0x00000006, 0x0000005b, 0x3d897143, 0x0004002b,
0x00000006, 0x0000005c, 0x3bbf4590, 0x0005002c, 0x00000007, 0x0000005d, 0x0000005b, 0x0000005c,
0x00040017, 0x00000064, 0x0000002a, 0x00000002, 0x00040017, 0x00000067, 0x00000020, 0x00000003,
0x00040020, 0x00000068, 0x00000001, 0x00000067, 0x0004003b, 0x00000068, 0x00000069, 0x00000001,
0x00040017, 0x0000006a, 0x00000020, 0x00000002, 0x00020014, 0x0000006e, 0x0004002b, 0x0000002a,
0x00000072, 0x00000002, 0x00090019, 0x00000085, 0x00000006, 0x00000001, 0x00000000, 0x00000000,
0x00000000, 0x00000001, 0x00000000, 0x0003001b, 0x00000086, 0x00000085, 0x00040020, 0x00000087,
0x00000000, 0x00000086, 0x0004003b, 0x00000087, 0x00000088, 0x00000000, 0x0004002b, 0x00000006,
0x0000008f, 0x00000000, 0x0004002b, 0x00000006, 0x00000092, 0x3f7fbe77, 0x0004002b, 0x00000006,
0x0000009e, 0x42a00000, 0x00040020, 0x000000a8, 0x00000009, 0x00000026, 0x0004002b, 0x0000002a,
0x000000b4, 0x00000001, 0x0004002b, 0x00000020, 0x000000b5, 0x00000003, 0x0004002b, 0x00000006,
0x000000bb, 0x3ecccccd, 0x0004002b, 0x00000006, 0x000000bc, 0x40400000, 0x0004002b, 0x00000006,
0x000000c0, 0x3e19999a, 0x0004002b, 0x00000006, 0x000000c2, 0x3c23d70a, 0x0004002b, 0x00000006,
0x000000cb, 0x3e800000, 0x0004002b, 0x0000002a, 0x000000da, 0x00000010, 0x0004002b, 0x00000006,
0x000000e6, 0xbd4ccccd, 0x0005002c, 0x00000007, 0x000000f0, 0x0000008f, 0x0000008f, 0x00040017,
0x000000f1, 0x0000006e, 0x00000002, 0x0005002c, 0x00000007, 0x000000f8, 0x0000001d, 0x0000001d,
0x0004002b, 0x00000006, 0x00000114, 0x3ca3d70a, 0x0004002b, 0x00000006, 0x00000116, 0x3b03126f,
0x0004002b, 0x00000006, 0x0000012b, 0x42200000, 0x0004002b, 0x0000002a, 0x00000137, 0x00000003,
0x00090019, 0x0000013d, 0x00000006, 0x00000001, 0x00000000, 0x00000000, 0x00000000, 0x00000002,
0x00000008, 0x00040020, 0x0000013e, 0x00000000, 0x0000013d, 0x0004003b, 0x0000013e, 0x0000013f,
0x00000000, 0x0004002b, 0x00000020, 0x0000015b, 0x00000008, 0x0006002c, 0x00000067, 0x0000015c,
0x0000015b, 0x0000015b, 0x00000030, 0x0005002c, 0x00000007, 0x000001ad, 0x00000043, 0x00000043,
0x0004002b, 0x00000006, 0x000001af, 0x3dcccccd, 0x0004002b, 0x00000006, 0x000001b0, 0x3d800000,
0x00000002, 0x00040017, 0x0000000a, 0x00000006, 0x00000003, 0x00040015, 0x00000019, 0x00000020,
0x00000001, 0x00040017, 0x0000001a, 0x00000019, 0x00000002, 0x0004002b, 0x00000006, 0x00000027,
0x40000000, 0x0004002b, 0x00000006, 0x00000029, 0x3f800000, 0x00040015, 0x0000002c, 0x00000020,
0x00000000, 0x0004002b, 0x0000002c, 0x0000002d, 0x00000000, 0x00040017, 0x00000032, 0x00000006,
0x00000004, 0x0006001e, 0x00000033, 0x00000032, 0x00000032, 0x00000032, 0x00000032, 0x00040020,
0x00000034, 0x00000009, 0x00000033, 0x0004003b, 0x00000034, 0x00000035, 0x00000009, 0x0004002b,
0x00000019, 0x00000036, 0x00000000, 0x00040020, 0x00000037, 0x00000009, 0x00000006, 0x0004002b,
0x0000002c, 0x0000003b, 0x00000001, 0x0004002b, 0x0000002c, 0x0000004a, 0x00000002, 0x0004002b,
0x00000006, 0x0000004e, 0x3f000000, 0x0004002b, 0x00000006, 0x00000064, 0x4253ee82, 0x0004002b,
0x00000006, 0x00000066, 0x3d897143, 0x0004002b, 0x00000006, 0x00000067, 0x3bbf4590, 0x0005002c,
0x00000007, 0x00000068, 0x00000066, 0x00000067, 0x0005002c, 0x0000001a, 0x00000070, 0x00000036,
0x00000036, 0x0004002b, 0x00000019, 0x00000071, 0x00000002, 0x00040020, 0x00000072, 0x00000009,
0x00000032, 0x0004002b, 0x00000019, 0x00000077, 0x00000001, 0x00090019, 0x00000083, 0x00000006,
0x00000001, 0x00000000, 0x00000000, 0x00000000, 0x00000001, 0x00000000, 0x0003001b, 0x00000084,
0x00000083, 0x00040020, 0x00000085, 0x00000000, 0x00000084, 0x0004003b, 0x00000085, 0x00000086,
0x00000000, 0x0005002c, 0x0000001a, 0x0000009d, 0x00000077, 0x00000036, 0x0005002c, 0x0000001a,
0x000000a8, 0x00000036, 0x00000077, 0x00020014, 0x000000b1, 0x0004002b, 0x00000006, 0x00000110,
0x00000000, 0x00040017, 0x0000011d, 0x0000002c, 0x00000003, 0x00040020, 0x0000011e, 0x00000001,
0x0000011d, 0x0004003b, 0x0000011e, 0x0000011f, 0x00000001, 0x00040017, 0x00000120, 0x0000002c,
0x00000002, 0x0004002b, 0x00000006, 0x00000140, 0x3f7fbe77, 0x0004002b, 0x00000006, 0x0000014c,
0x42a00000, 0x0004002b, 0x00000019, 0x0000015b, 0x00000003, 0x0004003b, 0x00000085, 0x00000162,
0x00000000, 0x0004002b, 0x0000002c, 0x00000166, 0x00000003, 0x0004002b, 0x00000006, 0x0000016c,
0x3fc00000, 0x00090019, 0x00000170, 0x00000006, 0x00000001, 0x00000000, 0x00000000, 0x00000000,
0x00000002, 0x00000008, 0x00040020, 0x00000171, 0x00000000, 0x00000170, 0x0004003b, 0x00000171,
0x00000172, 0x00000000, 0x0004002b, 0x00000006, 0x0000018a, 0x3e99999a, 0x0004002b, 0x00000006,
0x000001a1, 0x3ecccccd, 0x0004002b, 0x00000006, 0x000001a2, 0x40400000, 0x0004002b, 0x00000006,
0x000001a6, 0x3e19999a, 0x0004002b, 0x00000006, 0x000001a8, 0x3c23d70a, 0x0004002b, 0x00000006,
0x000001b1, 0x3e800000, 0x0004002b, 0x00000019, 0x000001c0, 0x00000010, 0x0004002b, 0x00000006,
0x000001cc, 0xbd4ccccd, 0x0005002c, 0x00000007, 0x000001d6, 0x00000110, 0x00000110, 0x00040017,
0x000001d7, 0x000000b1, 0x00000002, 0x0005002c, 0x00000007, 0x000001de, 0x00000029, 0x00000029,
0x0004002b, 0x00000006, 0x000001fa, 0x3ca3d70a, 0x0004002b, 0x00000006, 0x000001fc, 0x3b03126f,
0x0004002b, 0x00000006, 0x00000211, 0x42200000, 0x0004002b, 0x0000002c, 0x00000241, 0x00000008,
0x0006002c, 0x0000011d, 0x00000242, 0x00000241, 0x00000241, 0x0000003b, 0x0005002c, 0x00000007,
0x00000406, 0x0000004e, 0x0000004e, 0x0005002c, 0x0000001a, 0x00000407, 0x00000077, 0x00000077,
0x0004002b, 0x00000006, 0x00000409, 0x3dcccccd, 0x0004002b, 0x00000006, 0x0000040a, 0x3d800000,
0x00050036, 0x00000002, 0x00000004, 0x00000000, 0x00000003, 0x000200f8, 0x00000005, 0x000300f7,
0x0000015d, 0x00000000, 0x000300fb, 0x00000021, 0x0000015e, 0x000200f8, 0x0000015e, 0x0004003d,
0x00000067, 0x0000006b, 0x00000069, 0x0007004f, 0x0000006a, 0x0000006c, 0x0000006b, 0x0000006b,
0x00000000, 0x00000001, 0x0004007c, 0x00000064, 0x0000006d, 0x0000006c, 0x00050051, 0x0000002a,
0x00000071, 0x0000006d, 0x00000000, 0x00060041, 0x0000002c, 0x00000073, 0x00000029, 0x00000072,
0x00000021, 0x0004003d, 0x00000006, 0x00000074, 0x00000073, 0x0004006e, 0x0000002a, 0x00000075,
0x00000074, 0x000500af, 0x0000006e, 0x00000076, 0x00000071, 0x00000075, 0x000400a8, 0x0000006e,
0x00000077, 0x00000076, 0x000300f7, 0x00000079, 0x00000000, 0x000400fa, 0x00000077, 0x00000078,
0x00000079, 0x000200f8, 0x00000078, 0x00050051, 0x0000002a, 0x0000007b, 0x0000006d, 0x00000001,
0x00060041, 0x0000002c, 0x0000007c, 0x00000029, 0x00000072, 0x00000030, 0x0004003d, 0x00000006,
0x0000007d, 0x0000007c, 0x0004006e, 0x0000002a, 0x0000007e, 0x0000007d, 0x000500af, 0x0000006e,
0x0000007f, 0x0000007b, 0x0000007e, 0x000200f9, 0x00000079, 0x000200f8, 0x00000079, 0x000700f5,
0x0000006e, 0x00000080, 0x00000076, 0x0000015e, 0x0000007f, 0x00000078, 0x000300f7, 0x00000082,
0x00000000, 0x000400fa, 0x00000080, 0x00000081, 0x00000082, 0x000200f8, 0x00000081, 0x000200f9,
0x0000015d, 0x000200f8, 0x00000082, 0x0004003d, 0x00000086, 0x00000089, 0x00000088, 0x00040064,
0x00000085, 0x0000008b, 0x00000089, 0x0007005f, 0x00000026, 0x0000008c, 0x0000008b, 0x0000006d,
0x00000002, 0x0000002b, 0x00050051, 0x00000006, 0x0000008d, 0x0000008c, 0x00000000, 0x000500bc,
0x0000006e, 0x00000090, 0x0000008d, 0x0000008f, 0x000500be, 0x0000006e, 0x00000093, 0x0000008d,
0x00000092, 0x000500a6, 0x0000006e, 0x00000094, 0x00000090, 0x00000093, 0x000300f7, 0x00000096,
0x00000000, 0x000400fa, 0x00000094, 0x00000095, 0x00000096, 0x000200f8, 0x00000095, 0x000200f9,
0x0000015d, 0x000200f8, 0x00000096, 0x00060041, 0x0000002c, 0x0000009a, 0x00000029, 0x0000002b,
0x0000003f, 0x0004003d, 0x00000006, 0x0000009b, 0x0000009a, 0x00050085, 0x00000006, 0x0000009c,
0x0000008d, 0x0000009b, 0x000500ba, 0x0000006e, 0x0000009f, 0x0000009c, 0x0000009e, 0x000300f7,
0x000000a1, 0x00000000, 0x000400fa, 0x0000009f, 0x000000a0, 0x000000a1, 0x000200f8, 0x000000a0,
0x000200f9, 0x0000015d, 0x000200f8, 0x000000a1, 0x0004006f, 0x00000007, 0x000000a5, 0x0000006d,
0x00050081, 0x00000007, 0x000000a7, 0x000000a5, 0x000001ad, 0x00050041, 0x000000a8, 0x000000a9,
0x00000029, 0x00000072, 0x0004003d, 0x00000026, 0x000000aa, 0x000000a9, 0x0007004f, 0x00000007,
0x000000ab, 0x000000aa, 0x000000aa, 0x00000002, 0x00000003, 0x00050085, 0x00000007, 0x000000ac,
0x000000a7, 0x000000ab, 0x0005008e, 0x00000007, 0x00000167, 0x000000ac, 0x0000001b, 0x00050083,
0x00000007, 0x00000169, 0x00000167, 0x000000f8, 0x00050051, 0x00000006, 0x0000016b, 0x00000169,
0x00000000, 0x00050085, 0x00000006, 0x0000016d, 0x0000016b, 0x0000009c, 0x00060041, 0x0000002c,
0x0000016e, 0x00000029, 0x0000002b, 0x00000021, 0x0004003d, 0x00000006, 0x0000016f, 0x0000016e,
0x00050088, 0x00000006, 0x00000170, 0x0000016d, 0x0000016f, 0x00050051, 0x00000006, 0x00000172,
0x00000169, 0x00000001, 0x0004007f, 0x00000006, 0x00000173, 0x00000172, 0x00050085, 0x00000006,
0x00000175, 0x00000173, 0x0000009c, 0x00060041, 0x0000002c, 0x00000176, 0x00000029, 0x0000002b,
0x00000030, 0x0004003d, 0x00000006, 0x00000177, 0x00000176, 0x00050088, 0x00000006, 0x00000178,
0x00000175, 0x00000177, 0x0004007f, 0x00000006, 0x0000017a, 0x0000009c, 0x00060050, 0x0000000a,
0x0000017b, 0x00000170, 0x00000178, 0x0000017a, 0x00060041, 0x0000002c, 0x000000b6, 0x00000029,
0x000000b4, 0x000000b5, 0x0004003d, 0x00000006, 0x000000b7, 0x000000b6, 0x00050085, 0x00000006,
0x000000ba, 0x0000009c, 0x000001af, 0x0008000c, 0x00000006, 0x000000bd, 0x00000001, 0x0000002b,
0x000000ba, 0x000000bb, 0x000000bc, 0x00050085, 0x00000006, 0x000000be, 0x000000b7, 0x000000bd,
0x00050085, 0x00000006, 0x000000c3, 0x0000009c, 0x000000c2, 0x00050081, 0x00000006, 0x000000c4,
0x000000c0, 0x000000c3, 0x00050085, 0x00000006, 0x000000c8, 0x000000be, 0x000001b0, 0x00050094,
0x00000006, 0x0000017f, 0x000000a5, 0x0000005d, 0x0006000c, 0x00000006, 0x00000180, 0x00000001,
0x0000000a, 0x0000017f, 0x00050085, 0x00000006, 0x00000181, 0x00000059, 0x00000180, 0x0006000c,
0x00000006, 0x00000182, 0x00000001, 0x0000000a, 0x00000181, 0x00050081, 0x00000006, 0x000000d0,
0x000000cb, 0x00000182, 0x00050085, 0x00000006, 0x000000d1, 0x000000c8, 0x000000d0, 0x000200f9,
0x000000d4, 0x000200f8, 0x000000d4, 0x000700f5, 0x00000006, 0x000001a7, 0x000000d1, 0x000000a1,
0x00000129, 0x000000d7, 0x000700f5, 0x0000002a, 0x000001a6, 0x0000002b, 0x000000a1, 0x00000126,
0x000000d7, 0x000500b1, 0x0000006e, 0x000000db, 0x000001a6, 0x000000da, 0x000400f6, 0x000000d6,
0x000000d7, 0x00000000, 0x000400fa, 0x000000db, 0x000000d5, 0x000000d6, 0x000200f8, 0x000000d5,
0x00050041, 0x000000a8, 0x000000de, 0x00000029, 0x000000b4, 0x0004003d, 0x00000026, 0x000000df,
0x000000de, 0x0008004f, 0x0000000a, 0x000000e0, 0x000000df, 0x000000df, 0x00000000, 0x00000001,
0x00000002, 0x0005008e, 0x0000000a, 0x000000e2, 0x000000e0, 0x000001a7, 0x00050081, 0x0000000a,
0x000000e3, 0x0000017b, 0x000000e2, 0x00050051, 0x00000006, 0x000000e5, 0x000000e3, 0x00000002,
0x000500be, 0x0000006e, 0x000000e7, 0x000000e5, 0x000000e6, 0x000300f7, 0x000000e9, 0x00000000,
0x000400fa, 0x000000e7, 0x000000e8, 0x000000e9, 0x000200f8, 0x000000e8, 0x000200f9, 0x000000d6,
0x000200f8, 0x000000e9, 0x0004007f, 0x00000006, 0x00000188, 0x000000e5, 0x00050051, 0x00000006,
0x0000018a, 0x000000e3, 0x00000000, 0x00050085, 0x00000006, 0x0000018b, 0x00000043, 0x0000018a,
0x00050085, 0x00000006, 0x0000018e, 0x0000018b, 0x0000016f, 0x00050088, 0x00000006, 0x00000190,
0x0000018e, 0x00000188, 0x00050081, 0x00000006, 0x00000191, 0x00000043, 0x00000190, 0x00050051,
0x00000006, 0x00000193, 0x000000e3, 0x00000001, 0x00050085, 0x00000006, 0x00000194, 0x00000043,
0x00000193, 0x00050085, 0x00000006, 0x00000197, 0x00000194, 0x00000177, 0x00050088, 0x00000006,
0x00000199, 0x00000197, 0x00000188, 0x00050083, 0x00000006, 0x0000019a, 0x00000043, 0x00000199,
0x00050050, 0x00000007, 0x0000019b, 0x00000191, 0x0000019a, 0x000500b8, 0x000000f1, 0x000000f2,
0x0000019b, 0x000000f0, 0x0004009a, 0x0000006e, 0x000000f3, 0x000000f2, 0x000400a8, 0x0000006e,
0x000000f4, 0x000000f3, 0x000300f7, 0x000000f6, 0x00000000, 0x000400fa, 0x000000f4, 0x000000f5,
0x000000f6, 0x000200f8, 0x000000f5, 0x000500ba, 0x000000f1, 0x000000f9, 0x0000019b, 0x000000f8,
0x0004009a, 0x0000006e, 0x000000fa, 0x000000f9, 0x000200f9, 0x000000f6, 0x000200f8, 0x000000f6,
0x000700f5, 0x0000006e, 0x000000fb, 0x000000f3, 0x000000e9, 0x000000fa, 0x000000f5, 0x000300f7,
0x000000fd, 0x00000000, 0x000400fa, 0x000000fb, 0x000000fc, 0x000000fd, 0x000200f8, 0x000000fc,
0x000200f9, 0x000000d6, 0x000200f8, 0x000000fd, 0x0004003d, 0x00000086, 0x00000100, 0x00000088,
0x0007004f, 0x00000007, 0x00000104, 0x000000aa, 0x000000aa, 0x00000000, 0x00000001, 0x00050085,
0x00000007, 0x00000105, 0x0000019b, 0x00000104, 0x0004006e, 0x00000064, 0x00000106, 0x00000105,
0x00040064, 0x00000085, 0x00000107, 0x00000100, 0x0007005f, 0x00000026, 0x00000108, 0x00000107,
0x00000106, 0x00000002, 0x0000002b, 0x00050051, 0x00000006, 0x00000109, 0x00000108, 0x00000000,
0x00050085, 0x00000006, 0x0000010c, 0x00000109, 0x0000009b, 0x00050083, 0x00000006, 0x00000112,
0x00000188, 0x0000010c, 0x00050085, 0x00000006, 0x00000117, 0x0000009c, 0x00000116, 0x00050081,
0x00000006, 0x00000118, 0x00000114, 0x00000117, 0x000500ba, 0x0000006e, 0x00000119, 0x00000112,
0x00000118, 0x000500b8, 0x0000006e, 0x0000011c, 0x00000112, 0x000000c4, 0x000500a7, 0x0000006e,
0x0000011d, 0x00000119, 0x0000011c, 0x000300f7, 0x0000011f, 0x00000000, 0x000400fa, 0x0000011d,
0x0000011e, 0x0000011f, 0x000200f8, 0x0000011e, 0x0004006f, 0x00000006, 0x00000121, 0x000001a6,
0x00050085, 0x00000006, 0x00000122, 0x00000121, 0x000001b0, 0x00050083, 0x00000006, 0x00000123,
0x0000001d, 0x00000122, 0x000200f9, 0x000000d6, 0x000200f8, 0x0000011f, 0x000200f9, 0x000000d7,
0x000200f8, 0x000000d7, 0x00050080, 0x0000002a, 0x00000126, 0x000001a6, 0x000000b4, 0x00050081,
0x00000006, 0x00000129, 0x000001a7, 0x000000c8, 0x000200f9, 0x000000d4, 0x000200f8, 0x000000d6,
0x000b00f5, 0x00000006, 0x000001aa, 0x0000008f, 0x000000d4, 0x0000008f, 0x000000e8, 0x0000008f,
0x000000fc, 0x00000123, 0x0000011e, 0x0008000c, 0x00000006, 0x0000012d, 0x00000001, 0x00000031,
0x0000012b, 0x0000009e, 0x0000009c, 0x00050083, 0x00000006, 0x0000012e, 0x0000001d, 0x0000012d,
0x00060041, 0x0000002c, 0x00000130, 0x00000029, 0x0000002b, 0x000000b5, 0x0004003d, 0x00000006,
0x00000131, 0x00000130, 0x00050085, 0x00000006, 0x00000133, 0x00000131, 0x000001aa, 0x00050085,
0x00000006, 0x00000135, 0x00000133, 0x0000012e, 0x00050083, 0x00000006, 0x00000136, 0x0000001d,
0x00000135, 0x00060041, 0x0000002c, 0x00000138, 0x00000029, 0x00000137, 0x00000021, 0x0004003d,
0x00000006, 0x00000139, 0x00000138, 0x000500ba, 0x0000006e, 0x0000013a, 0x00000139, 0x00000043,
0x000300f7, 0x0000013c, 0x00000000, 0x000400fa, 0x0000013a, 0x0000013b, 0x0000013c, 0x000200f8,
0x0000013b, 0x0004003d, 0x0000013d, 0x00000140, 0x0000013f, 0x00070050, 0x00000026, 0x00000143,
0x00000136, 0x00000136, 0x00000136, 0x0000001d, 0x00040063, 0x00000140, 0x0000006d, 0x00000143,
0x000200f9, 0x0000015d, 0x000200f8, 0x0000013c, 0x000500be, 0x0000006e, 0x00000146, 0x00000136,
0x00000092, 0x000300f7, 0x00000148, 0x00000000, 0x000400fa, 0x00000146, 0x00000147, 0x00000148,
0x000200f8, 0x00000147, 0x000200f9, 0x0000015d, 0x000200f8, 0x00000148, 0x0004003d, 0x0000013d,
0x0000014c, 0x0000013f, 0x00050062, 0x00000026, 0x0000014e, 0x0000014c, 0x0000006d, 0x0004003d,
0x0000013d, 0x0000014f, 0x0000013f, 0x0008004f, 0x0000000a, 0x00000152, 0x0000014e, 0x0000014e,
0x00000000, 0x00000001, 0x00000002, 0x0005008e, 0x0000000a, 0x00000154, 0x00000152, 0x00000136,
0x00050051, 0x00000006, 0x00000156, 0x0000014e, 0x00000003, 0x00050051, 0x00000006, 0x00000157,
0x00000154, 0x00000000, 0x00050051, 0x00000006, 0x00000158, 0x00000154, 0x00000001, 0x00050051,
0x00000006, 0x00000159, 0x00000154, 0x00000002, 0x00070050, 0x00000026, 0x0000015a, 0x00000157,
0x00000158, 0x00000159, 0x00000156, 0x00040063, 0x0000014f, 0x0000006d, 0x0000015a, 0x000200f9,
0x0000015d, 0x000200f8, 0x0000015d, 0x000100fd, 0x00010038,
0x00000243, 0x00000000, 0x000300fb, 0x0000002d, 0x00000244, 0x000200f8, 0x00000244, 0x0004003d,
0x0000011d, 0x00000121, 0x0000011f, 0x0007004f, 0x00000120, 0x00000122, 0x00000121, 0x00000121,
0x00000000, 0x00000001, 0x0004007c, 0x0000001a, 0x00000123, 0x00000122, 0x00050051, 0x00000019,
0x00000125, 0x00000123, 0x00000000, 0x00060041, 0x00000037, 0x00000126, 0x00000035, 0x00000071,
0x0000002d, 0x0004003d, 0x00000006, 0x00000127, 0x00000126, 0x0004006e, 0x00000019, 0x00000128,
0x00000127, 0x000500af, 0x000000b1, 0x00000129, 0x00000125, 0x00000128, 0x000400a8, 0x000000b1,
0x0000012a, 0x00000129, 0x000300f7, 0x0000012c, 0x00000000, 0x000400fa, 0x0000012a, 0x0000012b,
0x0000012c, 0x000200f8, 0x0000012b, 0x00050051, 0x00000019, 0x0000012e, 0x00000123, 0x00000001,
0x00060041, 0x00000037, 0x0000012f, 0x00000035, 0x00000071, 0x0000003b, 0x0004003d, 0x00000006,
0x00000130, 0x0000012f, 0x0004006e, 0x00000019, 0x00000131, 0x00000130, 0x000500af, 0x000000b1,
0x00000132, 0x0000012e, 0x00000131, 0x000200f9, 0x0000012c, 0x000200f8, 0x0000012c, 0x000700f5,
0x000000b1, 0x00000133, 0x00000129, 0x00000244, 0x00000132, 0x0000012b, 0x000300f7, 0x00000135,
0x00000000, 0x000400fa, 0x00000133, 0x00000134, 0x00000135, 0x000200f8, 0x00000134, 0x000200f9,
0x00000243, 0x000200f8, 0x00000135, 0x0004003d, 0x00000084, 0x00000138, 0x00000086, 0x00040064,
0x00000083, 0x0000013a, 0x00000138, 0x0007005f, 0x00000032, 0x0000013b, 0x0000013a, 0x00000123,
0x00000002, 0x00000036, 0x00050051, 0x00000006, 0x0000013c, 0x0000013b, 0x00000000, 0x000500bc,
0x000000b1, 0x0000013e, 0x0000013c, 0x00000110, 0x000500be, 0x000000b1, 0x00000141, 0x0000013c,
0x00000140, 0x000500a6, 0x000000b1, 0x00000142, 0x0000013e, 0x00000141, 0x000300f7, 0x00000144,
0x00000000, 0x000400fa, 0x00000142, 0x00000143, 0x00000144, 0x000200f8, 0x00000143, 0x000200f9,
0x00000243, 0x000200f8, 0x00000144, 0x00060041, 0x00000037, 0x00000148, 0x00000035, 0x00000036,
0x0000004a, 0x0004003d, 0x00000006, 0x00000149, 0x00000148, 0x00050085, 0x00000006, 0x0000014a,
0x0000013c, 0x00000149, 0x000500ba, 0x000000b1, 0x0000014d, 0x0000014a, 0x0000014c, 0x000300f7,
0x0000014f, 0x00000000, 0x000400fa, 0x0000014d, 0x0000014e, 0x0000014f, 0x000200f8, 0x0000014e,
0x000200f9, 0x00000243, 0x000200f8, 0x0000014f, 0x0004006f, 0x00000007, 0x00000153, 0x00000123,
0x00050081, 0x00000007, 0x00000155, 0x00000153, 0x00000406, 0x00050041, 0x00000072, 0x00000156,
0x00000035, 0x00000071, 0x0004003d, 0x00000032, 0x00000157, 0x00000156, 0x0007004f, 0x00000007,
0x00000158, 0x00000157, 0x00000157, 0x00000002, 0x00000003, 0x00050085, 0x00000007, 0x00000159,
0x00000155, 0x00000158, 0x00060041, 0x00000037, 0x0000015c, 0x00000035, 0x0000015b, 0x0000003b,
0x0004003d, 0x00000006, 0x0000015d, 0x0000015c, 0x000500ba, 0x000000b1, 0x0000015e, 0x0000015d,
0x0000004e, 0x000300f7, 0x00000161, 0x00000000, 0x000400fa, 0x0000015e, 0x00000160, 0x00000168,
0x000200f8, 0x00000160, 0x0004003d, 0x00000084, 0x00000163, 0x00000162, 0x00070058, 0x00000032,
0x00000165, 0x00000163, 0x00000159, 0x00000002, 0x00000110, 0x00050051, 0x00000006, 0x00000167,
0x00000165, 0x00000003, 0x000200f9, 0x00000161, 0x000200f8, 0x00000168, 0x000200f9, 0x00000161,
0x000200f8, 0x00000161, 0x000700f5, 0x00000006, 0x000003fb, 0x00000167, 0x00000160, 0x00000029,
0x00000168, 0x00060041, 0x00000037, 0x0000016a, 0x00000035, 0x0000015b, 0x0000002d, 0x0004003d,
0x00000006, 0x0000016b, 0x0000016a, 0x000500ba, 0x000000b1, 0x0000016d, 0x0000016b, 0x0000016c,
0x000300f7, 0x0000016f, 0x00000000, 0x000400fa, 0x0000016d, 0x0000016e, 0x0000016f, 0x000200f8,
0x0000016e, 0x0004003d, 0x00000170, 0x00000173, 0x00000172, 0x00070050, 0x00000032, 0x00000176,
0x000003fb, 0x000003fb, 0x000003fb, 0x00000029, 0x00040063, 0x00000173, 0x00000123, 0x00000176,
0x000200f9, 0x00000243, 0x000200f8, 0x0000016f, 0x000500bc, 0x000000b1, 0x00000179, 0x000003fb,
0x00000110, 0x000300f7, 0x0000017b, 0x00000000, 0x000400fa, 0x00000179, 0x0000017a, 0x0000017b,
0x000200f8, 0x0000017a, 0x000500b8, 0x000000b1, 0x0000017e, 0x0000016b, 0x0000004e, 0x000200f9,
0x0000017b, 0x000200f8, 0x0000017b, 0x000700f5, 0x000000b1, 0x0000017f, 0x00000179, 0x0000016f,
0x0000017e, 0x0000017a, 0x000300f7, 0x00000181, 0x00000000, 0x000400fa, 0x0000017f, 0x00000180,
0x00000181, 0x000200f8, 0x00000180, 0x000200f9, 0x00000243, 0x000200f8, 0x00000181, 0x0005008e,
0x00000007, 0x0000024c, 0x00000159, 0x00000027, 0x00050083, 0x00000007, 0x0000024e, 0x0000024c,
0x000001de, 0x00050051, 0x00000006, 0x00000250, 0x0000024e, 0x00000000, 0x00050085, 0x00000006,
0x00000252, 0x00000250, 0x0000014a, 0x00060041, 0x00000037, 0x00000253, 0x00000035, 0x00000036,
0x0000002d, 0x0004003d, 0x00000006, 0x00000254, 0x00000253, 0x00050088, 0x00000006, 0x00000255,
0x00000252, 0x00000254, 0x00050051, 0x00000006, 0x00000257, 0x0000024e, 0x00000001, 0x0004007f,
0x00000006, 0x00000258, 0x00000257, 0x00050085, 0x00000006, 0x0000025a, 0x00000258, 0x0000014a,
0x00060041, 0x00000037, 0x0000025b, 0x00000035, 0x00000036, 0x0000003b, 0x0004003d, 0x00000006,
0x0000025c, 0x0000025b, 0x00050088, 0x00000006, 0x0000025d, 0x0000025a, 0x0000025c, 0x0004007f,
0x00000006, 0x0000025f, 0x0000014a, 0x00060050, 0x0000000a, 0x00000260, 0x00000255, 0x0000025d,
0x0000025f, 0x0007004f, 0x00000007, 0x00000276, 0x00000157, 0x00000157, 0x00000000, 0x00000001,
0x0004006e, 0x0000001a, 0x00000277, 0x00000276, 0x00050082, 0x0000001a, 0x00000279, 0x00000277,
0x00000407, 0x00050082, 0x0000001a, 0x0000027b, 0x00000123, 0x0000009d, 0x0008000c, 0x0000001a,
0x000002ee, 0x00000001, 0x0000002d, 0x0000027b, 0x00000070, 0x00000279, 0x0004006f, 0x00000007,
0x000002f0, 0x000002ee, 0x00050081, 0x00000007, 0x000002f2, 0x000002f0, 0x00000406, 0x00050085,
0x00000007, 0x000002f6, 0x000002f2, 0x00000158, 0x0004003d, 0x00000084, 0x000002f7, 0x00000086,
0x00040064, 0x00000083, 0x000002f9, 0x000002f7, 0x0007005f, 0x00000032, 0x000002fa, 0x000002f9,
0x000002ee, 0x00000002, 0x00000036, 0x00050051, 0x00000006, 0x000002fb, 0x000002fa, 0x00000000,
0x00050085, 0x00000006, 0x000002fe, 0x000002fb, 0x00000149, 0x0005008e, 0x00000007, 0x00000304,
0x000002f6, 0x00000027, 0x00050083, 0x00000007, 0x00000306, 0x00000304, 0x000001de, 0x00050051,
0x00000006, 0x00000308, 0x00000306, 0x00000000, 0x00050085, 0x00000006, 0x0000030a, 0x00000308,
0x000002fe, 0x00050088, 0x00000006, 0x0000030d, 0x0000030a, 0x00000254, 0x00050051, 0x00000006,
0x0000030f, 0x00000306, 0x00000001, 0x0004007f, 0x00000006, 0x00000310, 0x0000030f, 0x00050085,
0x00000006, 0x00000312, 0x00000310, 0x000002fe, 0x00050088, 0x00000006, 0x00000315, 0x00000312,
0x0000025c, 0x0004007f, 0x00000006, 0x00000317, 0x000002fe, 0x00060050, 0x0000000a, 0x00000318,
0x0000030d, 0x00000315, 0x00000317, 0x00050080, 0x0000001a, 0x0000027e, 0x00000123, 0x0000009d,
0x0008000c, 0x0000001a, 0x00000324, 0x00000001, 0x0000002d, 0x0000027e, 0x00000070, 0x00000279,
0x0004006f, 0x00000007, 0x00000326, 0x00000324, 0x00050081, 0x00000007, 0x00000328, 0x00000326,
0x00000406, 0x00050085, 0x00000007, 0x0000032c, 0x00000328, 0x00000158, 0x0004003d, 0x00000084,
0x0000032d, 0x00000086, 0x00040064, 0x00000083, 0x0000032f, 0x0000032d, 0x0007005f, 0x00000032,
0x00000330, 0x0000032f, 0x00000324, 0x00000002, 0x00000036, 0x00050051, 0x00000006, 0x00000331,
0x00000330, 0x00000000, 0x00050085, 0x00000006, 0x00000334, 0x00000331, 0x00000149, 0x0005008e,
0x00000007, 0x0000033a, 0x0000032c, 0x00000027, 0x00050083, 0x00000007, 0x0000033c, 0x0000033a,
0x000001de, 0x00050051, 0x00000006, 0x0000033e, 0x0000033c, 0x00000000, 0x00050085, 0x00000006,
0x00000340, 0x0000033e, 0x00000334, 0x00050088, 0x00000006, 0x00000343, 0x00000340, 0x00000254,
0x00050051, 0x00000006, 0x00000345, 0x0000033c, 0x00000001, 0x0004007f, 0x00000006, 0x00000346,
0x00000345, 0x00050085, 0x00000006, 0x00000348, 0x00000346, 0x00000334, 0x00050088, 0x00000006,
0x0000034b, 0x00000348, 0x0000025c, 0x0004007f, 0x00000006, 0x0000034d, 0x00000334, 0x00060050,
0x0000000a, 0x0000034e, 0x00000343, 0x0000034b, 0x0000034d, 0x00050082, 0x0000001a, 0x00000281,
0x00000123, 0x000000a8, 0x0008000c, 0x0000001a, 0x0000035a, 0x00000001, 0x0000002d, 0x00000281,
0x00000070, 0x00000279, 0x0004006f, 0x00000007, 0x0000035c, 0x0000035a, 0x00050081, 0x00000007,
0x0000035e, 0x0000035c, 0x00000406, 0x00050085, 0x00000007, 0x00000362, 0x0000035e, 0x00000158,
0x0004003d, 0x00000084, 0x00000363, 0x00000086, 0x00040064, 0x00000083, 0x00000365, 0x00000363,
0x0007005f, 0x00000032, 0x00000366, 0x00000365, 0x0000035a, 0x00000002, 0x00000036, 0x00050051,
0x00000006, 0x00000367, 0x00000366, 0x00000000, 0x00050085, 0x00000006, 0x0000036a, 0x00000367,
0x00000149, 0x0005008e, 0x00000007, 0x00000370, 0x00000362, 0x00000027, 0x00050083, 0x00000007,
0x00000372, 0x00000370, 0x000001de, 0x00050051, 0x00000006, 0x00000374, 0x00000372, 0x00000000,
0x00050085, 0x00000006, 0x00000376, 0x00000374, 0x0000036a, 0x00050088, 0x00000006, 0x00000379,
0x00000376, 0x00000254, 0x00050051, 0x00000006, 0x0000037b, 0x00000372, 0x00000001, 0x0004007f,
0x00000006, 0x0000037c, 0x0000037b, 0x00050085, 0x00000006, 0x0000037e, 0x0000037c, 0x0000036a,
0x00050088, 0x00000006, 0x00000381, 0x0000037e, 0x0000025c, 0x0004007f, 0x00000006, 0x00000383,
0x0000036a, 0x00060050, 0x0000000a, 0x00000384, 0x00000379, 0x00000381, 0x00000383, 0x00050080,
0x0000001a, 0x00000284, 0x00000123, 0x000000a8, 0x0008000c, 0x0000001a, 0x00000390, 0x00000001,
0x0000002d, 0x00000284, 0x00000070, 0x00000279, 0x0004006f, 0x00000007, 0x00000392, 0x00000390,
0x00050081, 0x00000007, 0x00000394, 0x00000392, 0x00000406, 0x00050085, 0x00000007, 0x00000398,
0x00000394, 0x00000158, 0x0004003d, 0x00000084, 0x00000399, 0x00000086, 0x00040064, 0x00000083,
0x0000039b, 0x00000399, 0x0007005f, 0x00000032, 0x0000039c, 0x0000039b, 0x00000390, 0x00000002,
0x00000036, 0x00050051, 0x00000006, 0x0000039d, 0x0000039c, 0x00000000, 0x00050085, 0x00000006,
0x000003a0, 0x0000039d, 0x00000149, 0x0005008e, 0x00000007, 0x000003a6, 0x00000398, 0x00000027,
0x00050083, 0x00000007, 0x000003a8, 0x000003a6, 0x000001de, 0x00050051, 0x00000006, 0x000003aa,
0x000003a8, 0x00000000, 0x00050085, 0x00000006, 0x000003ac, 0x000003aa, 0x000003a0, 0x00050088,
0x00000006, 0x000003af, 0x000003ac, 0x00000254, 0x00050051, 0x00000006, 0x000003b1, 0x000003a8,
0x00000001, 0x0004007f, 0x00000006, 0x000003b2, 0x000003b1, 0x00050085, 0x00000006, 0x000003b4,
0x000003b2, 0x000003a0, 0x00050088, 0x00000006, 0x000003b7, 0x000003b4, 0x0000025c, 0x0004007f,
0x00000006, 0x000003b9, 0x000003a0, 0x00060050, 0x0000000a, 0x000003ba, 0x000003af, 0x000003b7,
0x000003b9, 0x000500aa, 0x000000b1, 0x00000288, 0x00000125, 0x00000036, 0x000400a8, 0x000000b1,
0x00000289, 0x00000288, 0x000300f7, 0x000002a0, 0x00000000, 0x000400fa, 0x00000289, 0x0000028a,
0x000002a0, 0x000200f8, 0x0000028a, 0x00050051, 0x00000019, 0x0000028e, 0x00000279, 0x00000000,
0x000500b1, 0x000000b1, 0x0000028f, 0x00000125, 0x0000028e, 0x000300f7, 0x0000029e, 0x00000000,
0x000400fa, 0x0000028f, 0x00000290, 0x0000029e, 0x000200f8, 0x00000290, 0x00050083, 0x00000006,
0x00000295, 0x0000014a, 0x00000334, 0x0006000c, 0x00000006, 0x00000296, 0x00000001, 0x00000004,
0x00000295, 0x00050083, 0x00000006, 0x0000029b, 0x000002fe, 0x0000014a, 0x0006000c, 0x00000006,
0x0000029c, 0x00000001, 0x00000004, 0x0000029b, 0x000500b8, 0x000000b1, 0x0000029d, 0x00000296,
0x0000029c, 0x000200f9, 0x0000029e, 0x000200f8, 0x0000029e, 0x000700f5, 0x000000b1, 0x0000029f,
0x0000028f, 0x0000028a, 0x0000029d, 0x00000290, 0x000200f9, 0x000002a0, 0x000200f8, 0x000002a0,
0x000700f5, 0x000000b1, 0x000002a1, 0x00000288, 0x00000181, 0x0000029f, 0x0000029e, 0x00050051,
0x00000019, 0x000002a3, 0x00000123, 0x00000001, 0x000500aa, 0x000000b1, 0x000002a4, 0x000002a3,
0x00000036, 0x000400a8, 0x000000b1, 0x000002a5, 0x000002a4, 0x000300f7, 0x000002bc, 0x00000000,
0x000400fa, 0x000002a5, 0x000002a6, 0x000002bc, 0x000200f8, 0x000002a6, 0x00050051, 0x00000019,
0x000002aa, 0x00000279, 0x00000001, 0x000500b1, 0x000000b1, 0x000002ab, 0x000002a3, 0x000002aa,
0x000300f7, 0x000002ba, 0x00000000, 0x000400fa, 0x000002ab, 0x000002ac, 0x000002ba, 0x000200f8,
0x000002ac, 0x00050083, 0x00000006, 0x000002b1, 0x0000014a, 0x000003a0, 0x0006000c, 0x00000006,
0x000002b2, 0x00000001, 0x00000004, 0x000002b1, 0x00050083, 0x00000006, 0x000002b7, 0x0000036a,
0x0000014a, 0x0006000c, 0x00000006, 0x000002b8, 0x00000001, 0x00000004, 0x000002b7, 0x000500b8,
0x000000b1, 0x000002b9, 0x000002b2, 0x000002b8, 0x000200f9, 0x000002ba, 0x000200f8, 0x000002ba,
0x000700f5, 0x000000b1, 0x000002bb, 0x000002ab, 0x000002a6, 0x000002b9, 0x000002ac, 0x000200f9,
0x000002bc, 0x000200f8, 0x000002bc, 0x000700f5, 0x000000b1, 0x000002bd, 0x000002a4, 0x000002a0,
0x000002bb, 0x000002ba, 0x000300f7, 0x000002c7, 0x00000000, 0x000400fa, 0x000002a1, 0x000002bf,
0x000002c3, 0x000200f8, 0x000002bf, 0x00050083, 0x0000000a, 0x000002c2, 0x0000034e, 0x00000260,
0x000200f9, 0x000002c7, 0x000200f8, 0x000002c3, 0x00050083, 0x0000000a, 0x000002c6, 0x00000260,
0x00000318, 0x000200f9, 0x000002c7, 0x000200f8, 0x000002c7, 0x000700f5, 0x0000000a, 0x000003fc,
0x000002c2, 0x000002bf, 0x000002c6, 0x000002c3, 0x000300f7, 0x000002d2, 0x00000000, 0x000400fa,
0x000002bd, 0x000002ca, 0x000002ce, 0x000200f8, 0x000002ca, 0x00050083, 0x0000000a, 0x000002cd,
0x000003ba, 0x00000260, 0x000200f9, 0x000002d2, 0x000200f8, 0x000002ce, 0x00050083, 0x0000000a,
0x000002d1, 0x00000260, 0x00000384, 0x000200f9, 0x000002d2, 0x000200f8, 0x000002d2, 0x000700f5,
0x0000000a, 0x000003fd, 0x000002cd, 0x000002ca, 0x000002d1, 0x000002ce, 0x0007000c, 0x0000000a,
0x000002d6, 0x00000001, 0x00000044, 0x000003fc, 0x000003fd, 0x0006000c, 0x0000000a, 0x000002d7,
0x00000001, 0x00000045, 0x000002d6, 0x00050094, 0x00000006, 0x000002da, 0x000002d7, 0x00000260,
0x000500ba, 0x000000b1, 0x000002db, 0x000002da, 0x00000110, 0x000300f7, 0x000002e1, 0x00000000,
0x000400fa, 0x000002db, 0x000002dc, 0x000002df, 0x000200f8, 0x000002dc, 0x0004007f, 0x0000000a,
0x000002de, 0x000002d7, 0x000200f9, 0x000002e1, 0x000200f8, 0x000002df, 0x000200f9, 0x000002e1,
0x000200f8, 0x000002e1, 0x000700f5, 0x0000000a, 0x000003fe, 0x000002de, 0x000002dc, 0x000002d7,
0x000002df, 0x00050041, 0x00000072, 0x00000190, 0x00000035, 0x00000077, 0x0004003d, 0x00000032,
0x00000191, 0x00000190, 0x0008004f, 0x0000000a, 0x00000192, 0x00000191, 0x00000191, 0x00000000,
0x00000001, 0x00000002, 0x00050094, 0x00000006, 0x00000193, 0x000003fe, 0x00000192, 0x0008000c,
0x00000006, 0x00000194, 0x00000001, 0x00000031, 0x00000110, 0x0000018a, 0x00000193, 0x000500bd,
0x000000b1, 0x00000197, 0x00000194, 0x00000110, 0x000300f7, 0x00000199, 0x00000000, 0x000400fa,
0x00000197, 0x00000198, 0x00000199, 0x000200f8, 0x00000198, 0x000200f9, 0x00000243, 0x000200f8,
0x00000199, 0x00060041, 0x00000037, 0x0000019c, 0x00000035, 0x00000077, 0x00000166, 0x0004003d,
0x00000006, 0x0000019d, 0x0000019c, 0x00050085, 0x00000006, 0x000001a0, 0x0000014a, 0x00000409,
0x0008000c, 0x00000006, 0x000001a3, 0x00000001, 0x0000002b, 0x000001a0, 0x000001a1, 0x000001a2,
0x00050085, 0x00000006, 0x000001a4, 0x0000019d, 0x000001a3, 0x00050085, 0x00000006, 0x000001a9,
0x0000014a, 0x000001a8, 0x00050081, 0x00000006, 0x000001aa, 0x000001a6, 0x000001a9, 0x00050085,
0x00000006, 0x000001ae, 0x000001a4, 0x0000040a, 0x00050094, 0x00000006, 0x000003be, 0x00000153,
0x00000068, 0x0006000c, 0x00000006, 0x000003bf, 0x00000001, 0x0000000a, 0x000003be, 0x00050085,
0x00000006, 0x000003c0, 0x00000064, 0x000003bf, 0x0006000c, 0x00000006, 0x000003c1, 0x00000001,
0x0000000a, 0x000003c0, 0x00050081, 0x00000006, 0x000001b6, 0x000001b1, 0x000003c1, 0x00050085,
0x00000006, 0x000001b7, 0x000001ae, 0x000001b6, 0x000200f9, 0x000001ba, 0x000200f8, 0x000001ba,
0x000700f5, 0x00000006, 0x00000400, 0x000001b7, 0x00000199, 0x0000020f, 0x000001bd, 0x000700f5,
0x00000019, 0x000003ff, 0x00000036, 0x00000199, 0x0000020c, 0x000001bd, 0x000500b1, 0x000000b1,
0x000001c1, 0x000003ff, 0x000001c0, 0x000400f6, 0x000001bc, 0x000001bd, 0x00000000, 0x000400fa,
0x000001c1, 0x000001bb, 0x000001bc, 0x000200f8, 0x000001bb, 0x0005008e, 0x0000000a, 0x000001c8,
0x00000192, 0x00000400, 0x00050081, 0x0000000a, 0x000001c9, 0x00000260, 0x000001c8, 0x00050051,
0x00000006, 0x000001cb, 0x000001c9, 0x00000002, 0x000500be, 0x000000b1, 0x000001cd, 0x000001cb,
0x000001cc, 0x000300f7, 0x000001cf, 0x00000000, 0x000400fa, 0x000001cd, 0x000001ce, 0x000001cf,
0x000200f8, 0x000001ce, 0x000200f9, 0x000001bc, 0x000200f8, 0x000001cf, 0x0004007f, 0x00000006,
0x000003c7, 0x000001cb, 0x00050051, 0x00000006, 0x000003c9, 0x000001c9, 0x00000000, 0x00050085,
0x00000006, 0x000003ca, 0x0000004e, 0x000003c9, 0x00050085, 0x00000006, 0x000003cd, 0x000003ca,
0x00000254, 0x00050088, 0x00000006, 0x000003cf, 0x000003cd, 0x000003c7, 0x00050081, 0x00000006,
0x000003d0, 0x0000004e, 0x000003cf, 0x00050051, 0x00000006, 0x000003d2, 0x000001c9, 0x00000001,
0x00050085, 0x00000006, 0x000003d3, 0x0000004e, 0x000003d2, 0x00050085, 0x00000006, 0x000003d6,
0x000003d3, 0x0000025c, 0x00050088, 0x00000006, 0x000003d8, 0x000003d6, 0x000003c7, 0x00050083,
0x00000006, 0x000003d9, 0x0000004e, 0x000003d8, 0x00050050, 0x00000007, 0x000003da, 0x000003d0,
0x000003d9, 0x000500b8, 0x000001d7, 0x000001d8, 0x000003da, 0x000001d6, 0x0004009a, 0x000000b1,
0x000001d9, 0x000001d8, 0x000400a8, 0x000000b1, 0x000001da, 0x000001d9, 0x000300f7, 0x000001dc,
0x00000000, 0x000400fa, 0x000001da, 0x000001db, 0x000001dc, 0x000200f8, 0x000001db, 0x000500ba,
0x000001d7, 0x000001df, 0x000003da, 0x000001de, 0x0004009a, 0x000000b1, 0x000001e0, 0x000001df,
0x000200f9, 0x000001dc, 0x000200f8, 0x000001dc, 0x000700f5, 0x000000b1, 0x000001e1, 0x000001d9,
0x000001cf, 0x000001e0, 0x000001db, 0x000300f7, 0x000001e3, 0x00000000, 0x000400fa, 0x000001e1,
0x000001e2, 0x000001e3, 0x000200f8, 0x000001e2, 0x000200f9, 0x000001bc, 0x000200f8, 0x000001e3,
0x0004003d, 0x00000084, 0x000001e6, 0x00000086, 0x00050085, 0x00000007, 0x000001eb, 0x000003da,
0x00000276, 0x0004006e, 0x0000001a, 0x000001ec, 0x000001eb, 0x00040064, 0x00000083, 0x000001ed,
0x000001e6, 0x0007005f, 0x00000032, 0x000001ee, 0x000001ed, 0x000001ec, 0x00000002, 0x00000036,
0x00050051, 0x00000006, 0x000001ef, 0x000001ee, 0x00000000, 0x00050085, 0x00000006, 0x000001f2,
0x000001ef, 0x00000149, 0x00050083, 0x00000006, 0x000001f8, 0x000003c7, 0x000001f2, 0x00050085,
0x00000006, 0x000001fd, 0x0000014a, 0x000001fc, 0x00050081, 0x00000006, 0x000001fe, 0x000001fa,
0x000001fd, 0x000500ba, 0x000000b1, 0x000001ff, 0x000001f8, 0x000001fe, 0x000500b8, 0x000000b1,
0x00000202, 0x000001f8, 0x000001aa, 0x000500a7, 0x000000b1, 0x00000203, 0x000001ff, 0x00000202,
0x000300f7, 0x00000205, 0x00000000, 0x000400fa, 0x00000203, 0x00000204, 0x00000205, 0x000200f8,
0x00000204, 0x0004006f, 0x00000006, 0x00000207, 0x000003ff, 0x00050085, 0x00000006, 0x00000208,
0x00000207, 0x0000040a, 0x00050083, 0x00000006, 0x00000209, 0x00000029, 0x00000208, 0x000200f9,
0x000001bc, 0x000200f8, 0x00000205, 0x000200f9, 0x000001bd, 0x000200f8, 0x000001bd, 0x00050080,
0x00000019, 0x0000020c, 0x000003ff, 0x00000077, 0x00050081, 0x00000006, 0x0000020f, 0x00000400,
0x000001ae, 0x000200f9, 0x000001ba, 0x000200f8, 0x000001bc, 0x000b00f5, 0x00000006, 0x00000403,
0x00000110, 0x000001ba, 0x00000110, 0x000001ce, 0x00000110, 0x000001e2, 0x00000209, 0x00000204,
0x0008000c, 0x00000006, 0x00000213, 0x00000001, 0x00000031, 0x00000211, 0x0000014c, 0x0000014a,
0x00050083, 0x00000006, 0x00000214, 0x00000029, 0x00000213, 0x00060041, 0x00000037, 0x00000216,
0x00000035, 0x00000036, 0x00000166, 0x0004003d, 0x00000006, 0x00000217, 0x00000216, 0x00050085,
0x00000006, 0x00000219, 0x00000217, 0x00000403, 0x00050085, 0x00000006, 0x0000021b, 0x00000219,
0x00000214, 0x00050085, 0x00000006, 0x0000021d, 0x0000021b, 0x00000194, 0x00050085, 0x00000006,
0x0000021f, 0x0000021d, 0x000003fb, 0x00050083, 0x00000006, 0x00000220, 0x00000029, 0x0000021f,
0x000500ba, 0x000000b1, 0x00000223, 0x0000016b, 0x0000004e, 0x000300f7, 0x00000225, 0x00000000,
0x000400fa, 0x00000223, 0x00000224, 0x00000225, 0x000200f8, 0x00000224, 0x0004003d, 0x00000170,
0x00000226, 0x00000172, 0x00070050, 0x00000032, 0x00000229, 0x00000220, 0x00000220, 0x00000220,
0x00000029, 0x00040063, 0x00000226, 0x00000123, 0x00000229, 0x000200f9, 0x00000243, 0x000200f8,
0x00000225, 0x000500be, 0x000000b1, 0x0000022c, 0x00000220, 0x00000140, 0x000300f7, 0x0000022e,
0x00000000, 0x000400fa, 0x0000022c, 0x0000022d, 0x0000022e, 0x000200f8, 0x0000022d, 0x000200f9,
0x00000243, 0x000200f8, 0x0000022e, 0x0004003d, 0x00000170, 0x00000232, 0x00000172, 0x00050062,
0x00000032, 0x00000234, 0x00000232, 0x00000123, 0x0004003d, 0x00000170, 0x00000235, 0x00000172,
0x0008004f, 0x0000000a, 0x00000238, 0x00000234, 0x00000234, 0x00000000, 0x00000001, 0x00000002,
0x0005008e, 0x0000000a, 0x0000023a, 0x00000238, 0x00000220, 0x00050051, 0x00000006, 0x0000023c,
0x00000234, 0x00000003, 0x00050051, 0x00000006, 0x0000023d, 0x0000023a, 0x00000000, 0x00050051,
0x00000006, 0x0000023e, 0x0000023a, 0x00000001, 0x00050051, 0x00000006, 0x0000023f, 0x0000023a,
0x00000002, 0x00070050, 0x00000032, 0x00000240, 0x0000023d, 0x0000023e, 0x0000023f, 0x0000023c,
0x00040063, 0x00000235, 0x00000123, 0x00000240, 0x000200f9, 0x00000243, 0x000200f8, 0x00000243,
0x000100fd, 0x00010038,
};
+32 -4
View File
@@ -18,7 +18,11 @@ typedef struct __attribute__((aligned(16))) Cpu {
uint64_t fpcr; // 320: guest FPCR/FPSR (portable FP/SIMD lowering only; the asm path uses the host's)
uint64_t fpsr; // 328
uint64_t excl_val_hi; // 336: upper half of a 128-bit exclusive pair (LDXP/LDAXP of two X registers)
uint8_t _pad[512 - 344];
uint64_t _pad0; // 344
float fp_th_s[4]; // 352: FP result check threshold, every lane (rt_fpcr_threshold, runtime/simd_fp.h FOKT)
double fp_th_d[2]; // 368
__uint128_t fp_arg[3]; // 384: operands of a vector FP op handed to its slow path (runtime/simd_fp.h FN(vredo))
uint8_t _pad[512 - 432];
__uint128_t v[32]; // 512
} Cpu;
@@ -27,6 +31,8 @@ _Static_assert(offsetof(Cpu, pc) == 264, "pc");
_Static_assert(offsetof(Cpu, nzcv) == 272, "nzcv");
_Static_assert(offsetof(Cpu, fpcr) == 320, "fpcr");
_Static_assert(offsetof(Cpu, fpsr) == 328, "fpsr");
_Static_assert(offsetof(Cpu, fp_th_s) == 352 && offsetof(Cpu, fp_th_d) == 368, "fp_th");
_Static_assert(offsetof(Cpu, fp_arg) == 384, "fp_arg");
_Static_assert(offsetof(Cpu, v) == 512, "v");
typedef void (*GuestFn)(Cpu *);
@@ -39,12 +45,24 @@ void rt_brk(Cpu *c, uint32_t imm, uint64_t pc) __attribute__((noreturn));
void rt_udf(Cpu *c, uint64_t pc) __attribute__((noreturn));
uint64_t rt_ticks(void);
// The FP fast paths of runtime/simd_fp.h test FPCR.RMode and the result in one compare: a result is good when its
// magnitude differs from c->fp_th_*. In round-to-nearest the threshold is the smallest normal, so NaN and +-smallest
// normal fail as before; under a directed RMode it is NaN, both compares are unordered and every result goes through
// the redo path, which rounds in the FPCR mode. It must follow every change of c->fpcr: rt_fpcr_sync sets it, and so
// does code that creates a Cpu or copies fpcr into one. A zeroed threshold is wrong, not merely slow: it passes
// +-smallest normal.
static inline void rt_fpcr_threshold(Cpu *c) {
int directed = (c->fpcr & (3u << 22)) != 0;
for (int i = 0; i < 4; i++) c->fp_th_s[i] = directed ? __builtin_nanf("") : 0x1p-126f;
for (int i = 0; i < 2; i++) c->fp_th_d[i] = directed ? __builtin_nan("") : 0x1p-1022;
}
#if defined(__aarch64__)
static inline uint64_t rt_get_fpcr(void) { uint64_t v; __asm__ volatile("mrs %0, fpcr" : "=r"(v)); return v; }
static inline uint64_t rt_get_fpsr(void) { uint64_t v; __asm__ volatile("mrs %0, fpsr" : "=r"(v)); return v; }
static inline void rt_set_fpcr(uint64_t v) { __asm__ volatile("msr fpcr, %0" :: "r"(v)); }
static inline void rt_set_fpsr(uint64_t v) { __asm__ volatile("msr fpsr, %0" :: "r"(v)); }
static inline void rt_fpcr_sync(const Cpu *c) { (void)c; }
static inline void rt_fpcr_sync(Cpu *c) { rt_fpcr_threshold(c); }
#else
// Host FP state is not the guest's here: code lifted with --simd=c keeps FPCR/FPSR in Cpu (c->fpcr, zeroed
// with the Cpu), so the host-side reset in thread start-up has nothing to do.
@@ -56,12 +74,20 @@ static inline void rt_set_fpsr(uint64_t v) { (void)v; }
// the slow paths of runtime/simd.h, which switch RC around one operation). The FP helpers rely on it without checking,
// so it is set wherever FPCR or the host FP context changes: MSR FPCR (recomp/lifter.py), rt_call (thread and fiber
// entry, host code calling guest code), fiber resume (runtime/kernel.c fiber_resumed; fibers keep their own MXCSR).
static inline void rt_fpcr_sync(const Cpu *c) {
// It also sets the FP result check threshold (rt_fpcr_threshold).
static inline void rt_fpcr_sync(Cpu *c) {
rt_fpcr_threshold(c);
unsigned cur = __builtin_ia32_stmxcsr();
unsigned want = (cur & ~0xE040u) | (c->fpcr & (1u << 24) ? 0x8040u : 0); // FTZ 0x8000, DAZ 0x40, RC 0x6000
if (cur != want) __builtin_ia32_ldmxcsr(want);
}
#endif
// MSR FPCR (recomp/lifter.py): the first guest write of a directed rounding mode (FPCR.RMode, bits 22-23) is logged
// once with the caller (main.c rt_fpcr_rmode), to learn whether the game ever leaves round-to-nearest. A test of the
// value just stored, at the MSR sites only.
void rt_fpcr_rmode(uint64_t fpcr, uint64_t lr);
#define RT_FPCR_NOTE(c, lr) \
do { if (__builtin_expect((c)->fpcr & (3ull << 22), 0)) rt_fpcr_rmode((c)->fpcr, lr); } while (0)
// ---- memory: guest addresses are host addresses
typedef uint16_t __attribute__((aligned(1), may_alias)) u16u;
@@ -69,7 +95,9 @@ typedef uint32_t __attribute__((aligned(1), may_alias)) u32u;
typedef uint64_t __attribute__((aligned(1), may_alias)) u64u;
typedef uint8_t __attribute__((may_alias)) u8a;
// Function-entry profiler (runtime/fnprof.c, LARECOMP_FNPROF): one predictable branch per call when off.
// Function-entry hook: one predictable branch per call while g_fnprof is 0. The generator emits it only in the
// functions of the patch table's `hook` lines (recomp/patches.py), or in every function for a table without any and
// with gen.py --fn-enter-all.
extern volatile int g_fnprof;
void fnprof_hit(uint64_t addr, uint64_t lr, uint64_t x0);
#define FN_ENTER(a) do { if (__builtin_expect(g_fnprof, 0)) fnprof_hit(a, c->x[30], c->x[0]); } while (0)
+89
View File
@@ -0,0 +1,89 @@
// The mouse pointer's image in the game window while the cursor is not captured (the game's menus, the settings menu):
// a gold arrowhead with a notched back, a dark outline, a turquoise gem and a soft shadow, drawn here at the size the
// window's DPI asks for instead of the Windows arrow. input_win.c and input_sdl.c make the system cursor from it.
// Nothing comes from the game's files.
#include <math.h>
#include <stdint.h>
#include "input_wsys.h"
typedef struct { float x, y; } V;
// In units of a 32-pixel cursor: the tip at the top left (the hotspot), the wings to the right and below, the notch
// between them
static const V SHAPE[] = {{1.5f, 1.5f}, {25.0f, 10.5f}, {14.5f, 14.5f}, {10.5f, 25.0f}};
static const V GEM[] = {{10.4f, 7.6f}, {13.0f, 10.2f}, {10.4f, 12.8f}, {7.8f, 10.2f}};
#define OUTLINE 1.7f // the dark edge's width
#define SHADOW 1.6f // the shadow's offset to the bottom right
static float seg_dist(V p, V a, V b) {
float dx = b.x - a.x, dy = b.y - a.y, t = ((p.x - a.x) * dx + (p.y - a.y) * dy) / (dx * dx + dy * dy);
t = t < 0 ? 0 : t > 1 ? 1 : t;
float ex = a.x + t * dx - p.x, ey = a.y + t * dy - p.y;
return sqrtf(ex * ex + ey * ey);
}
// Distance to the polygon's edge, negative inside (even-odd: the shapes are simple)
static float poly_sdf(V p, const V *v, int n) {
float d = 1e9f;
int in = 0;
for (int i = 0, j = n - 1; i < n; j = i++) {
float e = seg_dist(p, v[j], v[i]);
if (e < d) d = e;
if ((v[i].y > p.y) != (v[j].y > p.y) && p.x < (v[j].x - v[i].x) * (p.y - v[i].y) / (v[j].y - v[i].y) + v[i].x)
in = !in;
}
return in ? -d : d;
}
// One sample's colour (straight r, g, b in 0..1) and coverage
static float sample(V p, float *r, float *g, float *b) {
float d = poly_sdf(p, SHAPE, 4);
if (d < 0) {
if (-d < OUTLINE) { *r = 0.17f, *g = 0.11f, *b = 0.04f; return 1; }
if (poly_sdf(p, GEM, 4) < 0) { // the gem, lighter towards its top left
float t = (p.x + p.y - 20.4f) / 5.2f + 0.5f;
t = t < 0 ? 0 : t > 1 ? 1 : t;
*r = 0.62f - 0.42f * t, *g = 0.98f - 0.22f * t, *b = 0.92f - 0.12f * t;
return 1;
}
// gold, pale at the tip and deeper at the wings; a thin light line inside the outline
float t = (p.x + p.y) / 34.0f;
t = t < 0 ? 0 : t > 1 ? 1 : t;
float rim = -d < OUTLINE + 1.0f ? 0.12f : 0;
*r = fminf(1, 1.00f - 0.12f * t + rim), *g = fminf(1, 0.93f - 0.32f * t + rim),
*b = fminf(1, 0.70f - 0.52f * t + rim);
return 1;
}
V s = {p.x - SHADOW, p.y - SHADOW};
float ds = poly_sdf(s, SHAPE, 4);
if (ds < 0.8f) { // the shadow, soft at its edge
*r = *g = *b = 0;
float a = ds < -0.8f ? 1 : (0.8f - ds) / 1.6f;
return 0.38f * a;
}
return 0;
}
void cursor_art(uint32_t *argb, int size, int *hot) {
float k = 32.0f / (float)size;
enum { SS = 4 }; // 4 x 4 samples a pixel
for (int y = 0; y < size; y++)
for (int x = 0; x < size; x++) {
float r = 0, g = 0, b = 0, a = 0;
for (int sy = 0; sy < SS; sy++)
for (int sx = 0; sx < SS; sx++) {
V p = {(x + (sx + 0.5f) / SS) * k, (y + (sy + 0.5f) / SS) * k};
float sr, sg, sb, c = sample(p, &sr, &sg, &sb);
r += sr * c, g += sg * c, b += sb * c, a += c;
}
uint32_t px = 0;
if (a > 0) { // straight alpha, as Windows and SDL take it
r /= a, g /= a, b /= a, a /= SS * SS;
px = (uint32_t)lrintf(a * 255) << 24 | (uint32_t)lrintf(r * 255) << 16 |
(uint32_t)lrintf(g * 255) << 8 | (uint32_t)lrintf(b * 255);
}
argb[y * size + x] = px;
}
*hot = (int)(1.5f / k);
}
+15
View File
@@ -214,6 +214,21 @@ void rt_dispatch(Cpu *c) {
__attribute__((musttail)) return f(c);
}
// The plugin trace (plugin_init.c, TOTK_PLUGIN_TRACE): the slot of the function start a runs fn from now on. Once per
// traced function, before the game's code runs; the hot path stays as it is. 0 when a is no function start of the
// table or fn lies out of the reach of a slot's 32-bit offset.
int rt_dispatch_reroute(uint64_t a, GuestFn fn) {
uint64_t i = (a - D.lo) >> 2;
if (!g_ready || (a & 3) || a < D.lo || i >= D.slots || !D.slot[i]) return 0;
uintptr_t f = (uintptr_t)fn;
if (f <= D.anchor || f - D.anchor > UINT32_MAX) return 0;
uint64_t page = (uint64_t)(uintptr_t)&D.slot[i] & ~0xFFFull;
if (!plat_mem_protect(page, 0x1000, PLAT_PROT_RW)) return 0;
((uint32_t *)D.slot)[i] = (uint32_t)(f - D.anchor); // the table is sealed read-only, unsealed above
plat_mem_protect(page, 0x1000, PLAT_PROT_READ);
return 1;
}
RtDispatchStats rt_dispatch_stats(void) {
return (RtDispatchStats){D.lo, D.lo + D.slots * 4, D.slots, g_table_bytes, g_functions, g_nhost};
}
+5 -2
View File
@@ -19,8 +19,10 @@ typedef struct RtModule {
} RtModule;
// The module glue that tools/build_game.py writes for each build (build/<version>/modules.c), from layout.json and
// layout.h: every module of the layout, and the modules linked into this executable.
typedef struct RtLayoutEntry { const char *name; uint64_t base, size; } RtLayoutEntry;
// layout.h: every module of the layout, and the modules linked into this executable. A mod's code module
// (recomp/layout.py plugin<N>, after sdk) also names its NSO file and that file's SHA-256; a game module has NULL there
// and is read from the ExeFS directory.
typedef struct RtLayoutEntry { const char *name; uint64_t base, size; const char *file, *sha256; } RtLayoutEntry;
extern const RtLayoutEntry rt_layout[];
extern const int rt_layout_count;
int rt_linked_modules(RtModule *out, int max);
@@ -36,6 +38,7 @@ void rt_dispatch_init(const RtModule *mods, int count);
// The host function for a guest address, or NULL when nothing is there. Does not run guest code.
GuestFn rt_dispatch_lookup(uint64_t pc);
int rt_dispatch_reroute(uint64_t a, GuestFn fn); // plugin trace only (dispatch.c); 0 when it cannot
// "0x7000001234 (main+0x1234)" for a guest address inside a module, else the bare address. Returns buf.
const char *rt_guest_name(uint64_t pc, char *buf, int size);
+16 -4
View File
@@ -91,6 +91,11 @@ void frame_step_init(void) {
rt_patch_disable(cloth);
rt_log("frame rate: cloth clock off, it needs the real-time step (TOTK_REALTIME=0)");
}
int climb = rt_patch_set("climb"); // reads the page's frame ratio, written only with the real-time step
if (climb >= 0 && !rt_patch_enabled(realtime) && rt_patch_enabled(climb)) {
rt_patch_disable(climb);
rt_log("frame rate: climb speed fix off, it needs the real-time step (TOTK_REALTIME=0)");
}
if (rt_patch_enabled(realtime)) {
step_word = (_Atomic uint64_t *)rt_patch_page();
step_interval = (_Atomic uint32_t *)((uint8_t *)rt_patch_page() + 8);
@@ -155,6 +160,11 @@ uint64_t frame_step_cap_ns(void) {
double hz = limit_hz ? limit_hz : gfx_window_refresh_hz();
if (hz < LIMIT_MIN_HZ) hz = 60; // display rate unknown (no window yet)
if (hz > LIMIT_MAX_HZ) hz = LIMIT_MAX_HZ;
// Frame generation (vk_backend.c present_pair) shows two pictures for each frame the game draws: the limit counts
// the pictures shown and the game draws half, 30 at least (Savage Wind's framepace_period_ns, PR #1089). Only
// while the last frame went out with a generated picture: a menu or a fade, which has none, keeps the whole limit.
// The real-time step follows the game's presents (frame_step_present), so it is the drawn frames' interval.
if (gfx_frame_gen_live()) hz = hz / 2 < LIMIT_MIN_HZ ? LIMIT_MIN_HZ : hz / 2;
return (uint64_t)(1e9 / hz + 0.5);
}
@@ -180,14 +190,16 @@ static uint64_t read_ptr(uint64_t a) {
uint64_t p = 0;
return read_guest(a, &p, 8) ? p : 0;
}
// 1.2.1: [main+0x4728538] (1.1.0: [main+0x4630a68], 1.4.3: [main+0x3add238]) +0x1e8 scene, its component 13 lists the
// 1.2.1: [main+0x4728538] (1.1.0: [[main+0x4630a68]], 1.4.3: [main+0x3add238]) +0x1e8 scene, its component 13 lists the
// resident actors; the one named "Player" has its position at +0x2b4 (MacNativeGames world_survey.c, game_version.h
// TOTK_GAME_V121/V143). The 1.1.0 slot was measured from its own dereference chain: 181 scene accesses in that build
// read it, and one of them reproduces this walk (the 14-component check, component 13, the 0x70 stride and the name
// compare) instruction for instruction.
// compare) instruction for instruction. Its slot is a GOT entry pointing to the singleton's storage, so it needs
// one more dereference than the direct singleton slots of 1.2.1 and 1.4.3.
static int player_pos(float xyz[3]) {
uint64_t module = read_ptr(MOD_MAIN_BASE + (RT_V143 ? 0x3add238 : RT_V110 ? 0x4630a68 : 0x4728538)),
scene = module ? read_ptr(module + 0x1e8) : 0;
uint64_t module = read_ptr(MOD_MAIN_BASE + (RT_V143 ? 0x3add238 : RT_V110 ? 0x4630a68 : 0x4728538));
if (RT_V110) module = read_ptr(module);
uint64_t scene = module ? read_ptr(module + 0x1e8) : 0;
int32_t count = 0;
if (!scene || !read_guest(scene + 0x50, &count, 4) || count < 14 || count > 256) return 0;
uint64_t comps = read_ptr(scene + 0x58), resident = comps ? read_ptr(comps + 13 * 8) : 0;
+264
View File
@@ -0,0 +1,264 @@
// Free camera for TotK 1.4.3: the view leaves Link and flies with the gamepad while the game goes on (docs/controls.md,
// "Free camera").
//
// The camera component update (main+0x628460, called with the component as x0 = x19 from main+0x627dc8, the camera
// actor's component array +0x228, slot +0x270) copies the component's pose into its sead camera and builds the view
// matrix from it. Component fields (doubles unless noted): eye +0xe8, target +0x110, up +0x128 (floats), then near,
// far, vertical view angle and aspect +0x134..+0x140 (the fov and aspect sets of recomp/patches-v143.txt load the last
// two). Two one-shot overrides come after: a non-zero eye at +0x180 or target at +0x198 replaces the pose for that
// update and is cleared (main+0x628fdc, main+0x629004). Additive offsets follow at +0x1b0 (flag) / +0x1c0 (eye),
// +0x1d8 / +0x1e8 (target) and +0x200 (up, three floats, applied when any is non-zero and never cleared by the game).
//
// The freecam set's one site (main+0x6286d4, `ldr x8, [x19, #0x18]`, the first instruction every path to the pose
// copy runs) calls freecam_hook, which performs that load and, while the free camera is on, writes the overrides.
// The game's own eye and target stay as they were, so the game camera takes over the update after the hook stops.
// The up offset is the game's state: the hook keeps the component's value and puts it back when the free camera ends,
// and makes the up vector the world's +Y meanwhile, so the horizon stays level.
//
// Which components: a 1.4.3 frame updates three. Two share the player camera's pose (both must move, or the scene
// and what follows the second disagree); the third rests at the default pose, eye (0, 0, 10) towards the origin. The
// first component seen away from that default anchors the pick, and every component whose eye is within MATCH_M of
// the anchor is driven. When no driven component has been updated for LOST_NS (a load replaced them) the next one
// away from the default anchors again; the free camera keeps its own position.
//
// Input (runtime/input.c freecam_gate): TOTK_FREECAM_PAD or TOTK_FREECAM_KEY steps it off, move, lock and off again
// (both none by default, so the player opts in). While it moves the game gets no input; the left stick flies along the
// view and to the side, ZR and ZL straight up and down, the right stick and the mouse turn, and each press of L or R
// halves or doubles the speed. Keys work through their bindings: the keys' sticks, and the keys bound to ZL, ZR, L and
// R. Every driven component steps the flight by the wall-clock time since the last step, so the speed is the same at
// any frame rate and game speed. Locked, the view stays where the flight left it and the game gets its input back.
// The game steers Link by the camera it draws, which takes the overrides, so Link walks where the stick points on
// screen with the stick as it is.
#include <math.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "cfg.h"
#include "host.h"
#include "input.h"
#include "platform/platform.h"
#if __has_include("patches.h")
#include "patches.h"
#endif
#define SPEED_START 8.0 // metres a second at full deflection
#define SPEED_MIN 0.25 // 8 m/s halved five times
#define SPEED_MAX 512.0 // 8 m/s doubled six times
#define TURN_DEG_S 110.0 // the right stick's turn rate at full deflection
#define PITCH_MAX_DEG 85.0 // short of straight up or down, where the view's up vector would fail
#define TARGET_M 10.0 // the target's distance in front of the eye
#define MATCH_M 2.0
#define LOST_NS 500000000ull
#define STEP_MAX_S 0.1 // a longer gap (a load, a hitch) moves the camera no further than this
#define MAX_DRIVEN 8
static PlatMutex pad_lock = PLAT_MUTEX_INIT;
static FreecamPad pad_now; // the last poll's input (input thread), under pad_lock
static int speed_clicks; // R presses minus L presses not yet applied (input thread adds, the hook takes)
static double mouse_deg[2]; // under pad_lock: mouse turn not yet applied, degrees (right +, down +)
// + 1 at every switch (input thread); modulo 3 the stage (FREECAM_OFF, _MOVE, _LOCK). One value, so the hook never
// sees a switch without the stage it switched to.
static unsigned generation;
int freecam_state(void) { return __atomic_load_n(&generation, __ATOMIC_ACQUIRE) % 3; }
void freecam_pad(const FreecamPad *p) {
plat_mutex_lock(&pad_lock);
pad_now = *p;
plat_mutex_unlock(&pad_lock);
}
void freecam_mouse(double right_deg, double down_deg) {
plat_mutex_lock(&pad_lock);
mouse_deg[0] += right_deg;
mouse_deg[1] += down_deg;
plat_mutex_unlock(&pad_lock);
}
void freecam_speed_click(int faster) { __atomic_add_fetch(&speed_clicks, faster ? 1 : -1, __ATOMIC_RELAXED); }
#ifdef RT_PATCH_PAGE
#define HOST_FREECAM (RT_PATCH_PAGE + 0xf50)
enum {
OFF_LINK = 0x18, OFF_EYE = 0xe8, OFF_TARGET = 0x110, OFF_UP = 0x128,
OFF_EYE_OVERRIDE = 0x180, OFF_TARGET_OVERRIDE = 0x198, OFF_UP_OFFSET = 0x200,
SPAN = OFF_UP_OFFSET + 12 - OFF_EYE, // the fields the hook reads and writes, from OFF_EYE
};
int freecam_available(void) { return rt_game_version == 143 && rt_patch_enabled(rt_patch_set("freecam")); }
void freecam_cycle(void) {
unsigned gen = __atomic_add_fetch(&generation, 1, __ATOMIC_ACQ_REL);
static const char *const names[] = {"off", "move", "lock"};
rt_log("freecam: %s", names[gen % 3]);
}
// Game thread only (the camera update runs on one thread). A component stays listed from its first drive until its
// up offset is put back (the first update after the switch goes off) or, while off, until it has gone LOST_NS
// without an update (freed by a load).
static struct {
unsigned flight; // (generation + 2) / 3: the same from move through lock, new at the next move
int started; // pos, yaw and pitch hold a pose
double pos[3], yaw, pitch, speed; // radians; yaw 0 looks along +Z, pitch > 0 up
uint64_t last_step, anchor_seen;
int anchored; // anchor holds the eye of the components being driven
double anchor[3];
int n;
struct { uint64_t cam, seen; float up_offset[3]; } driven[MAX_DRIVEN];
} fc;
static void read3(uint64_t at, double v[3]) { memcpy(v, (const void *)(uintptr_t)at, 3 * sizeof(double)); }
static void write3(uint64_t at, const double v[3]) { memcpy((void *)(uintptr_t)at, v, 3 * sizeof(double)); }
static int at_default(const double eye[3], const double target[3]) {
return eye[0] == 0 && eye[1] == 0 && eye[2] == 10 && target[0] == 0 && target[1] == 0 && target[2] == 0;
}
static void direction(double d[3]) {
d[0] = sin(fc.yaw) * cos(fc.pitch);
d[1] = sin(fc.pitch);
d[2] = cos(fc.yaw) * cos(fc.pitch);
}
static int driven_index(uint64_t cam) {
for (int i = 0; i < fc.n; i++)
if (fc.driven[i].cam == cam) return i;
return -1;
}
static void drop(int i) { fc.driven[i] = fc.driven[--fc.n]; }
// The free camera starts where the game camera is: its eye, looking at its target.
static void start(const double eye[3], const double target[3], uint64_t now) {
double d[3] = {target[0] - eye[0], target[1] - eye[1], target[2] - eye[2]};
double len = sqrt(d[0] * d[0] + d[1] * d[1] + d[2] * d[2]);
memcpy(fc.pos, eye, sizeof fc.pos);
fc.yaw = len > 1e-6 ? atan2(d[0], d[2]) : 0;
fc.pitch = len > 1e-6 ? asin(fmax(-1.0, fmin(1.0, d[1] / len))) : 0;
fc.started = 1;
fc.last_step = now;
rt_log("freecam: starting at (%.1f %.1f %.1f)", eye[0], eye[1], eye[2]);
}
// A new component joins while it shares the anchor's eye; the first one away from the default pose sets the anchor.
static int pick(uint64_t cam, const double eye[3], const double target[3]) {
if (at_default(eye, target)) return -1;
if (fc.anchored) {
double dx = eye[0] - fc.anchor[0], dy = eye[1] - fc.anchor[1], dz = eye[2] - fc.anchor[2];
if (dx * dx + dy * dy + dz * dz > MATCH_M * MATCH_M) return -1;
} else {
memcpy(fc.anchor, eye, sizeof fc.anchor);
fc.anchored = 1;
}
if (fc.n == MAX_DRIVEN) { // full after several loads: the one unseen longest was freed by a load
int oldest = 0;
for (int k = 1; k < fc.n; k++)
if (fc.driven[k].seen < fc.driven[oldest].seen) oldest = k;
drop(oldest);
}
int i = fc.n++;
fc.driven[i].cam = cam;
memcpy(fc.driven[i].up_offset, (const void *)(uintptr_t)(cam + OFF_UP_OFFSET), sizeof fc.driven[i].up_offset);
rt_log("freecam: driving camera component %#llx", (unsigned long long)cam);
return i;
}
static double axis(float v) { return v > 1 ? 1 : v < -1 ? -1 : v; }
// Flight since the last step: L and R presses scale the speed, the right stick turns, the left stick moves along the
// view and to the side, the triggers along the world's up.
// Every driven component steps; the second one of a frame comes microseconds after the first and moves that little.
static void step(uint64_t now) {
double dt = (now - fc.last_step) / 1e9;
fc.last_step = now;
if (dt <= 0) return;
if (dt > STEP_MAX_S) dt = STEP_MAX_S;
FreecamPad p;
double mouse[2];
plat_mutex_lock(&pad_lock);
p = pad_now;
mouse[0] = mouse_deg[0], mouse[1] = mouse_deg[1];
mouse_deg[0] = mouse_deg[1] = 0;
plat_mutex_unlock(&pad_lock);
int clicks = __atomic_exchange_n(&speed_clicks, 0, __ATOMIC_RELAXED);
if (clicks) {
fc.speed *= exp2(clicks);
fc.speed = fc.speed < SPEED_MIN ? SPEED_MIN : fc.speed > SPEED_MAX ? SPEED_MAX : fc.speed;
}
double turn = TURN_DEG_S * M_PI / 180 * dt, limit = PITCH_MAX_DEG * M_PI / 180;
// right turns towards -yaw (see right[] below); the mouse's degrees come on top of the stick's
fc.yaw = remainder(fc.yaw - axis(p.rx) * turn - mouse[0] * M_PI / 180, 2 * M_PI);
fc.pitch += axis(p.ry) * turn - mouse[1] * M_PI / 180;
fc.pitch = fc.pitch > limit ? limit : fc.pitch < -limit ? -limit : fc.pitch;
double d[3], right[3];
direction(d);
// world +Y up, right-handed: right = d x Y, level
double rl = sqrt(d[0] * d[0] + d[2] * d[2]);
right[0] = -d[2] / rl, right[1] = 0, right[2] = d[0] / rl;
double fwd = axis(p.ly), side = axis(p.lx), lift = axis(p.rt) - axis(p.lt), dist = fc.speed * dt;
for (int k = 0; k < 3; k++) fc.pos[k] += (d[k] * fwd + right[k] * side) * dist;
fc.pos[1] += lift * dist;
}
static void drive(uint64_t cam) {
double d[3], target[3];
direction(d);
for (int k = 0; k < 3; k++) target[k] = fc.pos[k] + d[k] * TARGET_M;
write3(cam + OFF_EYE_OVERRIDE, fc.pos);
write3(cam + OFF_TARGET_OVERRIDE, target);
// up + offset = +Y: the game adds the offset to its up vector before it builds the view
float up[3], offset[3];
memcpy(up, (const void *)(uintptr_t)(cam + OFF_UP), sizeof up);
offset[0] = -up[0], offset[1] = 1.0f - up[1], offset[2] = -up[2];
if (offset[0] == 0 && offset[1] == 0 && offset[2] == 0) offset[1] = 1e-6f; // all zero would skip the offset
memcpy((void *)(uintptr_t)(cam + OFF_UP_OFFSET), offset, sizeof offset);
}
// The site's own instruction first: x8 = [x19 + 0x18]. x19 is the camera component (read only: the lifter keeps
// X19-X29 in locals across a host call).
static void freecam_hook(Cpu *c) {
uint64_t cam = c->x[19];
memcpy(&c->x[8], (const void *)(uintptr_t)(cam + OFF_LINK), sizeof c->x[8]);
unsigned gen = __atomic_load_n(&generation, __ATOMIC_ACQUIRE);
int state = gen % 3, active = state != FREECAM_OFF;
if (!active && !fc.n) return; // the common case: one load, a division and two compares
if ((gen + 2) / 3 != fc.flight) { // a new flight starts at the game camera, at the start speed
fc.flight = (gen + 2) / 3;
fc.started = 0, fc.anchored = 0, fc.speed = SPEED_START;
plat_mutex_lock(&pad_lock); // mouse motion from before the switch does not turn the new flight
mouse_deg[0] = mouse_deg[1] = 0;
plat_mutex_unlock(&pad_lock);
}
uint64_t now = plat_now_ns();
int i = driven_index(cam);
if (!active) {
if (i >= 0) {
memcpy((void *)(uintptr_t)(cam + OFF_UP_OFFSET), fc.driven[i].up_offset, sizeof fc.driven[i].up_offset);
drop(i);
}
for (int k = fc.n - 1; k >= 0; k--)
if (now - fc.driven[k].seen > LOST_NS) drop(k); // freed by a load while it waited
return;
}
if (!mem_guest_readable(cam + OFF_EYE, SPAN)) return;
if (fc.anchored && now - fc.anchor_seen > LOST_NS) fc.anchored = 0; // a load replaced the components
double eye[3], target[3];
read3(cam + OFF_EYE, eye);
read3(cam + OFF_TARGET, target);
if (i < 0 && (i = pick(cam, eye, target)) < 0) return;
if (!fc.started) start(eye, target, now);
fc.driven[i].seen = fc.anchor_seen = now;
if (state == FREECAM_MOVE) step(now); // locked, the view holds its pose
drive(cam);
}
__attribute__((constructor)) static void freecam_register(void) {
if (rt_game_version == 143) rt_register_host(HOST_FREECAM, freecam_hook);
}
#else
int freecam_available(void) { return 0; }
void freecam_cycle(void) {}
#endif
+19
View File
@@ -47,6 +47,19 @@ enum { ROMFS_PROMPTS_OK, ROMFS_PROMPTS_MISSING, ROMFS_PROMPTS_FAILED, ROMFS_PROM
ROMFS_PROMPTS_PATCHES };
const char *romfs_prompts(void);
int romfs_prompts_ready(const char *folder);
// The folders a start at game resolution w x h with prompts_folder (input_prompts_folder; NULL for the game's own
// prompts) and the selected HUD width needs and that have no manifest: ROMFS_NEED_PROMPTS, prompts_folder itself (16:9);
// at another shape (res_wants_wide_overlay) ROMFS_NEED_LAYOUT, its romfs-patches-<w>x<h>[-hud..], and
// ROMFS_NEED_SHAPED_PROMPTS, <prompts_folder>-<w>x<h>[-hud..]. A full-layout fallback does not satisfy a requested HUD
// cap. 0 with TOTK_ROMFS_PATCHES set.
enum { ROMFS_NEED_LAYOUT = 1, ROMFS_NEED_PROMPTS = 2, ROMFS_NEED_SHAPED_PROMPTS = 4 };
int romfs_folders_missing(unsigned w, unsigned h, const char *prompts_folder);
// 1 when build-cache/rebuild.txt names the setup's Python and tools/make_romfs_patches.py and both exist, with romfs/.
int romfs_folders_can_prepare(void);
// Starts the generator for each folder romfs_folders_missing names, once per folder in this process, as child
// processes the game does not wait for; the next start loads the result. 1 when every one runs, 0 when none was
// missing, the tools are not there or one could not start.
int romfs_folders_prepare(unsigned w, unsigned h, const char *prompts_folder);
int romfs_prompts_off(const char *folder);
const char *romfs_overlay(size_t k, const char **file, uint64_t *size, int *is_added); // RomFS path of overlay k
void fs_trace(const char *what, const char *path); // TOTK_TRACE=fs: one line per open
@@ -58,3 +71,9 @@ int fs_save_busy(void); // a save is being wr
// or save data changed in the last 3 s and not committed
void fs_save_flush(void); // wait for a save Commit still running in the background;
// every exit path calls it before the process ends
uint32_t fs_save_commits(char *slot, size_t cap); // commits that changed save files; slot: the save folder
// (slot_00 ...) the last one wrote first
int fs_save_copy_slot(const char *slot, const char *dst); // a folder of the newest save copied to dst (replaced)
void fs_save_read_from(const char *dir); // quick load: reads of save:/slot_NN/<file> open dir/<file>
// while dir is set; NULL ends it
int fs_save_read_from_hits(void); // opens redirected since the last fs_save_read_from(dir)
+74 -1
View File
@@ -281,6 +281,18 @@ static int same_file(const char *a, const char *b) {
return same;
}
// The folder of the save (slot_00 ...) whose file the running commit wrote first, for quick save (fs_save_commits):
// note_changed takes the first path component under new_root of each file copy_tree copies instead of linking.
static char changed_slot[64], last_slot[64];
static uint32_t commits; // commits that changed a file, under tx_lock
static void note_changed(const char *dst) {
size_t n = strlen(new_root);
if (changed_slot[0] || !n || strncmp(dst, new_root, n) || dst[n] != '/') return;
const char *rel = dst + n + 1, *sl = strchr(rel, '/');
size_t len = sl ? (size_t)(sl - rel) : sizeof changed_slot;
if (len < sizeof changed_slot) memcpy(changed_slot, rel, len), changed_slot[len] = 0;
}
// Copy the tree src to dst, which must not exist; links are skipped. durable: every file is flushed, and every
// directory as far as the file system allows. base (or NULL): the committed save; a file whose bytes equal base's file
// at the same path becomes a hard link to it instead of a copy (*nlinked), as committed files are never written in
@@ -300,7 +312,7 @@ static int copy_tree(const char *src, const char *dst, const char *base, int dur
if (l.e[i].kind == PLAT_FS_DIR) bad = copy_tree(s, d, b, durable, nfiles, nlinked, bytes);
else {
if (b && same_file(s, b) && !plat_fs_link(b, d)) bad = 0, ++*nlinked;
else bad = copy_file(s, d, durable, bytes);
else bad = copy_file(s, d, durable, bytes), note_changed(d);
*nfiles += !bad;
if (!bad && durable && crashed()) bad = -1;
}
@@ -509,6 +521,7 @@ static uint32_t save_commit_locked(void) {
int nfiles = 0, linked = 0;
tx_step = tx_dead = 0;
const char *base = exists(newest_save()) ? newest_save() : NULL;
changed_slot[0] = 0;
if (remove_tree(new_root) || copy_tree(work_root, new_root, base, 1, &nfiles, &linked, &bytes)) {
if (tx_dead) return FS_R_INVALID_ARGUMENT;
rt_log("fs: save commit: copying the working copy failed; the newest save is unchanged");
@@ -535,6 +548,8 @@ static uint32_t save_commit_locked(void) {
ready_seq++;
if (*ready_root) remove_tree(ready_root); // superseded: the working copy it was made from held all of it
snprintf(ready_root, sizeof ready_root, "%s", ready);
commits++;
memcpy(last_slot, changed_slot, sizeof last_slot);
plat_xchg32(&save_dirty, 0);
if (crashed()) return FS_R_INVALID_ARGUMENT;
int waits = swap_in();
@@ -558,6 +573,34 @@ static void save_wait_commit(void) {
void fs_save_flush(void) { save_wait_commit(); }
// ---- quick save (quicksave.c): the save folder the last commit wrote, copied out of the newest save
uint32_t fs_save_commits(char *slot, size_t cap) {
plat_mutex_lock(&tx_lock);
uint32_t n = commits;
snprintf(slot, cap, "%s", last_slot);
plat_mutex_unlock(&tx_lock);
return n;
}
// The folder slot of the newest save to dst (replaced). 0 on success.
static int slot_name_ok(const char *slot) {
return slot[0] && slot[0] != '.' && !strchr(slot, '/') && !strchr(slot, '\\') && !strchr(slot, ':');
}
int fs_save_copy_slot(const char *slot, const char *dst) {
if (!*save_root || !slot_name_ok(slot)) return -1;
save_wait_commit();
plat_mutex_lock(&tx_lock);
char *src = join(newest_save(), slot);
int n = 0, linked = 0;
uint64_t bytes = 0;
int bad = plat_fs_kind(src) != PLAT_FS_DIR || remove_tree(dst) || copy_tree(src, dst, NULL, 1, &n, &linked, &bytes);
plat_mutex_unlock(&tx_lock);
free(src);
return bad ? -1 : 0;
}
static uint32_t commit_run(void) {
plat_mutex_lock(&tx_lock);
uint32_t r = save_commit_locked();
@@ -877,6 +920,33 @@ static int64_t host_read_at(PlatFile *f, void *buf, uint32_t n, uint64_t off) {
return got < 0 ? -1 : got;
}
// Quick load (quicksave.c, fs_save_read_from): while set, a read-only open of a file of any slot folder of the save
// mount (save:/slot_NN/<file>) opens <file> of this folder instead, so the game loads the quick save whichever slot it
// was asked to load, and no slot of the save is written for it.
static char read_from[PATH_CAP];
static volatile int32_t read_from_on, read_from_hits;
void fs_save_read_from(const char *dir) {
if (dir) snprintf(read_from, sizeof read_from, "%s", dir), plat_xchg32(&read_from_hits, 0);
plat_xchg32(&read_from_on, dir != NULL);
}
int fs_save_read_from_hits(void) { return plat_cas32(&read_from_hits, 0, 0); }
static void redirect_slot_read(const char *path, char *p, size_t cap) {
const char *rest = strstr(path, ":/slot_");
if (!rest) return;
const char *d = rest + 7, *file;
while (*d >= '0' && *d <= '9') d++;
if (d == rest + 7 || *d != '/' || !d[1] || strchr(d + 1, '/')) return;
file = d + 1;
char q[PATH_CAP];
if (snprintf(q, sizeof q, "%s/%s", read_from, file) >= (int)sizeof q || plat_fs_kind(q) != PLAT_FS_FILE) return;
rt_log("fs: quick load: %s read from %s", path, q);
snprintf(p, cap, "%s", q);
plat_inc32(&read_from_hits);
}
static uint32_t open_file(uint64_t *out, const char *path, int mode) {
if (romfs_owns(path)) return romfs_open(out, path, mode);
fs_trace(mode & FS_OPEN_WRITE ? "write" : "read", path);
@@ -885,6 +955,8 @@ static uint32_t open_file(uint64_t *out, const char *path, int mode) {
int kind = M_FREE;
uint32_t r = host_path_kind(path, p, sizeof p, &kind);
if (r) return r;
if (kind == M_SAVE && !(mode & FS_OPEN_WRITE) && plat_cas32(&read_from_on, 0, 0))
redirect_slot_read(path, p, sizeof p);
if (plat_fs_kind(p) != PLAT_FS_FILE) return FS_R_PATH_NOT_FOUND;
if (kind == M_SAVE_RO && (mode & FS_OPEN_WRITE)) return FS_R_UNSUPPORTED_OPEN;
int save_writer = kind == M_SAVE && (mode & FS_OPEN_WRITE);
@@ -1770,6 +1842,7 @@ int probe_fs(void) {
pcpu = plat_aligned_alloc(sizeof(Cpu), 64);
need(pcpu != NULL, "probe Cpu");
memset(pcpu, 0, sizeof *pcpu);
rt_fpcr_threshold(pcpu);
uint8_t *stack = mem_kernel_alloc(0x10000, 16);
pcpu->sp = (uint64_t)(uintptr_t)stack + 0x10000;
pcpu->excl_addr = ~0ull;
+474
View File
@@ -0,0 +1,474 @@
// Mouse wheel and keyboard gameplay tweaks with independent live settings.
// The game's native R + D-pad object rotation and D-pad distance controls remain authoritative.
#include "gameplay_tweaks.h"
#include "cfg.h"
#include "host.h"
#include "input.h"
#include "input_map.h"
#include "input_wsys.h"
#include "platform/platform.h"
#include <limits.h>
#include <math.h>
#include <stdlib.h>
#include <string.h>
#define BIT(x) (1ull << (x))
#define HOLD_FRAMES 3
#define GAP_FRAMES 1
#define MAX_QUEUED 16
enum { NONE, ROTATE, DISTANCE, ITEMS, MAP_ZOOM, WEAPONS };
enum { W_IDLE = 0, W_PRIME, W_HOLD, W_GAP, W_WAIT };
#define WEAPON_PRIME_MIN_NS 75000000ull
#define WEAPON_PRIME_MAX_NS 135000000ull
#define WEAPON_HOLD_NS 42000000ull
#define WEAPON_GAP_NS 36000000ull
static PlatMutex lock = PLAT_MUTEX_INIT;
static unsigned seen = UINT_MAX;
static struct {
int available, rotate, c_axis, distance, wheel, keys, map_zoom, weapon_wheel;
double rotation_speed, distance_speed, item_speed, map_zoom_speed, weapon_speed;
} options;
static struct {
int kind, axis, direction, queued, hold, gap, primed, valid;
double fraction;
uint64_t frame, buttons;
int32_t rx;
} pulse;
static struct {
int active, phase, direction, scroll_dir, queued, polls_in_phase;
int confirm_pending;
double fraction;
uint64_t phase_until_ns, prime_start_ns, last_frame;
int32_t rx;
} weapon;
static double map_zoom_velocity;
static int held_a, held_d;
static int consumed_c, consumed_right;
static int was_e_down, consumed_e;
static uint64_t physical_buttons;
static void clear_weapon_locked(void) { memset(&weapon, 0, sizeof weapon); }
static void clear_locked(void) { memset(&pulse, 0, sizeof pulse); clear_weapon_locked(); map_zoom_velocity = 0; }
static void refresh_locked(void) {
unsigned version = cfg_version();
if (seen == version) return;
options.available = cfg_bool("TOTK_GAMEPLAY_TWEAKS_ENABLED");
options.rotate = cfg_bool("TOTK_GAMEPLAY_ULTRAHAND_ROTATE");
options.c_axis = cfg_bool("TOTK_GAMEPLAY_ULTRAHAND_C_AXIS");
options.distance = cfg_bool("TOTK_GAMEPLAY_ULTRAHAND_DISTANCE");
options.wheel = cfg_bool("TOTK_GAMEPLAY_ITEM_WHEEL");
options.keys = cfg_bool("TOTK_GAMEPLAY_ITEM_AD");
options.map_zoom = cfg_bool("TOTK_GAMEPLAY_MAP_ZOOM");
options.weapon_wheel = cfg_bool("TOTK_GAMEPLAY_WEAPON_WHEEL");
options.rotation_speed = cfg_double("TOTK_GAMEPLAY_ROTATION_SENSITIVITY");
options.distance_speed = cfg_double("TOTK_GAMEPLAY_DISTANCE_SENSITIVITY");
options.item_speed = cfg_double("TOTK_GAMEPLAY_ITEM_SENSITIVITY");
options.map_zoom_speed = cfg_double("TOTK_GAMEPLAY_MAP_ZOOM_SENSITIVITY");
options.weapon_speed = cfg_double("TOTK_GAMEPLAY_WEAPON_SENSITIVITY");
if (!isfinite(options.rotation_speed) || options.rotation_speed < .25 || options.rotation_speed > 4) options.rotation_speed = 1;
if (!isfinite(options.distance_speed) || options.distance_speed < .25 || options.distance_speed > 4) options.distance_speed = 1;
if (!isfinite(options.item_speed) || options.item_speed < .25 || options.item_speed > 4) options.item_speed = 1;
if (!isfinite(options.map_zoom_speed) || options.map_zoom_speed < .25 || options.map_zoom_speed > 4) options.map_zoom_speed = 1;
if (!isfinite(options.weapon_speed) || options.weapon_speed < .25 || options.weapon_speed > 4) options.weapon_speed = 1;
seen = version;
clear_locked();
}
static int item_menu(uint64_t buttons) {
if (buttons & BIT(B_L)) return 0;
const uint64_t held = BIT(B_LEFT) | BIT(B_UP) | BIT(B_RIGHT) | BIT(B_DOWN);
return input_camera_context() == INPUT_CAM_MENU_WHEEL || (buttons & held) != 0;
}
static int object_context(uint64_t buttons) {
const uint64_t menus = BIT(B_L) | BIT(B_LEFT) | BIT(B_UP) | BIT(B_RIGHT) | BIT(B_DOWN) |
BIT(B_B) | BIT(B_PLUS) | BIT(B_MINUS);
return input_camera_context() == INPUT_CAM_ULTRAHAND_OBJECT && !(buttons & menus);
}
static int map_zoom_allowed(uint64_t buttons) {
if (!options.map_zoom) return 0;
if (object_context(buttons) || item_menu(buttons)) return 0;
if (buttons & (BIT(B_L) | BIT(B_ZL) | BIT(B_ZR) | BIT(B_R))) return 0;
int ctx = input_camera_context();
if (ctx == INPUT_CAM_AIM || ctx == INPUT_CAM_SCOPE ||
ctx == INPUT_CAM_ULTRAHAND_OBJECT || ctx == INPUT_CAM_LOCK_ON) {
return 0;
}
// Only the map menu_cursor.c finds: with menu_cursor = 0 (or on 1.2.1) the map is not read, and a fallback to
// "allowed" would push the right stick's Y in free roam, where it tilts the camera.
return menu_cursor_map();
}
static int weapon_wheel_allowed(uint64_t buttons, int right_down, int already_active) {
if (!options.available || !options.weapon_wheel) return 0;
if (right_down) return 0;
if (!ikb_captured() || menu_cursor_map() || menu_cursor_pointer()) return 0;
const uint64_t forbidden = BIT(B_L) | BIT(B_R) | BIT(B_ZL) | BIT(B_ZR) |
BIT(B_LEFT) | BIT(B_UP) | BIT(B_RIGHT) | BIT(B_DOWN) |
BIT(B_PLUS) | BIT(B_MINUS);
if (buttons & forbidden) return 0;
if (!already_active) {
if (menu_cursor_shortcut() == 1 || menu_cursor_strip() || menu_cursor_camera() || menu_cursor_menu())
return 0;
}
int ctx = input_camera_context();
if (!already_active) {
// Opening needs a camera the mouse_direct hooks saw this moment: an unclassified one is also a paused menu,
// 1.2.1's menus or any screen menu_cursor.c does not read, where D-pad right and the right stick would move
// the menu instead.
if (ctx != INPUT_CAM_FREE_ROAM && ctx != INPUT_CAM_LOCK_ON && ctx != INPUT_CAM_VEHICLE)
return 0;
} else {
if (ctx != INPUT_CAM_UNCLASSIFIED && ctx != INPUT_CAM_MENU_WHEEL &&
ctx != INPUT_CAM_FREE_ROAM && ctx != INPUT_CAM_LOCK_ON && ctx != INPUT_CAM_VEHICLE)
return 0;
}
return 1;
}
int gameplay_tweaks_available(void) {
plat_mutex_lock(&lock);
refresh_locked();
int available = options.available;
plat_mutex_unlock(&lock);
return available;
}
int gameplay_tweaks_capture_needed(void) {
plat_mutex_lock(&lock);
refresh_locked();
int active = options.available && (options.rotate || options.distance || options.wheel ||
options.keys || options.map_zoom || options.weapon_wheel);
plat_mutex_unlock(&lock);
return active;
}
int gameplay_tweaks_map_zoom(void) {
plat_mutex_lock(&lock);
refresh_locked();
int active = options.available && options.map_zoom;
plat_mutex_unlock(&lock);
return active;
}
int gameplay_tweaks_strip_wheel(uint64_t buttons) {
plat_mutex_lock(&lock);
refresh_locked();
int active = options.available && (weapon.active || (options.wheel && item_menu(buttons)));
plat_mutex_unlock(&lock);
return active;
}
void gameplay_tweaks_init(void) {
gameplay_tweaks_available();
}
void gameplay_tweaks_reset(void) {
plat_mutex_lock(&lock);
clear_locked();
held_a = held_d = 0;
physical_buttons = 0;
was_e_down = consumed_e = 0;
plat_mutex_unlock(&lock);
}
void gameplay_tweaks_wheel(double delta, int c_down, int right_down) {
if (!isfinite(delta) || delta == 0) return;
if (delta > MAX_QUEUED) delta = MAX_QUEUED;
if (delta < -MAX_QUEUED) delta = -MAX_QUEUED;
plat_mutex_lock(&lock);
refresh_locked();
if (!options.available) {
clear_locked();
plat_mutex_unlock(&lock);
return;
}
int kind = NONE, axis = 0;
double sensitivity = 1;
if (object_context(physical_buttons)) {
if (right_down && options.distance) {
kind = DISTANCE;
sensitivity = options.distance_speed;
} else if (options.rotate) {
kind = ROTATE;
axis = options.c_axis && c_down;
sensitivity = options.rotation_speed;
}
} else if ((physical_buttons & (BIT(B_LEFT) | BIT(B_UP) | BIT(B_RIGHT) | BIT(B_DOWN))) &&
options.wheel && item_menu(physical_buttons)) {
kind = ITEMS;
sensitivity = options.item_speed;
} else if (map_zoom_allowed(physical_buttons)) {
kind = MAP_ZOOM;
sensitivity = options.map_zoom_speed;
} else if (weapon_wheel_allowed(physical_buttons, right_down, weapon.active)) {
kind = WEAPONS;
}
if (!kind) {
clear_locked();
plat_mutex_unlock(&lock);
return;
}
if (kind == MAP_ZOOM) {
if (weapon.active) clear_weapon_locked();
map_zoom_velocity -= delta * sensitivity * 16000.0;
if (map_zoom_velocity > 65536.0) map_zoom_velocity = 65536.0;
if (map_zoom_velocity < -65536.0) map_zoom_velocity = -65536.0;
plat_mutex_unlock(&lock);
return;
}
if (kind == WEAPONS) {
uint64_t now = plat_now_ns();
int new_dir = delta > 0 ? 1 : -1;
if (weapon.scroll_dir != 0 && new_dir != weapon.scroll_dir) {
weapon.fraction = 0;
weapon.queued = 0;
if (weapon.active && weapon.phase == W_HOLD) {
weapon.phase = W_GAP;
weapon.rx = 0;
weapon.polls_in_phase = 0;
weapon.phase_until_ns = now + WEAPON_GAP_NS;
}
}
weapon.scroll_dir = new_dir;
weapon.fraction += delta * options.weapon_speed;
int steps = (int)trunc(weapon.fraction);
if (steps != 0) {
weapon.confirm_pending = 0;
weapon.fraction -= steps;
weapon.direction = steps > 0 ? 1 : -1;
weapon.queued += (steps > 0 ? steps : -steps);
if (weapon.queued > MAX_QUEUED) weapon.queued = MAX_QUEUED;
if (!weapon.active) {
weapon.active = 1;
weapon.phase = W_PRIME;
weapon.polls_in_phase = 0;
weapon.prime_start_ns = now;
weapon.phase_until_ns = now + WEAPON_PRIME_MAX_NS;
weapon.rx = 0;
} else if (weapon.phase == W_WAIT) {
weapon.phase = W_HOLD;
weapon.polls_in_phase = 0;
weapon.phase_until_ns = now + WEAPON_HOLD_NS;
weapon.rx = 32767 * weapon.direction;
if (weapon.queued > 0) weapon.queued--;
}
}
plat_mutex_unlock(&lock);
return;
}
if (weapon.active) clear_weapon_locked();
if (kind != pulse.kind || axis != pulse.axis ||
(delta > 0 && pulse.direction < 0) || (delta < 0 && pulse.direction > 0)) {
clear_locked();
}
pulse.kind = kind;
pulse.axis = axis;
pulse.fraction += delta * sensitivity;
int steps = (int)trunc(pulse.fraction);
if (steps) {
pulse.fraction -= steps;
pulse.direction = steps > 0 ? 1 : -1;
if (!pulse.queued && !pulse.hold && !pulse.gap) pulse.valid = 0;
pulse.queued += steps > 0 ? steps : -steps;
if (pulse.queued > MAX_QUEUED) pulse.queued = MAX_QUEUED;
}
plat_mutex_unlock(&lock);
}
void gameplay_tweaks_prepare_keys(uint8_t *down, uint64_t pad_buttons) {
plat_mutex_lock(&lock);
refresh_locked();
held_a = held_d = 0;
int c = down[KEY_C], right = down[KEY_MOUSE_R];
int e = down[KEY_E];
int e_pressed = e && !was_e_down;
was_e_down = e;
if (!e) consumed_e = 0;
if (!c) consumed_c = 0;
if (!right) consumed_right = 0;
if (options.available) {
if (input_camera_context() == INPUT_CAM_ULTRAHAND_OBJECT) {
if (options.rotate && options.c_axis && !(options.distance && right) && c) consumed_c = 1;
if (options.distance && right) consumed_right = 1;
if (pulse.kind == ROTATE && pulse.axis != (options.c_axis && c)) clear_locked();
}
if (weapon.active && e_pressed) {
consumed_e = 1;
weapon.confirm_pending = 1;
}
if (consumed_e) down[KEY_E] = 0;
if (consumed_c) down[KEY_C] = 0;
if (consumed_right) down[KEY_MOUSE_R] = 0;
uint64_t buttons = pad_buttons | input_map_buttons(down);
if (options.keys && item_menu(buttons) && !weapon.active) {
held_a = down[KEY_A];
held_d = down[KEY_D];
down[KEY_A] = down[KEY_D] = 0;
}
} else {
consumed_c = consumed_right = consumed_e = 0;
}
plat_mutex_unlock(&lock);
}
static void sample_locked(uint64_t frame) {
if (pulse.valid && pulse.frame == frame) return;
pulse.buttons = 0;
pulse.rx = 0;
if (pulse.queued || pulse.hold || pulse.gap) {
if (pulse.kind == ROTATE) pulse.buttons = BIT(B_R);
if (pulse.kind == ROTATE && !pulse.primed) pulse.primed = 1;
else if (pulse.gap) pulse.gap--;
else {
if (!pulse.hold && pulse.queued) {
pulse.queued--;
pulse.hold = HOLD_FRAMES;
}
if (pulse.hold) {
if (pulse.kind == ROTATE)
pulse.buttons |= pulse.axis ? (pulse.direction > 0 ? BIT(B_DOWN) : BIT(B_UP)) :
(pulse.direction > 0 ? BIT(B_RIGHT) : BIT(B_LEFT));
else if (pulse.kind == DISTANCE)
pulse.buttons = pulse.direction < 0 ? BIT(B_UP) : BIT(B_DOWN);
else pulse.rx = 32767 * pulse.direction;
if (!--pulse.hold) pulse.gap = GAP_FRAMES;
}
}
} else pulse.primed = 0;
pulse.valid = 1;
pulse.frame = frame;
}
void gameplay_tweaks_apply(uint64_t frame, int active, uint64_t *buttons,
int32_t *lx, int32_t *ly, int32_t *rx, int32_t *ry) {
(void)lx;
(void)ly;
plat_mutex_lock(&lock);
refresh_locked();
physical_buttons = *buttons;
if (!active || !options.available) {
clear_locked();
held_a = held_d = 0;
plat_mutex_unlock(&lock);
return;
}
int right = ikb_down(KEY_MOUSE_R);
if (weapon.active) {
if (!weapon_wheel_allowed(physical_buttons, right, 1) || (physical_buttons & BIT(B_B))) {
clear_weapon_locked();
}
}
if (weapon.active) {
uint64_t now = plat_now_ns();
if (weapon.last_frame != frame) {
weapon.last_frame = frame;
weapon.polls_in_phase++;
}
switch (weapon.phase) {
case W_PRIME: {
uint64_t elapsed = now - weapon.prime_start_ns;
int shortcut = (menu_cursor_shortcut() == 1);
int ready = (elapsed >= WEAPON_PRIME_MIN_NS && weapon.polls_in_phase >= 3 && shortcut) ||
(elapsed >= WEAPON_PRIME_MAX_NS && weapon.polls_in_phase >= 4);
if (ready) {
if (weapon.queued > 0) {
weapon.phase = W_HOLD;
weapon.polls_in_phase = 0;
weapon.phase_until_ns = now + WEAPON_HOLD_NS;
weapon.rx = 32767 * weapon.direction;
weapon.queued--;
} else if (weapon.confirm_pending) {
clear_weapon_locked();
} else {
weapon.phase = W_WAIT;
weapon.polls_in_phase = 0;
weapon.rx = 0;
}
}
break;
}
case W_HOLD: {
if (now >= weapon.phase_until_ns && weapon.polls_in_phase >= 2) {
weapon.phase = W_GAP;
weapon.polls_in_phase = 0;
weapon.phase_until_ns = now + WEAPON_GAP_NS;
weapon.rx = 0;
}
break;
}
case W_GAP: {
if (now >= weapon.phase_until_ns && weapon.polls_in_phase >= 2) {
if (weapon.queued > 0) {
weapon.phase = W_HOLD;
weapon.polls_in_phase = 0;
weapon.phase_until_ns = now + WEAPON_HOLD_NS;
weapon.rx = 32767 * weapon.direction;
weapon.queued--;
} else if (weapon.confirm_pending) {
clear_weapon_locked();
} else {
weapon.phase = W_WAIT;
weapon.polls_in_phase = 0;
weapon.rx = 0;
}
}
break;
}
case W_WAIT: {
if (weapon.confirm_pending) {
clear_weapon_locked();
}
break;
}
default:
clear_weapon_locked();
break;
}
}
if (weapon.active) {
*buttons |= BIT(B_RIGHT);
*rx = weapon.rx;
*ry = 0;
} else {
int object = object_context(*buttons), items = item_menu(*buttons);
if ((pulse.kind == ROTATE && (!object || !options.rotate || (right && options.distance))) ||
(pulse.kind == DISTANCE && (!object || !right || !options.distance)) ||
(pulse.kind == ITEMS && (!items || !options.wheel))) {
clear_locked();
}
sample_locked(frame);
if (!map_zoom_allowed(*buttons)) {
map_zoom_velocity = 0;
} else if (fabs(map_zoom_velocity) > 50.0) {
int32_t stick_y = (int32_t)map_zoom_velocity;
if (stick_y > 32767) stick_y = 32767;
if (stick_y < -32767) stick_y = -32767;
if (abs(stick_y) > abs(*ry)) *ry = stick_y;
map_zoom_velocity *= 0.78;
if (fabs(map_zoom_velocity) < 100.0) map_zoom_velocity = 0;
}
if (pulse.kind == ROTATE || pulse.kind == DISTANCE) {
*buttons |= pulse.buttons;
// Distance D-pad pulses do not own the look stick. R rotation does,
// because the game's rotation mode would otherwise rotate both axes.
if (pulse.kind == ROTATE && pulse.buttons) *rx = *ry = 0;
} else if (pulse.kind == ITEMS && (pulse.queued || pulse.hold || pulse.gap || pulse.rx)) {
*rx = pulse.rx;
*ry = 0;
} else if (items && options.keys && (held_a || held_d)) {
*rx = ((held_d != 0) - (held_a != 0)) * 32767;
*ry = 0;
}
}
plat_mutex_unlock(&lock);
}
+14
View File
@@ -0,0 +1,14 @@
// Mouse wheel and keyboard gameplay tweaks: Ultrahand rotation and distance, item and weapon wheel, map zoom.
#pragma once
#include <stdint.h>
int gameplay_tweaks_available(void);
int gameplay_tweaks_capture_needed(void);
int gameplay_tweaks_map_zoom(void);
int gameplay_tweaks_strip_wheel(uint64_t buttons);
void gameplay_tweaks_init(void);
void gameplay_tweaks_reset(void);
void gameplay_tweaks_wheel(double delta, int c_down, int right_down);
void gameplay_tweaks_prepare_keys(uint8_t *down, uint64_t pad_buttons);
void gameplay_tweaks_apply(uint64_t frame, int active, uint64_t *buttons,
int32_t *lx, int32_t *ly, int32_t *rx, int32_t *ry);
+9
View File
@@ -23,7 +23,16 @@ uint64_t gfx_vsync_ticks(void); // ticks since start
uint64_t gfx_vsync_time_ns(uint64_t tick); // kern_now_ns() time of a tick (pacing)
double gfx_window_refresh_hz(void); // refresh rate of the window's monitor; 0 unknown
int gfx_window_focused(void);
uint64_t gfx_presents_shown(void); // gfx_present.c: presents queued since the start (two a frame with frame generation)
int gfx_frame_gen_live(void); // vk_backend.c: the last frame was shown with a generated picture before it
int gfx_picture_rect(float out[4]); // where the last present put the picture, fractions of the swapchain (x, y, w, h); 0 before one
void gfx_present_hold(int on); // 1: the window keeps its last picture, nothing new is presented (quick load)
// NVIDIA Reflex (gfx_present.c, VK_NV_low_latency2): the NVN front end and the input service mark a frame's stages.
// The markers and the sleep return at once with Reflex off or unsupported.
void vk_reflex_marker(int marker, uint64_t present_id); // present_id: the frame's (vk_reflex_frame_begin)
uint64_t vk_reflex_frame_begin(void); // SIMULATION_START: the new frame's present ID
uint64_t vk_reflex_frame(void); // the ID of the frame the game simulates now
void vk_reflex_sleep(void); // before SIMULATION_START: the driver's latency sleep
// ---- shader service client (gfx_shader.c)
enum { GFX_STAGE_VS, GFX_STAGE_TCS, GFX_STAGE_TES, GFX_STAGE_GS, GFX_STAGE_FS, GFX_STAGE_CS };
+319 -26
View File
@@ -22,10 +22,12 @@
#include "fs.h"
#include "gfx.h"
#include "gfx_wsys.h"
#include "host.h"
#include "nvn_api.h"
#include "platform/platform.h"
#include "ui/menu.h"
#include "vk.h"
#include "vk_fg.h"
#define FRAMES 2
#define MAX_IMAGES 16
@@ -33,9 +35,20 @@
#define VSYNC_HZ 60
// ---- queue lock
// The recorder queues the parts it records and submits them later (vk_rec.c rec_submit): the first lock of a thread
// waits until the parts queued before it are submitted, so whatever it puts on the queue comes after them, as when
// the submitting thread submitted them itself. Not inside a held lock: the recorder takes this lock to submit.
static PlatRMutex g_ql;
void vk_queue_lock(void) { plat_rmutex_lock(&g_ql); }
void vk_queue_unlock(void) { plat_rmutex_unlock(&g_ql); }
static _Thread_local int ql_depth;
void vk_queue_lock(void) {
if (!ql_depth) rec_queue_wait();
plat_rmutex_lock(&g_ql);
ql_depth++;
}
void vk_queue_unlock(void) {
ql_depth--;
plat_rmutex_unlock(&g_ql);
}
// ---- window state shared with the back end
static VkSurfaceKHR g_surface;
@@ -131,8 +144,15 @@ static VmaAllocation g_cap_alloc;
static uint8_t *g_cap_ptr;
static VkDeviceSize g_cap_size;
static int g_cap_w, g_cap_h, g_cap_valid;
static int g_flip_on; // vk_present_blit submitted the blit of swapchain image g_flip_idx; vk_present_flip presents it
static uint32_t g_flip_idx;
// vk_present_blit submitted the blits of swapchain images g_flip_idx[0 .. g_flip_n), oldest first; vk_present_flip
// presents the oldest. Two only with frame generation's pair (vk_present_blit_pair): the generated picture, then the
// game's frame.
static int g_flip_n;
static uint32_t g_flip_idx[2];
static int g_flip_gen[2]; // that blit shows a generated picture: its present carries no present ID
static volatile int64_t g_shown; // presents queued since the start (gfx_presents_shown)
static int g_overlay_on; // the pair's generated picture laid the menu out: the game's frame draws it again
static int g_fg_images = -1; // the swapchain was built with frame generation's extra image (build_swapchain)
// ---- TOTK_FLIGHT thumbnails (flight.c; g_pl): each present also blits the swapchain image down into slot frame % g_th_n
// of a host-visible ring. A slot's tag names the frame it holds complete; recording a new frame clears the tag first,
@@ -228,23 +248,210 @@ unsigned gfx_window_focus_messages(void) { return (unsigned)g_focus_msgs; }
// Present path (g_pl held): a settings change (cfg_version) reaches the window thread, which applies a changed size or
// fullscreen; a changed TOTK_VK_PRESENT rebuilds the swapchain at this present.
static void reflex_apply_locked(void);
static void window_settings_live(void) {
static unsigned seen;
static int started;
static char present[16]; // the TOTK_VK_PRESENT the swapchain was made with
unsigned v = cfg_version();
// Every present: Reflex follows the frame limit, and with fps_limit = display the window measures the monitor's
// rate after the swapchain is made, with no settings change to announce it. Unchanged, it returns at once.
if (started) reflex_apply_locked();
if (started && v == seen) return;
seen = v;
res_fov_live();
res_dynres_live();
const char *e = cfg_value("TOTK_VK_PRESENT");
if (!started || strncmp(e, present, sizeof present - 1)) {
snprintf(present, sizeof present, "%s", e);
if (started) plat_xchg32(&g_dirty, 1);
}
// frame_gen switched in the menu: the swapchain is built again with its image count
if (started && g_fg_images >= 0 && (vk_fg_engine() != VK_FG_OFF) != g_fg_images) plat_xchg32(&g_dirty, 1);
if (started) gfx_window_apply_settings();
reflex_apply_locked();
started = 1;
}
// ---- NVIDIA Reflex Low Latency (VK_NV_low_latency2)
static PFN_vkSetLatencySleepModeNV g_reflex_set_mode;
static PFN_vkLatencySleepNV g_reflex_sleep;
static PFN_vkSetLatencyMarkerNV g_reflex_marker;
static VkSemaphore g_reflex_sem;
static uint64_t g_reflex_val;
// Present IDs (VK_KHR_present_id, VK_NV_low_latency2): each frame gets its ID once, when the game acquires its window
// texture (SIMULATION_START, vk_reflex_frame_begin), and the frame carries it to its input sample, its submissions
// (vk_reflex_submit_id: the game thread's current frame, or the frame a replay or present thread set for the work it
// does) and its present (PresentJob.pid, vk_reflex_present_frame, flip_locked), so the driver can match every marker
// of a frame to the present of that frame.
static uint64_t g_reflex_frame_next; // the last ID handed out
static uint64_t g_reflex_frame; // the frame the game simulates now
static _Thread_local uint64_t t_reflex_submit; // the frame whose work this thread submits; 0: g_reflex_frame
static uint64_t g_blit_pid, g_flip_pid[2]; // the frame of the blit being made and of each present waiting (g_pl)
static uint64_t g_last_pid; // the last present ID presented (g_pl): present IDs only go up
static int g_reflex_mode = -1; // 0=off, 1=on, 2=boost
static uint32_t g_reflex_min_us = 1;
static int reflex_mode_from_cfg(void) {
const char *v = cfg_value("TOTK_REFLEX");
if (!v || !strcmp(v, "off") || !strcmp(v, "0")) return 0;
if (!strcmp(v, "boost") || !strcmp(v, "2")) return 2;
return 1;
}
static void reflex_apply_locked(void) {
VkCtx *c = vk_ctx();
if (!c || !c->has_nv_reflex || !g_sc) return;
if (!g_reflex_set_mode) {
g_reflex_set_mode = (PFN_vkSetLatencySleepModeNV)vkGetDeviceProcAddr(c->device, "vkSetLatencySleepModeNV");
g_reflex_sleep = (PFN_vkLatencySleepNV)vkGetDeviceProcAddr(c->device, "vkLatencySleepNV");
g_reflex_marker = (PFN_vkSetLatencyMarkerNV)vkGetDeviceProcAddr(c->device, "vkSetLatencyMarkerNV");
}
if (!g_reflex_set_mode) return;
if (!g_reflex_sem) {
VkSemaphoreTypeCreateInfo ti = {
.sType = VK_STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO,
.semaphoreType = VK_SEMAPHORE_TYPE_TIMELINE,
.initialValue = 0
};
VkSemaphoreCreateInfo si = {.sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO, .pNext = &ti};
if (vkCreateSemaphore(c->device, &si, NULL, &g_reflex_sem) != VK_SUCCESS) return;
}
int mode = reflex_mode_from_cfg();
uint32_t min_us = 0;
// The driver's sleep holds frames to the same rate as the pacer (frame_rate.c frame_step_limit_hz): the setting,
// the monitor's rate for fps_limit = display, 60 without the real-time step. cfg_int would read "display" as the
// setting's default, 60, and Reflex would hold a 144 Hz monitor to 60 fps.
double hz = frame_step_limit_hz();
if (hz > 0) min_us = (uint32_t)(1e6 / hz);
if (mode == g_reflex_mode && min_us == g_reflex_min_us) return;
g_reflex_mode = mode;
g_reflex_min_us = min_us;
VkLatencySleepModeInfoNV mi = {
.sType = VK_STRUCTURE_TYPE_LATENCY_SLEEP_MODE_INFO_NV,
.lowLatencyMode = mode > 0 ? VK_TRUE : VK_FALSE,
.lowLatencyBoost = mode == 2 ? VK_TRUE : VK_FALSE,
.minimumIntervalUs = min_us
};
VkResult r = g_reflex_set_mode(c->device, g_sc, &mi);
rt_log("REFLEX: NVIDIA Reflex Low Latency -> %s (minInterval=%u us, VK_NV_low_latency2=%s)",
mode == 2 ? "ON + BOOST" : mode == 1 ? "ON" : "OFF", min_us, r == VK_SUCCESS ? "OK" : "ERR");
}
int vk_has_reflex(void) {
VkCtx *c = vk_ctx();
return c && c->has_nv_reflex;
}
// TOTK_TRACE=perf, every LAT_EVERY presents: the time from a frame's start (its window texture acquired) to its
// present call on the host, with Reflex off or on, and with Reflex on the driver's own reports of the same frames
// (vkGetLatencyTimingsNV): how many came back with every marker matched to their present, and their simulation start
// to GPU render end. The frame's start is kept by its ID, so it also shows that a present carries its frame's ID.
#define LAT_RING 64
#define LAT_EVERY 600
static struct { uint64_t id, start_ns; } g_lat_start[LAT_RING];
static struct { uint64_t n, ns, presents; } g_lat;
static PFN_vkGetLatencyTimingsNV g_reflex_timings;
uint64_t vk_reflex_frame_begin(void) {
uint64_t id = __atomic_add_fetch(&g_reflex_frame_next, 1, __ATOMIC_RELAXED);
__atomic_store_n(&g_reflex_frame, id, __ATOMIC_RELAXED);
if (rt_trace & RT_TRACE_PERF) g_lat_start[id % LAT_RING].start_ns = kern_now_ns(), g_lat_start[id % LAT_RING].id = id;
return id;
}
// g_pl held, after the present of frame pid
static void latency_note(VkCtx *c, uint64_t pid) {
if (!(rt_trace & RT_TRACE_PERF) || !pid) return;
if (g_lat_start[pid % LAT_RING].id == pid) g_lat.n++, g_lat.ns += kern_now_ns() - g_lat_start[pid % LAT_RING].start_ns;
if (++g_lat.presents % LAT_EVERY) return;
char drv[200] = "";
if (g_reflex_mode > 0 && g_sc) {
if (!g_reflex_timings) g_reflex_timings = (PFN_vkGetLatencyTimingsNV)vkGetDeviceProcAddr(c->device, "vkGetLatencyTimingsNV");
static VkLatencyTimingsFrameReportNV rep[64];
VkGetLatencyMarkerInfoNV gi = {.sType = VK_STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV};
if (g_reflex_timings) {
g_reflex_timings(c->device, g_sc, &gi); // the count first
if (gi.timingCount > 64) gi.timingCount = 64;
for (uint32_t i = 0; i < gi.timingCount; i++)
rep[i] = (VkLatencyTimingsFrameReportNV){.sType = VK_STRUCTURE_TYPE_LATENCY_TIMINGS_FRAME_REPORT_NV};
gi.pTimings = rep;
if (gi.timingCount) g_reflex_timings(c->device, g_sc, &gi);
uint32_t full = 0;
double sum = 0;
for (uint32_t i = 0; i < gi.timingCount; i++) {
const VkLatencyTimingsFrameReportNV *r = &rep[i];
if (r->simStartTimeUs && r->simEndTimeUs && r->renderSubmitStartTimeUs && r->presentStartTimeUs &&
r->gpuRenderEndTimeUs > r->simStartTimeUs)
full++, sum += (double)(r->gpuRenderEndTimeUs - r->simStartTimeUs);
}
snprintf(drv, sizeof drv, "; driver reports: %u of %u frames with every marker, simulation start to GPU render "
"end %.2f ms", full, gi.timingCount, full ? sum / full / 1000.0 : 0.0);
}
}
rt_log("reflex: frame start to present %.2f ms over %llu frames (reflex %s)%s", g_lat.n ? g_lat.ns / 1e6 / g_lat.n : 0.0,
(unsigned long long)g_lat.n, g_reflex_mode == 2 ? "boost" : g_reflex_mode == 1 ? "on" : "off", drv);
g_lat.n = g_lat.ns = 0;
}
uint64_t vk_reflex_frame(void) { return __atomic_load_n(&g_reflex_frame, __ATOMIC_RELAXED); }
void vk_reflex_submit_frame(uint64_t id) { t_reflex_submit = id; }
uint64_t vk_reflex_submit_id(void) { return t_reflex_submit ? t_reflex_submit : vk_reflex_frame(); }
// The present thread, before the blit of frame id: the present of that blit carries id.
void vk_reflex_present_frame(uint64_t id) {
// g_blit_pid feeds flip_locked's VkPresentIdKHR (Reflex) and latency_note (TOTK_TRACE=perf); with neither, the
// present skips the lock
if (!vk_has_reflex() && !(rt_trace & RT_TRACE_PERF)) return;
plat_rmutex_lock(&g_pl);
g_blit_pid = id;
plat_rmutex_unlock(&g_pl);
}
void vk_reflex_marker(int marker, uint64_t pid) {
VkCtx *c = vk_ctx();
if (!c || !c->has_nv_reflex || !g_reflex_marker || g_reflex_mode <= 0 || !g_sc || !pid) return;
plat_rmutex_lock(&g_pl);
if (g_sc && g_reflex_marker) {
VkSetLatencyMarkerInfoNV mi = {
.sType = VK_STRUCTURE_TYPE_SET_LATENCY_MARKER_INFO_NV,
.presentID = pid,
.marker = (VkLatencyMarkerNV)marker
};
g_reflex_marker(c->device, g_sc, &mi);
}
plat_rmutex_unlock(&g_pl);
}
void vk_reflex_sleep(void) {
VkCtx *c = vk_ctx();
if (!c || !c->has_nv_reflex || !g_reflex_sleep || !g_reflex_sem || g_reflex_mode <= 0 || !g_sc) return;
uint64_t val = __atomic_add_fetch(&g_reflex_val, 1, __ATOMIC_RELAXED);
VkLatencySleepInfoNV si = {
.sType = VK_STRUCTURE_TYPE_LATENCY_SLEEP_INFO_NV,
.signalSemaphore = g_reflex_sem,
.value = val
};
// vkLatencySleepNV uses the swapchain, which Vulkan wants externally synchronised with the acquire and the present
// (they run under g_pl on the present thread). The wait for the semaphore stays outside the lock.
VkResult r = VK_ERROR_INITIALIZATION_FAILED;
plat_rmutex_lock(&g_pl);
if (g_sc) r = g_reflex_sleep(c->device, g_sc, &si);
plat_rmutex_unlock(&g_pl);
if (r == VK_SUCCESS) {
VkSemaphoreWaitInfo wi = {
.sType = VK_STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO,
.semaphoreCount = 1,
.pSemaphores = &g_reflex_sem,
.pValues = &val
};
vkWaitSemaphores(c->device, &wi, 100000000ULL);
}
}
// ---- swapchain
static const char *g_present_got = ""; // the TOTK_VK_PRESENT value of the mode the swapchain got; "" before one
@@ -271,20 +478,52 @@ static VkPresentModeKHR pick_present_mode(VkPhysicalDevice pd) {
const char *gfx_window_present_mode(void) { return __atomic_load_n(&g_present_got, __ATOMIC_ACQUIRE); }
// Queues the present of a blit vk_present_blit left waiting (g_pl held). A swapchain rebuild and the next blit flush it
// first; the device release drops it.
static void flip_locked(void) {
if (!g_flip_on) return;
g_flip_on = 0;
// Queues the present of the oldest blit vk_present_blit left waiting (g_pl held).
static void flip_one(void) {
if (!g_flip_n) return;
uint32_t idx = g_flip_idx[0];
uint64_t frame_pid = g_flip_pid[0];
int generated = g_flip_gen[0];
g_flip_idx[0] = g_flip_idx[1], g_flip_pid[0] = g_flip_pid[1], g_flip_gen[0] = g_flip_gen[1];
g_flip_n--;
if (!g_sc) return;
VkPresentInfoKHR pi = {.sType = VK_STRUCTURE_TYPE_PRESENT_INFO_KHR, .waitSemaphoreCount = 1,
.pWaitSemaphores = &g_render_done[g_flip_idx], .swapchainCount = 1, .pSwapchains = &g_sc,
.pImageIndices = &g_flip_idx};
VkCtx *c = vk_ctx();
uint64_t pid = 0;
VkPresentIdKHR pid_info = {0};
// A generated picture goes out between two frames whose IDs follow each other: no ID is left for it, and the
// game's frame after it keeps the one its markers were set with (the rule of PR #1089)
int with_id = c && c->has_nv_reflex && !generated;
if (with_id) {
// The frame's own ID; a present without one (a probe, a skipped frame's neighbour) takes the next free value,
// as present IDs must grow on a swapchain
pid = frame_pid > g_last_pid ? frame_pid : g_last_pid + 1;
g_last_pid = pid;
pid_info.sType = VK_STRUCTURE_TYPE_PRESENT_ID_KHR;
pid_info.swapchainCount = 1;
pid_info.pPresentIds = &pid;
vk_reflex_marker(4, pid); // VK_LATENCY_MARKER_PRESENT_START_NV
}
VkPresentInfoKHR pi = {.sType = VK_STRUCTURE_TYPE_PRESENT_INFO_KHR,
.pNext = with_id ? &pid_info : NULL,
.waitSemaphoreCount = 1,
.pWaitSemaphores = &g_render_done[idx], .swapchainCount = 1, .pSwapchains = &g_sc,
.pImageIndices = &idx};
vk_queue_lock();
VkResult r = vkQueuePresentKHR(vk_ctx()->gfx_queue, &pi);
VkResult r = vkQueuePresentKHR(c->gfx_queue, &pi);
vk_queue_unlock();
if (with_id) vk_reflex_marker(5, pid); // VK_LATENCY_MARKER_PRESENT_END_NV
if (c && !generated) latency_note(c, pid ? pid : frame_pid);
vk_device_fault_report(r);
if (r == VK_ERROR_OUT_OF_DATE_KHR || r == VK_SUBOPTIMAL_KHR) plat_xchg32(&g_dirty, 1);
__atomic_add_fetch(&g_shown, 1, __ATOMIC_RELAXED);
}
uint64_t gfx_presents_shown(void) { return (uint64_t)__atomic_load_n(&g_shown, __ATOMIC_RELAXED); }
// Every blit left waiting goes out, in order (g_pl held): before a swapchain rebuild and before the next blit (but the
// pair's second); the device release drops them.
static void flip_locked(void) {
while (g_flip_n) flip_one();
}
static void free_capture(void) {
@@ -319,15 +558,24 @@ static int build_swapchain(void) {
if (fmts[i].format == VK_FORMAT_B8G8R8A8_UNORM && fmts[i].colorSpace == VK_COLOR_SPACE_SRGB_NONLINEAR_KHR) { sf = fmts[i]; found = 1; }
for (uint32_t i = 0; i < nf && !found; i++)
if (fmts[i].format == VK_FORMAT_R8G8B8A8_UNORM && fmts[i].colorSpace == VK_COLOR_SPACE_SRGB_NONLINEAR_KHR) { sf = fmts[i]; found = 1; }
uint32_t count = caps.minImageCount + 1;
// Frame generation's pair holds two images acquired at once (the generated picture's blit waits while the game's
// frame is blitted): one image more, while frame_gen names a generator
int fg_images = g_fg_images = vk_fg_engine() != VK_FG_OFF;
uint32_t count = caps.minImageCount + 1 + (fg_images ? 1u : 0u);
if (caps.maxImageCount && count > caps.maxImageCount) count = caps.maxImageCount;
if (count > 8) count = 8;
vk_queue_lock();
vkDeviceWaitIdle(c->device);
VkSwapchainKHR old = g_sc;
VkSwapchainLatencyCreateInfoNV sci = {
.sType = VK_STRUCTURE_TYPE_SWAPCHAIN_LATENCY_CREATE_INFO_NV,
.latencyModeEnable = VK_TRUE
};
VkSwapchainCreateInfoKHR ci = {
.sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR, .surface = g_surface, .minImageCount = count,
.sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR,
.pNext = (c->has_nv_reflex) ? &sci : NULL,
.surface = g_surface, .minImageCount = count,
.imageFormat = sf.format, .imageColorSpace = sf.colorSpace, .imageExtent = ext, .imageArrayLayers = 1,
.imageUsage = VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_TRANSFER_SRC_BIT |
VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, // every surface supports it (the menu overlay draws into it)
@@ -364,6 +612,16 @@ static int build_swapchain(void) {
}
free_capture();
vk_queue_unlock();
if (fg_images) {
static uint32_t said;
if (said != g_sc_n)
said = g_sc_n, rt_log("gfx: swapchain of %u images (minimum %u; one more for frame generation's pair)", g_sc_n,
caps.minImageCount);
}
// The Reflex sleep mode belongs to the swapchain: a new one (resize, fullscreen, out of date) starts with low
// latency off, so the mode is set on it again even though the setting did not change.
g_reflex_mode = -1;
reflex_apply_locked();
return 1;
}
@@ -571,12 +829,22 @@ void gfx_fit_rect(int cw, int ch, int dw, int dh, int out[4]) {
out[0] = (dw - out[2]) / 2, out[1] = (dh - out[3]) / 2;
}
static void present_image(VkImage src, VkImageLayout layout, VkFormat fmt, int w, int h, const int crop[4], int defer) {
int general = layout == VK_IMAGE_LAYOUT_GENERAL;
// Quick load (quicksave.c) holds the window on its last picture while it drives the game's load menu underneath:
// no new frame is presented until gfx_present_hold(0), as while the window is minimized.
static volatile int32_t g_hold;
void gfx_present_hold(int on) { plat_xchg32(&g_hold, on != 0); }
// pair: 0 a present of its own; 1 frame generation's generated picture, the first of a pair; 2 the game's frame after
// it, which leaves the first blit's present waiting in front of its own and draws the menu as that blit laid it out.
// Returns 1 when the blit was submitted.
static int present_image(VkImage src, VkImageLayout layout, VkFormat fmt, int w, int h, const int crop[4], int defer,
int pair) {
int general = layout == VK_IMAGE_LAYOUT_GENERAL, done = 0;
gfx_window_start();
VkCtx *c = vk_ctx();
plat_rmutex_lock(&g_pl);
flip_locked();
if (pair != 2) flip_locked();
if (plat_cas32(&g_hold, 0, 0)) goto out;
if (!g_sc || plat_cas32(&g_dirty, 0, 0)) {
if (!wsys_minimized() && !create_swapchain() && !g_sc) goto out;
}
@@ -616,10 +884,16 @@ static void present_image(VkImage src, VkImageLayout layout, VkFormat fmt, int w
MenuTarget mt = {c->instance, c->phys, c->device, c->gfx_family, c->gfx_queue,
g_sc_hdr ? VK_FORMAT_R8G8B8A8_UNORM : g_sc_fmt, g_sc_ext.width,
g_sc_ext.height, cw, ch, g_scaler};
int overlay = g_sc_view[idx] &&
int overlay;
if (pair == 2) {
overlay = g_sc_view[idx] && g_overlay_on;
} else {
overlay = g_sc_view[idx] &&
menu_overlay_frame(__atomic_load_n(&gfx_counters.frames, __ATOMIC_RELAXED), &mt, &menu_shot);
g_overlay_on = overlay;
}
int cap = (g_capture || menu_shot) && ensure_capture_buffer();
int thumb = g_th_n && ensure_thumbs();
int thumb = pair != 1 && g_th_n && ensure_thumbs(); // the flight recorder keeps the game's frames
VkCommandBuffer cb = g_cb[slot];
vkResetCommandBuffer(cb, 0);
@@ -732,8 +1006,11 @@ static void present_image(VkImage src, VkImageLayout layout, VkFormat fmt, int w
r = vkQueueSubmit2(c->gfx_queue, 1, &si, g_fence[slot]);
vk_queue_unlock();
if (r == VK_SUCCESS) {
g_flip_on = 1;
g_flip_idx = idx;
if (g_flip_n == 2) flip_one(); // (not reached: every blit but a pair's second flushes the waiting ones)
g_flip_pid[g_flip_n] = g_blit_pid; // the frame this blit shows (vk_reflex_present_frame)
g_flip_gen[g_flip_n] = pair == 1;
g_flip_idx[g_flip_n++] = idx;
done = 1;
if (!defer) flip_locked();
} else {
vk_device_fault_report(r);
@@ -750,19 +1027,30 @@ static void present_image(VkImage src, VkImageLayout layout, VkFormat fmt, int w
}
out:
plat_rmutex_unlock(&g_pl);
return done;
}
void vk_present_image(VkImage src, VkImageLayout layout, VkFormat fmt, int w, int h, const int crop[4]) {
present_image(src, layout, fmt, w, h, crop, 0);
present_image(src, layout, fmt, w, h, crop, 0, 0);
}
void vk_present_blit(VkImage src, VkImageLayout layout, VkFormat fmt, int w, int h, const int crop[4]) {
present_image(src, layout, fmt, w, h, crop, 1);
present_image(src, layout, fmt, w, h, crop, 1, 0);
}
int vk_present_blit_pair(VkImage gen, VkImage src, VkFormat fmt, int w, int h, const int crop[4]) {
// without the first blit (no swapchain, minimised, held) the game's frame goes alone, as any present
if (!present_image(gen, VK_IMAGE_LAYOUT_GENERAL, VK_FORMAT_R8G8B8A8_UNORM, w, h, crop, 1, 1)) {
present_image(src, VK_IMAGE_LAYOUT_GENERAL, fmt, w, h, crop, 1, 0);
return 0;
}
present_image(src, VK_IMAGE_LAYOUT_GENERAL, fmt, w, h, crop, 1, 2);
return 1;
}
void vk_present_flip(void) {
plat_rmutex_lock(&g_pl);
flip_locked();
flip_one();
plat_rmutex_unlock(&g_pl);
}
@@ -782,12 +1070,17 @@ void gfx_window_release_vk(void) {
vk_queue_lock();
vkDeviceWaitIdle(c->device);
vk_queue_unlock();
g_flip_on = 0; // its blit is done (device idle); the swapchain goes away unpresented
g_flip_n = 0; // their blits are done (device idle); the swapchain goes away unpresented
menu_vk_release();
vk_fsr_release();
vk_color_release();
vk_hdr_release();
vk_contact_release();
if (g_reflex_sem) {
vkDestroySemaphore(c->device, g_reflex_sem, NULL);
g_reflex_sem = VK_NULL_HANDLE;
}
g_reflex_mode = -1;
free_capture();
free_thumbs();
for (int i = 0; i < FRAMES; i++) {
+1004 -284
View File
File diff suppressed because it is too large. Load diff
+81 -3
View File
@@ -24,7 +24,10 @@ void rt_vlogf(const char *fmt, va_list ap);
void rt_log_raw(const char *p, size_t n);
const char *rt_log_path(void); // the log file, NULL when this run writes none
enum { RT_TRACE_SVC = 1, RT_TRACE_HOSTCALL = 2, RT_TRACE_IPC = 4, RT_TRACE_FS = 8, RT_TRACE_GFX = 16, RT_TRACE_PERF = 32,
RT_TRACE_SCHED = 64, RT_TRACE_AUDIO = 128, RT_TRACE_PRESENT = 256 };
RT_TRACE_SCHED = 64, RT_TRACE_AUDIO = 128, RT_TRACE_PRESENT = 256,
RT_TRACE_HOSTCOUNT = 512, // no TOTK_TRACE name of its own: hostfn_count switches it (host.h)
RT_TRACE_PLUGIN = 1024 }; // no name either: the plugin service run (plugin_init.c) sees every SVC through
// rt_plugin_svc while it runs a plugin's init
extern unsigned rt_trace; // from TOTK_TRACE=svc,host,ipc,fs,gfx,perf,sched,audio,present (or all)
// prof_win.c: TOTK_PROFILE=<path> sampling profiler; TOTK_TRACE=perf frame timing (waits of the render thread)
// PERF_TEX: texture uploads on the render thread (deswizzle, decode, staging), PERF_ASTC included
@@ -36,6 +39,10 @@ void perf_end(int kind, uint64_t t0); // counts render-thread time onl
void perf_replay(uint64_t t0); // replay (NVN -> Vulkan recording) time on any thread, waits inside it included
void perf_replay_thread(void); // the calling thread replays for the render thread: perf_end counts its waits
void perf_main_thread(void); // the calling thread is the guest main thread (TOTK_PROFILE_MAIN)
// The calling thread is one every frame goes through: on a hybrid CPU it prefers the P-cores (main.c, TOTK_PCORE);
// the first thread of each role logs it.
enum { PCORE_MAIN, PCORE_RENDER, PCORE_REPLAY, PCORE_RECORDER, PCORE_PRESENT, PCORE_N };
void perf_core_thread(int role);
// Events per 60-frame window: graphics pipelines finished by the background workers, draws skipped while pending,
// first texture uploads and re-uploads after CPU writes, draws skipped while a shader translates in the background,
// draws that waited for their pending pipeline and got it, draws into a target the previous frame did not render that
@@ -116,7 +123,9 @@ void hostfn_add_override(const char *name, GuestFn fn); // an override outsid
const char *hostfn_name(uint64_t addr); // name registered at a synthetic address, NULL if none
void hostfn_seal(void); // build the dispatch table (rt_dispatch_init over every
// linked module); idempotent; registration ends here
uint64_t hostfn_calls(void); // host-function calls so far, all threads
uint64_t hostfn_calls(void); // host-function calls counted so far, all threads: only
// while hostfn_count is on or under TOTK_TRACE=host
void hostfn_count(int on); // count host-function calls (probes); off by default
void hostfn_report(void); // call count per host function to stderr, busiest first
int hostfn_table_size(int observers); // linked HOST_OVERRIDE (0) / HOST_OBSERVER (1) entries
const char *hostfn_table_name(int observers, int i); // symbol of linked entry i, NULL past the end
@@ -143,6 +152,7 @@ uint32_t mem_set_attribute(uint64_t a, uint64_t n, uint32_t mask, uint32_t at);
uint32_t mem_map(uint64_t dst, uint64_t src, uint64_t n); // 0x04
uint32_t mem_unmap(uint64_t dst, uint64_t src, uint64_t n); // 0x05
uint32_t mem_query(uint64_t a, RtMemoryInfo *out); // 0x06
extern void (*mem_query_hook)(uint64_t a, RtMemoryInfo *r); // plugin service run only: adjusts mem_query's answer
uint32_t mem_map_physical(uint64_t a, uint64_t n); // 0x2C
uint32_t mem_unmap_physical(uint64_t a, uint64_t n); // 0x2D
int mem_info(uint32_t id, uint64_t *out); // GetInfo memory ids 2-7, 12-17, 21, 22, 28; 0 if not a memory id
@@ -171,17 +181,45 @@ int mem_guest_readable(uint64_t a, uint64_t n); // [a, a+n) can be re
// module or the committed heap answered from the layout,
// anything else by plat_mem_readable (an OS query)
// ---- short out-of-memory spells (oom.c)
enum { RT_OOM_COMMIT, RT_OOM_STAGING, RT_OOM_IMAGE, RT_OOM_CHUNK, RT_OOM_SITES };
extern volatile int32_t rt_oom_req; // set by rt_oom_request; vk_texture_new_submit takes it
void rt_oom_request(void); // asks the Vulkan back end to give memory back at its next
// submit (released textures, headroom blocks); any thread,
// any lock held
int rt_oom_wait(const char *what, uint64_t bytes, int (*retry)(void *arg), void *arg);
// after a failed allocation: requests a release, then calls
// retry every 10 ms for up to 30 s; 1 once retry returned 1,
// 0 after the wait (the caller ends the game). Logs the
// first 8 with the commit numbers
void *rt_realloc_wait(void *old, size_t n, const char *what); // realloc, NULL only after rt_oom_wait gave up
int rt_oom_forced(int site); // 1: fail this attempt at site (TOTK_TEST_OOM=<site>:<n>,
// sites commit, staging, image, chunk; or rt_oom_force)
void rt_oom_force(int site, int n); // probes: fail the next n attempts at site
int rt_oom_forced_left(int site); // forced failures still to come at site
// ---- modules (loader.c)
typedef struct {
const char *name; uint64_t base, size, text_end, data_off; // text_end, data_off: offsets from base
uint64_t init, init_array, init_array_size, ctor_flag; // absolute guest addresses; init_array_size in bytes
int plugin; // a mod's code module (layout plugin<N>), not a game module
} RtLoaded;
void ldr_load(const char *exefs_dir); // load, relocate (overrides applied), seal; once
extern GuestFn ldr_plugin_import; // set before ldr_load (plugin_init.c): every JUMP_SLOT
// import of a plugin binds to this observer
// The module tables of the runtime library: it is built once per release (tools/build_game.py --make-runtime-lib),
// before an install's layout (recomp/layout.py) adds its mod plugins after sdk, so they do not use that MOD_COUNT.
#define RT_MAX_MODULES 32
int ldr_count(void);
int ldr_plugins_gone(uint32_t *key); // layout plugins whose file is gone; mixes their paths into key
const RtLoaded *ldr_module(int i); // order: main, subsdk0, sdk
uint64_t ldr_symbol(const char *name); // exported definition, 0 if none
uint64_t ldr_plt_stub(const char *module, const char *name); // PLT stub whose GOT slot holds name, 0 if none
const char *ldr_describe(uint64_t a, char *buf, int n); // "main+0x1234 (symbol+0x10)", "host <name>", or the address
uint64_t ldr_nso_size(const char *dir, const char *file); // image size of an ExeFS NSO (SHA-256 checked)
void ldr_map_image(const char *dir, const char *file, uint64_t base, uint64_t *text_end, uint64_t *data_off);
// its segments at base (reserved by the caller), not
// linked: the plugin service run's rtld (plugin_init.c)
uint8_t *ldr_read_verified(const char *dir, const char *file, size_t *len); // whole file, SHA-256 checked against
// modules.c (fatal on mismatch); free() it
@@ -258,6 +296,8 @@ int cam_pack_build(const void *in, size_t n, const void *zsdic, size_t zsdic_n,
// multiplied, malloc'd; 0 = factor 1 or cannot (logged)
void cam_pack_served(void); // romfs.c serves the multiplied pack
// ---- game resolution (resolution.c): TOTK_OUTPUT_RES, TOTK_RENDER_SCALE
uint64_t res_grass_heap_extra_kib(void); // TOTK_GRASS_RANGE: added to the HeapDef grass heap; 0 = none
uint64_t res_grass_heap_extra_bytes(void); // the same, added to the application pool, 2 MiB steps
uint64_t res_heap_extra_bytes(void); // added to the application pool (mem_init), 2 MiB steps
uint64_t res_heap_extra_kib(void); // added to the HeapDef texture heap and its parent; 0 = none
uint64_t res_tex_heap_extra_bytes(void); // TOTK_TEX_HEAP_EXTRA_MB: added to the application pool and
@@ -272,6 +312,7 @@ void res_heapdef_served(void); // romfs.c serves the
void res_init(void); // after rt_patches_init: the patch page and the sets
float res_dlss_lod_bias(void); // TOTK_DLSS upscaling: texture LOD bias (<= 0)
int res_dlss_mode(const char *mode); // TOTK_DLSS changed while running: new scene size
int res_dlss_dll(void); // the DLSS library is next to the executable
void res_fn_hit(uint64_t addr, uint64_t x0); // main.c fnprof_hit: catches the renderer at start
void res_present(Cpu *c); // nvnQueuePresentTexture: applies a pending scene size
void res_sizes(unsigned out[2], unsigned scene[2]); // the output and scene sizes in effect (the game's own
@@ -280,8 +321,12 @@ int res_is_16x9(unsigned w, unsigned h); // within 1% of 16:9
int res_wants_wide_overlay(const unsigned out[2]); // not 16:9 on a game version with the camera aspect patch
int romfs_shaped_ready(unsigned w, unsigned h); // romfs-patches-<w>x<h> has a manifest (romfs.c; works
// before fs_init)
int romfs_shaped_prompts_ready(const char *folder, unsigned w, unsigned h); // the same for <folder>-<w>x<h>, a
// prompts' folder (romfs-patches-xbox, -xbox-label, -pc)
void res_wanted(unsigned out[2]); // the output size TOTK_OUTPUT_RES asks for
void res_asked(unsigned out[2]); // the same before a missing shaped layout made it 16:9
void res_fov_live(void); // TOTK_FOV to the camera (set fov); on a settings change
void res_dynres_live(void); // TOTK_DYNAMIC_RES to the game (set fixres); on a settings change
// ---- code patches (patches.c) and the frame step (frame_rate.c)
void rt_patches_init(void); // after ldr_load: switches from the environment, the patch
// page committed; logs the sets
@@ -291,6 +336,25 @@ void rt_patch_disable(int set); // before the guest s
void rt_patch_switch(int set, int on); // at run time (live settings): each site takes the new code
// the next time it runs
void *rt_patch_page(void); // the page the patched code reads (NULL without the table)
// Contested sites (recomp/patches.py `ordered`): a site two or more ordered sets patch runs the one that is on with the
// lowest rank (a tie: the one later in the patch file); rt_patch_pick[] holds its place, 1 up, 0 for none.
typedef struct {
const char *module; // "main"
uint32_t offset; // the site's module offset
const int16_t *sets; // its ordered sets, in the order its C tests them
int nsets;
} RtPatchPick;
void rt_patch_rank(int set, int rank); // an ordered set's rank (0 first: the Mods tab's position);
// unranked sets come after every ranked one
void rt_patch_picks(void); // every contested site's pick from the sets on and their
// ranks; rt_patch_switch of an ordered set redoes its sites
int rt_patch_pick_count(void);
const RtPatchPick *rt_patch_pick_at(int i); // NULL out of range
int rt_patch_pick_winner(int i); // the place in its sets of the set that runs there, -1 none
const char *rt_patch_name(int set); // NULL out of range
// --probe-mods: a set table of its own (names, n sets, its contested sites), every set off and unranked; names NULL
// returns to the generated table.
void rt_patch_probe_table(const char *const *names, int n, const RtPatchPick *picks, int npicks);
void frame_step_init(void); // after rt_patches_init: the real-time step's first value
int frame_step_realtime(void); // the real-time step is on: presents ignore the interval
uint64_t frame_step_cap_ns(void); // with the real-time step: the shortest frame in ns
@@ -310,13 +374,27 @@ int rt_knob(const char *name, const char *def);
void frame_step_present(uint64_t display_ns, int interval); // nvnQueuePresentTexture: the frame's display time and
// present interval (60 Hz ticks)
// ---- boot (boot.c, main.c)
typedef struct { const char *exefs, *romfs, *profile; int boot; double seconds; const char *shot, *gpu; } RtConfig;
typedef struct {
const char *exefs, *romfs, *profile;
int boot;
double seconds;
const char *shot, *gpu;
const char *plugin_init; // --plugin-init DIR: the plugin service run writes its record there (plugin_init.c)
} RtConfig;
// romfs: directory with romfs.bin and index.json;
// frames: --frames N (0 = no limit); shot: --shot
// PATH; gpu: TOTK_GPU
const RtConfig *rt_config(void);
void rt_boot_event(const char *what, Cpu *c, const char *detail); // checkpoint log; "nvn" ends --boot
void rt_boot(void); // boot.c
void rt_boot_plugin_init(void); // boot.c: --plugin-init, the plugin service run
void plugin_init_setup(void); // plugin_init.c: before ldr_load
void plugin_init_run(Cpu *c, const RtLoaded *sdk); // plugin_init.c: from the module-init callback; exits
void plugins_setup(void); // plugin_init.c: rt_boot, before ldr_load; nothing
// without a plugin in the build
int plugins_start(Cpu *c, const RtLoaded *sdk); // plugin_init.c: from the module-init callback, before
// the game's constructors; 1 when it ran sdk's DT_INIT
// (a plugin's init ran after it)
// Modes of totk.exe. main.c has run mem_init and parsed the paths; each mode calls ldr_load itself if it needs the
// modules, registers its host functions, then seals (hostfn_seal, or implicitly at the first rt_call). Return the
// process exit code.
+20 -9
View File
@@ -2,9 +2,9 @@
// Host functions at synthetic guest addresses: the HOST_OVERRIDE / HOST_OBSERVER
// linker tables, the registry behind them, and the calls between host and guest (rt_call, rt_original).
//
// Every registered function dispatches through hostfn_entry, which counts the call, traces the first one
// (TOTK_TRACE=host) and tail-calls the real function. The registry is fixed by hostfn_seal, which builds the dispatch
// table; guest threads start after that, so lookups need no lock.
// Every registered function dispatches through hostfn_entry, which counts the call (only while hostfn_count is on or
// under TOTK_TRACE=host), traces the first one (TOTK_TRACE=host) and tail-calls the real function. The registry is
// fixed by hostfn_seal, which builds the dispatch table; guest threads start after that, so lookups need no lock.
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
@@ -46,7 +46,8 @@ static int sealed;
// The call count (hostfn_calls): one counter per calling thread, each on its own cache line, written only by that
// thread. A locked add on a per-function counter beside the read-mostly slot fields made the game threads share and
// bounce those lines on every host call (1.4.3 town: about 1% of the game threads' time in hostfn_entry).
// bounce those lines on every host call (1.4.3 town: about 1% of the game threads' time in hostfn_entry). Only the
// probes and TOTK_TRACE=host read it, so a game run does not count: hostfn_entry tests one rt_trace word for both.
#define MAX_COUNTERS 4096
typedef struct { _Alignas(64) uint64_t n; } Counter;
static Counter counters[MAX_COUNTERS];
@@ -157,18 +158,28 @@ __attribute__((noinline)) static void hostfn_blocking(Cpu *c, GuestFn fn) {
kern_core_back(&away);
}
static void hostfn_entry(Cpu *c) {
uint64_t i = (c->pc - RT_HOSTFN_BASE) >> 4;
if (__builtin_expect((c->pc & 15) || i >= (uint64_t)nslots, 0)) bad_entry(c);
Slot *s = &slots[i];
void hostfn_count(int on) {
if (on) __atomic_fetch_or(&rt_trace, RT_TRACE_HOSTCOUNT, __ATOMIC_RELAXED);
else __atomic_fetch_and(&rt_trace, ~(unsigned)RT_TRACE_HOSTCOUNT, __ATOMIC_RELAXED);
}
// The counted path of hostfn_entry: the call count, and under TOTK_TRACE=host the first call of each function.
__attribute__((noinline, cold)) static void hostfn_watch(Cpu *c, Slot *s) {
uint64_t *k = thread_calls;
if (__builtin_expect(!k, 0)) k = counter_new();
if (__builtin_expect(k == &shared_calls, 0)) __atomic_fetch_add(k, 1, __ATOMIC_RELAXED);
else __atomic_store_n(k, *k + 1, __ATOMIC_RELAXED);
if (__builtin_expect(rt_trace & RT_TRACE_HOSTCALL, 0) && !__atomic_fetch_add(&s->calls, 1, __ATOMIC_RELAXED)) {
if ((rt_trace & RT_TRACE_HOSTCALL) && !__atomic_fetch_add(&s->calls, 1, __ATOMIC_RELAXED)) {
char lr[96];
rt_log("host call %s from %s", s->name, ldr_describe(c->x[30] - 4, lr, sizeof lr));
}
}
static void hostfn_entry(Cpu *c) {
uint64_t i = (c->pc - RT_HOSTFN_BASE) >> 4;
if (__builtin_expect((c->pc & 15) || i >= (uint64_t)nslots, 0)) bad_entry(c);
Slot *s = &slots[i];
if (__builtin_expect(rt_trace & (RT_TRACE_HOSTCALL | RT_TRACE_HOSTCOUNT), 0)) hostfn_watch(c, s);
if (s->blocking) {
hostfn_blocking(c, s->fn);
return;
+671 -67
View File
@@ -4,7 +4,7 @@
// system's back end (input_wsys.h: input_win.c with Win32, input_sdl.c with SDL), which also owns the cursor capture.
// Keys and their map: docs/controls.md.
// The gamepad also rumbles (input_rumble) and, when it has a gyro and an accelerometer, feeds the six-axis sensor from a
// thread of its own (input_motion_start). Every SDL call on the gamepad is made under `lock`.
// thread of its own (input_motion_start). Every SDL call on the gamepad is made under `lock`, except the rumble writes (rumble_main).
#include <math.h>
#include <stdint.h>
#include <stdlib.h>
@@ -21,6 +21,7 @@
#include "ui/menu.h"
#include "vk.h"
#include "platform/platform.h"
#include "gameplay_tweaks.h"
enum { STICK_MAX = 32767, STICK_DIR = 16384, TRIGGER_ON = 16384, RESCAN_MS = 1000 };
@@ -33,17 +34,32 @@ static volatile int32_t g_block, g_menu; // text entry / host menu: 0 off, 1 o
enum { PAD_USED = 16384, MOUSE_USED = 6 };
static volatile int32_t g_kbm_last = 1;
int input_kbm_last(void) { return __atomic_load_n(&g_kbm_last, __ATOMIC_RELAXED); }
int input_gameplay_active(void) { return !g_menu && !g_block && ikb_foreground() && ikb_captured(); }
static SDL_Gamepad *pad;
static uint64_t next_scan;
static volatile int32_t rumble_ready; // the open gamepad has rumble motors (what input_rumble returns)
static void rumble_cancel(void);
static int pad_rumble; // the open gamepad has rumble motors
static volatile int32_t pad_labels[4]; // ... and the labels of its south, east, west, north buttons (PAD_LABEL_*), any thread
static int pad_east_a; // ... and labels its east face button A (Nintendo layout under TOTK_PAD_LAYOUT=auto)
static int pad_layout = -1; // PAD_LAYOUT_* in effect for the open gamepad, -1 to pick again; live (cfg_version)
static unsigned pad_layout_seen;
static volatile int32_t pad_layout_shown = -1; // pad_layout for the menu (any thread), -1 without a gamepad
// Steam Input: a game Steam starts gets SDL_GAMECONTROLLER_IGNORE_DEVICES, the vendor/product pairs of the controllers
// Steam reads itself, and sees Steam's virtual gamepad in their place. That pad has no motion sensors, so a Steam
// Controller, a Steam Deck or a DualSense under Steam Input gives no gyro. steam_reveal keeps the list here and clears
// the hint: the buttons and sticks still come from the virtual pad (scan_pads skips the listed devices, so Steam's
// remapping holds and nothing is read twice), and only the sensors come from the real controller (motion_source).
enum { STEAM_HIDDEN_MAX = 64 };
static uint16_t steam_hidden[STEAM_HIDDEN_MAX][2]; // vendor, product
static int steam_hidden_n;
static SDL_Gamepad *motion_extra; // the hidden controller opened for its sensors only, NULL none
static int pad_hidden; // the open gamepad is a controller Steam hid (scan_pads' fallback)
static uint64_t next_motion_scan;
static SDL_JoystickID sensor_pad; // the gamepad whose sensors the motion thread set up, 0 none
static int sensor_ok; // ... and it has both sensors, enabled
static int motion_thread; // 0 not started, 1 running, -1 off (TOTK_MOTION=0, no SDL)
static char calib_pad_name[128]; // the controller the bias belongs to; empty when there is none
// SDL buttons of the gamepad inputs (input_map.h PAD_*), by position; PAD_ZL and PAD_ZR are the triggers (axes).
static const SDL_GamepadButton pad_sdl[PAD_COUNT] = {
@@ -55,9 +71,11 @@ static const SDL_GamepadButton pad_sdl[PAD_COUNT] = {
[PAD_DPAD_RIGHT] = SDL_GAMEPAD_BUTTON_DPAD_RIGHT, [PAD_DPAD_DOWN] = SDL_GAMEPAD_BUTTON_DPAD_DOWN,
[PAD_LPADDLE1] = SDL_GAMEPAD_BUTTON_LEFT_PADDLE1, [PAD_RPADDLE1] = SDL_GAMEPAD_BUTTON_RIGHT_PADDLE1,
[PAD_LPADDLE2] = SDL_GAMEPAD_BUTTON_LEFT_PADDLE2, [PAD_RPADDLE2] = SDL_GAMEPAD_BUTTON_RIGHT_PADDLE2,
[PAD_TOUCHPAD] = SDL_GAMEPAD_BUTTON_TOUCHPAD,
};
// TOTK_INPUT_SCRIPT=<file>: lines "<frame> <button> [hold]" or "<frame> LSTICK|RSTICK <x> <y> [hold]", ORed into the real input.
// TOTK_INPUT_SCRIPT=<file>: lines "<frame> <button> [hold]", "<frame> LSTICK|RSTICK <x> <y> [hold]", "<frame> MOUSE
// <dx> <dy>" or "<frame> WHEEL <notches>" (+ away from the player), ORed into the real input.
// <frame> and its hold are 60 Hz ticks of game time since the first present (frame_step_ticks: presents at 60 fps), so
// the title menus get the presses at the same game time at any frame limit. A line "@<ms> ..." is timed instead: <ms>
// and its hold are milliseconds of the world clock (frame_step_world_us, game time since the loaded save's first
@@ -74,6 +92,7 @@ static ScriptEv *script_ev;
static int script_n, script_state; // 0 not loaded, 1 loaded
static int script_mixed; // the script has timed lines: its untimed ones end where the world clock starts
static int32_t script_mouse[2]; // one-shot raw counts, consumed by the camera hook; under lock
static int32_t script_wheel; // one-shot wheel notches, taken with the real ones (wheel_stick); under lock
static void script_load(void) {
script_state = 1;
@@ -96,7 +115,14 @@ static void script_load(void) {
ScriptEv e = {.at = (uint64_t)(at * unit + 0.5), .hold = timed ? 66667 : 4, .bit = -1, .timed = timed};
long a, b;
double c;
if (!strcmp(name, "MOUSE") || !strcmp(name, "LSTICK") || !strcmp(name, "RSTICK")) {
if (!strcmp(name, "QUICKSAVE") || !strcmp(name, "QUICKLOAD")) {
e.stick = name[5] == 'S' ? 5 : 6, e.hold = 1; // once, as quicksave's keys
snprintf(e.text, sizeof e.text, "%s", name);
} else if (!strcmp(name, "WHEEL")) {
if (sscanf(line + off, "%ld", &a) != 1) { rt_log("input: script line %d: WHEEL needs notches", ln); continue; }
e.stick = 4, e.x = (int32_t)a, e.hold = 1; // one turn, never held
snprintf(e.text, sizeof e.text, "WHEEL %d", e.x);
} else if (!strcmp(name, "MOUSE") || !strcmp(name, "LSTICK") || !strcmp(name, "RSTICK")) {
int n = sscanf(line + off, "%ld %ld %lf", &a, &b, &c);
if (n < 2) { rt_log("input: script line %d: %s needs x y [hold]", ln, name); continue; }
e.stick = name[0] == 'M' ? 3 : name[0] == 'L' ? 1 : 2; e.x = (int32_t)a; e.y = (int32_t)b;
@@ -122,6 +148,10 @@ static void script_load(void) {
rt_log("input: script %s, %d events", path, script_n);
}
// Under lock: the Switch buttons the input script pressed in the last poll, apart from the keys' and the gamepad's, so
// a gamepad combo can count a scripted press as the gamepad's without counting the keys bound to the same buttons
static uint64_t script_seen;
static void script_apply(uint64_t *b, int32_t sl[2], int32_t sr[2]) {
if (!script_state) script_load();
if (!script_n) return;
@@ -131,14 +161,18 @@ static void script_apply(uint64_t *b, int32_t sl[2], int32_t sr[2]) {
ScriptEv *e = &script_ev[i];
if (e->timed ? w < 0 : script_mixed && w >= 0) continue;
uint64_t now = e->timed ? (uint64_t)w : tick;
if (now < e->at || (now >= e->at + e->hold && (e->logged || !e->timed))) continue;
if (e->stick == 3 && e->logged) continue;
// A one-shot (MOUSE, WHEEL) goes in at the first poll at or after its time: a poll that skips a tick (the
// game below 60 fps) would otherwise lose it
if (e->stick >= 3 ? e->logged || now < e->at
: now < e->at || (now >= e->at + e->hold && (e->logged || !e->timed))) continue;
if (!e->logged) {
e->logged = 1;
if (e->timed) rt_log("input: script frame %llu at %.1f ms: %s", (unsigned long long)fr, w / 1000.0, e->text);
else rt_log("input: script frame %llu tick %llu: %s", (unsigned long long)fr, (unsigned long long)tick, e->text);
}
if (e->stick == 3) {
if (e->stick >= 5) quicksave_request(e->stick == 6);
else if (e->stick == 4) script_wheel += e->x;
else if (e->stick == 3) {
int64_t x = (int64_t)script_mouse[0] + e->x, y = (int64_t)script_mouse[1] + e->y;
script_mouse[0] = (int32_t)(x < INT32_MIN ? INT32_MIN : x > INT32_MAX ? INT32_MAX : x);
script_mouse[1] = (int32_t)(y < INT32_MIN ? INT32_MIN : y > INT32_MAX ? INT32_MAX : y);
@@ -239,7 +273,8 @@ static void rec_apply(uint64_t b, const int32_t sl[2], const int32_t sr[2]) {
void input_direct_mouse_sample(int enabled, int32_t *dx, int32_t *dy) {
plat_mutex_lock(&lock);
enabled = enabled && !g_block && !g_menu;
// the moving free camera takes the mouse (freecam_gate)
enabled = enabled && !g_block && !g_menu && freecam_state() != FREECAM_MOVE;
*dx = script_mouse[0]; *dy = script_mouse[1];
script_mouse[0] = script_mouse[1] = 0;
if (!enabled) { *dx = *dy = 0; }
@@ -261,6 +296,17 @@ void input_direct_mouse_sample(int enabled, int32_t *dx, int32_t *dy) {
plat_mutex_unlock(&lock);
}
// A turn of the real wheel as a WHEEL line of the recording (one-shot, as a MOUSE line). Under lock.
static void rec_wheel(int32_t notches) {
if (rec_state != 1) return;
char what[32];
snprintf(what, sizeof what, "WHEEL %d", notches);
int64_t w = frame_step_world_us();
uint64_t tick = frame_step_ticks();
rec_line(tick, w, tick + 1, w, what);
fflush(rec);
}
static float mouse_sens = -1; // TOTK_MOUSE_SENS, 0 = mouse camera off; live (cfg_version)
static unsigned mouse_sens_seen;
@@ -323,6 +369,14 @@ static void walk_get(void) {
static int mouse_selector;
int input_direct_mouse_selector_active(void) { return __atomic_load_n(&mouse_selector, __ATOMIC_RELAXED) != 0; }
// A script's MOUSE line within the last 100 ms (under `lock`): mouse_camera then makes a stick of it
static uint64_t script_mouse_at;
static int input_script_mouse_recent(void) {
uint64_t now = plat_now_ns();
if (script_mouse[0] || script_mouse[1]) script_mouse_at = now;
return script_mouse_at && now - script_mouse_at < 100000000ull;
}
// Selector 1 is a radial wheel, 2..4 are distinct horizontal quick lists; only a wheel retains a virtual cursor.
// Under `lock`.
static void mouse_camera(int32_t out[2], int selector) {
@@ -355,7 +409,10 @@ static void mouse_camera(int32_t out[2], int selector) {
frame = ~0ull;
return; // the camera update takes the raw counts itself, once, outside the HID stick path
}
if (!ikb_captured()) {
// A script's MOUSE lines move the stick as the mouse does, captured or not (in direct mode the camera hook takes
// them, input_direct_mouse_sample): for 100 ms after one the stick is the mouse's, as while captured
int scripted = input_script_mouse_recent();
if (!ikb_captured() && !scripted) {
ikb_mouse_take(&dx, &dy);
held[0] = held[1] = 0;
frame = ~0ull;
@@ -365,6 +422,9 @@ static void mouse_camera(int32_t out[2], int selector) {
if (fr != frame) {
double dt = age < 0.004 ? 0.004 : age > 0.1 ? 0.1 : age;
ikb_mouse_take(&dx, &dy);
if (!ikb_captured()) dx = dy = 0;
dx += script_mouse[0], dy += script_mouse[1];
script_mouse[0] = script_mouse[1] = 0;
input_mouse_stick(dx, dy, dt, mouse_sens_get(), held);
frame = fr;
t0 = now;
@@ -396,21 +456,108 @@ static void stick(SDL_GamepadAxis ax, SDL_GamepadAxis ay, float dead, int32_t ou
input_pad_stick(SDL_GetGamepadAxis(pad, ax), -(int32_t)SDL_GetGamepadAxis(pad, ay), dead, out);
}
// Open the first gamepad when none is open or the open one went away; logs once per change.
// Before SDL_Init: keep the controllers Steam hid (steam_hidden) and let SDL open them. The list is
// "0xVVVV/0xPPPP,..." (SDL's own format). With motion off (TOTK_MOTION=0 at start) Steam's list stays in force.
static void steam_reveal(void) {
const char *e = getenv("SDL_GAMECONTROLLER_IGNORE_DEVICES");
if (!e || !*e || !cfg_bool("TOTK_MOTION")) return;
for (const char *s = e; *s && steam_hidden_n < STEAM_HIDDEN_MAX;) {
unsigned v, p;
int used = 0;
if (sscanf(s, " %x/%x%n", &v, &p, &used) == 2 && used > 0) {
steam_hidden[steam_hidden_n][0] = (uint16_t)v;
steam_hidden[steam_hidden_n][1] = (uint16_t)p;
steam_hidden_n++;
s += used;
}
const char *c = strchr(s, ',');
if (!c) break;
s = c + 1;
}
if (!steam_hidden_n) return;
// The environment outranks a hint of normal priority, so this one overrides it
SDL_SetHintWithPriority(SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES, "", SDL_HINT_OVERRIDE);
rt_log("input: Steam Input hides %d controller type(s); buttons stay on Steam's virtual gamepad, motion is read "
"from the controller itself", steam_hidden_n);
}
// The ids the device itself reports. SDL_GetGamepadVendorForID and ...ProductForID give a Steam virtual pad the ids of
// the controller behind it, which would make it look like a controller Steam hid; the GUID keeps the device's own.
static void raw_ids(SDL_JoystickID id, uint16_t *v, uint16_t *p) {
SDL_GetJoystickGUIDInfo(SDL_GetGamepadGUIDForID(id), v, p, NULL, NULL);
}
static int steam_hidden_id(SDL_JoystickID id) {
uint16_t v, p;
raw_ids(id, &v, &p);
for (int i = 0; i < steam_hidden_n; i++)
if (steam_hidden[i][0] == v && steam_hidden[i][1] == p) return 1;
return 0;
}
// Steam's virtual gamepad: Valve's vendor id with product 0x11ff in the device's own ids (raw_ids; SDL's
// SDL_IsJoystickSteamVirtualGamepad is not public)
static int steam_virtual(SDL_Gamepad *g) {
uint16_t v, p;
raw_ids(SDL_GetGamepadID(g), &v, &p);
return v == 0x28de && p == 0x11ff;
}
static int has_motion(SDL_Gamepad *g) {
return SDL_GamepadHasSensor(g, SDL_SENSOR_GYRO) && SDL_GamepadHasSensor(g, SDL_SENSOR_ACCEL);
}
// A gamepad Steam did not hide is connected (Steam's virtual pad, or another controller).
static int unhidden_pad_present(void) {
int n = 0, found = 0;
SDL_JoystickID *ids = SDL_GetGamepads(&n);
for (int i = 0; ids && i < n && !found; i++) found = !steam_hidden_id(ids[i]);
SDL_free(ids);
return found;
}
// Open the first gamepad when none is open or the open one went away; logs once per change. A controller Steam hid
// (steam_hidden) is taken only when no other gamepad is there, e.g. while Steam's virtual pad is not up yet, and gives
// way to the virtual pad once it is (pad_physical looks again every RESCAN_MS while pad_hidden): otherwise Steam's
// remapping would be lost for the session. The hidden controller then stays open for its sensors (motion_extra), so
// its bias and orientation go on.
static void scan_pads(void) {
if (pad && SDL_GamepadConnected(pad)) return;
if (pad && SDL_GamepadConnected(pad)) {
if (!pad_hidden || !unhidden_pad_present()) return;
rt_log("input: Steam Input's virtual gamepad is up: buttons move to it from \"%s\"", SDL_GetGamepadName(pad));
if (!motion_extra && has_motion(pad)) motion_extra = pad;
else SDL_CloseGamepad(pad);
pad = NULL;
pad_hidden = 0;
plat_xchg32(&rumble_ready, 0);
rumble_cancel();
}
if (pad) {
plat_xchg32(&rumble_ready, 0);
rumble_cancel();
SDL_CloseGamepad(pad); pad = NULL; sensor_pad = 0; sensor_ok = 0;
// Its bias and an attempt collecting from it go with it; the next pad gets its own in pad_bias_select.
motion_bias_reset(motion_global());
calib_pad_name[0] = 0;
plat_xchg32(&pad_layout_shown, -1);
for (int i = 0; i < 4; i++) plat_xchg32(&pad_labels[i], PAD_LABEL_NONE);
rt_log("input: gamepad disconnected");
}
int n = 0;
SDL_JoystickID *ids = SDL_GetGamepads(&n);
for (int i = 0; ids && i < n && !pad; i++) pad = SDL_OpenGamepad(ids[i]);
for (int pass = 0; pass < 2 && !pad; pass++)
for (int i = 0; ids && i < n && !pad; i++)
if (steam_hidden_id(ids[i]) == pass) {
// The controller motion_source holds for its sensors serves as the pad too: one open handle
if (motion_extra && SDL_GetGamepadID(motion_extra) == ids[i]) { pad = motion_extra; motion_extra = NULL; }
else pad = SDL_OpenGamepad(ids[i]);
}
SDL_free(ids);
if (!pad) return;
pad_hidden = steam_hidden_n && steam_hidden_id(SDL_GetGamepadID(pad));
pad_rumble = SDL_GetBooleanProperty(SDL_GetGamepadProperties(pad), SDL_PROP_GAMEPAD_CAP_RUMBLE_BOOLEAN, false);
plat_xchg32(&rumble_ready, pad_rumble);
pad_east_a = SDL_GetGamepadButtonLabel(pad, SDL_GAMEPAD_BUTTON_EAST) == SDL_GAMEPAD_BUTTON_LABEL_A;
for (int i = 0; i < 4; i++) {
SDL_GamepadButtonLabel lb = SDL_GetGamepadButtonLabel(pad, pad_sdl[PAD_SOUTH + i]);
@@ -426,7 +573,10 @@ static void scan_pads(void) {
}
pad_layout = -1;
int motion = SDL_GamepadHasSensor(pad, SDL_SENSOR_GYRO) && SDL_GamepadHasSensor(pad, SDL_SENSOR_ACCEL);
rt_log("input: gamepad \"%s\" (%s, %s, east button %s)", SDL_GetGamepadName(pad), pad_rumble ? "rumble" : "no rumble",
uint16_t rv, rp;
raw_ids(SDL_GetGamepadID(pad), &rv, &rp);
rt_log("input: gamepad \"%s\" %04x:%04x%s (%s, %s, east button %s)", SDL_GetGamepadName(pad), rv, rp,
steam_virtual(pad) ? " Steam Input" : "", pad_rumble ? "rumble" : "no rumble",
motion ? "gyro and accelerometer" : "no motion sensors", pad_east_a ? "labelled A" : "not labelled A");
}
@@ -469,6 +619,20 @@ static void binds_refresh(void) {
// TOTK_TEST_PAD=<lx>,<ly>,<rx>,<ry> (test runs): an SDL virtual gamepad whose sticks rest at these raw SDL axis values
// (-32768..32767, down is +y), attached before the first scan so it is the gamepad the game reads: drift and full
// deflection go through the same mapping and dead zone as a real pad.
// TOTK_TEST_PAD_RUMBLE_MS=<n>: the test gamepad has rumble and each write to it takes n ms (a slow Bluetooth HID write),
// to show that input_rumble does not wait for it. Read with cfg_get, as TOTK_TEST_PAD is: a test variable has no row in
// the settings table, and cfg_int stops the game on a name without one.
static int test_pad_rumble_ms(void) {
const char *e = cfg_get("TOTK_TEST_PAD_RUMBLE_MS");
return e ? atoi(e) : 0;
}
static bool test_pad_rumble(void *userdata, Uint16 low, Uint16 high) {
(void)userdata; (void)low; (void)high;
plat_wait_ns((uint64_t)test_pad_rumble_ms() * 1000000ull);
return true;
}
static void test_pad_attach(void) {
static SDL_Joystick *joy; // kept open: a virtual joystick's axes are set through an open handle
const char *e = cfg_get("TOTK_TEST_PAD");
@@ -484,6 +648,7 @@ static void test_pad_attach(void) {
d.naxes = SDL_GAMEPAD_AXIS_COUNT;
d.nbuttons = SDL_GAMEPAD_BUTTON_COUNT;
d.name = "TotK test gamepad";
if (test_pad_rumble_ms() > 0) d.Rumble = test_pad_rumble;
SDL_JoystickID id = SDL_AttachVirtualJoystick(&d);
joy = id ? SDL_OpenJoystick(id) : NULL;
if (!joy) {
@@ -501,6 +666,14 @@ static void start(void) {
binds_refresh();
const char *e = cfg_get("TOTK_INPUT");
if (e && !strcmp(e, "none")) { state = -1; rt_log("input: disabled (TOTK_INPUT=none)"); return; }
steam_reveal();
// SDL drops gamepad button presses and stick movements (and leaves the polled state unchanged) while its own
// window lacks keyboard focus (SDL_PrivateJoystickShouldIgnoreEvent in SDL_joystick.c; centring and releases
// pass). That applies where the window is SDL's (Linux); the Win32 window on Windows is not an SDL window. The
// game keeps running out of focus by default (TOTK_ASSUME_FOCUS, ov_system.c oe_set_focus), so the gamepad has to
// keep working there. With the setting off the game's main thread waits while unfocused and reads no input, so
// the hint can stay on for the whole run.
SDL_SetHint(SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS, "1");
if (!SDL_Init(SDL_INIT_GAMEPAD)) { state = -1; rt_log("input: SDL gamepad init failed (%s), keyboard only", SDL_GetError()); }
else state = 1;
if (state == 1) test_pad_attach();
@@ -541,58 +714,243 @@ static int32_t shake_stick(int held) {
return (now - from) / SHAKE_SIDE_NS % 2 ? STICK_MAX : -STICK_MAX;
}
// The scroll wheel on the Purah Pad's map, which zooms with the right stick's y (up: in): each notch is a full-tilt
// pulse of MAP_ZOOM_PULSE_NS on that stick with MAP_ZOOM_GAP_NS of neutral after it, so a step of the zoom and a
// held zoom both see one notch as one push. A fast scroll's notches wait their turn (at most MAP_ZOOM_QUEUE), a turn the
// other way drops them. Returns the stick y for this poll, 0 between pulses and off the map. Under lock.
#define MAP_ZOOM_PULSE_NS 100000000ull
#define MAP_ZOOM_GAP_NS 50000000ull
#define MAP_ZOOM_QUEUE 4
static int32_t map_zoom_stick(int32_t notches, int on_map) {
// The scroll wheel (ikb_wheel_take, and an input script's WHEEL lines) as the stick a gamepad player would move:
// - on the Purah Pad's map it zooms: the right stick's y, away from the player zooming in;
// - while a D-pad strip (weapons, shields, bows, materials) is held open it steps the choice: the right stick's x, away
// from the player to the left, towards the player to the right;
// - in a menu with the game's focus box (the inventory, shops, Options, the save list; menu_cursor_menu) it steps the
// focus: the left stick's y, away from the player up;
// - in the Purah Pad's camera (menu_cursor_camera) it zooms: the D-pad's up (away from the player, in) or down, the
// buttons its guide shows for the zoom.
// Each notch is a full-tilt pulse with neutral after it (wheel_timing), so the game sees one notch as one step, and a
// fast scroll's notches wait their turn (at most WHEEL_QUEUE); a turn the other way drops them. A strip's pulse is the
// mouse's (input_direct_mouse_row: 32 ms each way); a menu takes the stick on its own update, a frame of the game's
// 30 Hz or less, so its pulse covers two. Elsewhere, and while the settings menu is open, the notches are dropped.
enum { WHEEL_NONE, WHEEL_MAP, WHEEL_STRIP, WHEEL_MENU, WHEEL_CAMERA };
static const struct { uint64_t pulse_ns, gap_ns; } wheel_timing[] = {
[WHEEL_MAP] = {100000000ull, 50000000ull}, [WHEEL_STRIP] = {32000000ull, 32000000ull},
[WHEEL_MENU] = {70000000ull, 50000000ull}, [WHEEL_CAMERA] = {100000000ull, 50000000ull}};
#define WHEEL_QUEUE 4
#define WHEEL_GAP_NS 300000000ull // a menu's focus gap (a tab switch): queued notches wait this long for its next screen
// The stick value for this poll at the place `where` (WHEEL_*): -STICK_MAX, 0 or STICK_MAX. Under lock.
static int32_t wheel_stick(int32_t notches, int where) {
static int32_t queued, dir;
static uint64_t until; // the end of the pulse (dir != 0) or of the neutral after it
static int place;
static uint64_t until, none_since; // until: the end of the pulse (dir != 0) or of the neutral after it
uint64_t now = plat_now_ns();
if (!on_map) { queued = dir = 0, until = 0; return 0; }
if (where == WHEEL_NONE) {
if (!none_since) none_since = now;
if (now - none_since > WHEEL_GAP_NS) queued = 0, place = WHEEL_NONE;
dir = 0;
return 0;
}
none_since = 0;
if (where != place) queued = dir = 0, until = 0, place = where;
if (notches) {
if (queued && (notches > 0) != (queued > 0)) queued = 0;
queued += notches;
queued = queued > MAP_ZOOM_QUEUE ? MAP_ZOOM_QUEUE : queued < -MAP_ZOOM_QUEUE ? -MAP_ZOOM_QUEUE : queued;
queued = queued > WHEEL_QUEUE ? WHEEL_QUEUE : queued < -WHEEL_QUEUE ? -WHEEL_QUEUE : queued;
}
if (dir) {
if (now < until) return dir * STICK_MAX;
dir = 0, until = now + MAP_ZOOM_GAP_NS;
dir = 0, until = now + wheel_timing[where].gap_ns;
return 0;
}
if (now < until || !queued) return 0;
dir = queued > 0 ? 1 : -1;
queued -= dir;
until = now + MAP_ZOOM_PULSE_NS;
until = now + wheel_timing[where].pulse_ns;
return dir * STICK_MAX;
}
// After the keys, the gamepad and the script: where the wheel goes this poll (b holds the script's D-pad too, so a
// scripted strip takes scripted notches). Under lock.
static void wheel_route(uint64_t *bp, int32_t sl[2], int32_t sr[2]) {
uint64_t b = *bp;
int32_t real = state > 0 ? ikb_wheel_take() : 0, notches = real + script_wheel; // the script's under TOTK_INPUT=none too
script_wheel = 0;
if (menu_is_open()) notches = 0;
if (real && notches) {
__atomic_store_n(&g_kbm_last, 1, __ATOMIC_RELAXED); // the pointer comes to a menu the wheel turns in
rec_wheel(real);
}
// A strip is its D-pad direction held with its screen open; with the menu cursor off (the screens not read,
// menu_cursor_shortcut -1) the buttons alone decide, as for the mouse's selectors
int sc = b & (1ull << B_UP | 1ull << B_LEFT | 1ull << B_RIGHT) && !(b & 1ull << B_L) ? menu_cursor_shortcut() : 0;
int strip = sc == -1 || sc == 1 || (sc == 0 && menu_cursor_strip());
int where = menu_cursor_map() ? WHEEL_MAP
: strip ? WHEEL_STRIP
: menu_cursor_camera() ? WHEEL_CAMERA
: menu_cursor_menu() ? WHEEL_MENU
: WHEEL_NONE;
if (where == WHEEL_MAP && gameplay_tweaks_map_zoom()) where = WHEEL_NONE;
else if (where == WHEEL_STRIP && gameplay_tweaks_strip_wheel(b)) where = WHEEL_NONE;
int32_t v = wheel_stick(notches, where);
if (!v) return;
if (where == WHEEL_CAMERA) *bp |= 1ull << (v > 0 ? B_UP : B_DOWN);
else if (where == WHEEL_MAP) pick(&sr[0], &sr[1], 0, v);
else if (where == WHEEL_STRIP) pick(&sr[0], &sr[1], -v, 0);
else pick(&sl[0], &sl[1], 0, v);
}
// Under lock, state 1: the open gamepad's inputs by position (pd[PAD_*] != 0 held); 0 without a connected gamepad.
static int pad_physical(uint8_t pd[PAD_COUNT]) {
if ((!pad || !SDL_GamepadConnected(pad)) && plat_now_ns() / 1000000u >= next_scan) { next_scan = plat_now_ns() / 1000000u + RESCAN_MS; scan_pads(); }
if ((!pad || !SDL_GamepadConnected(pad) || pad_hidden) && plat_now_ns() / 1000000u >= next_scan) { next_scan = plat_now_ns() / 1000000u + RESCAN_MS; scan_pads(); }
SDL_UpdateGamepads();
if (!pad || !SDL_GamepadConnected(pad)) return 0;
for (int p = PAD_SOUTH; p < PAD_ZL; p++) pd[p] = SDL_GetGamepadButton(pad, pad_sdl[p]);
pd[PAD_ZL] = SDL_GetGamepadAxis(pad, SDL_GAMEPAD_AXIS_LEFT_TRIGGER) > TRIGGER_ON;
pd[PAD_ZR] = SDL_GetGamepadAxis(pad, SDL_GAMEPAD_AXIS_RIGHT_TRIGGER) > TRIGGER_ON;
for (int p = PAD_ZR + 1; p < PAD_COUNT; p++) pd[p] = SDL_GetGamepadButton(pad, pad_sdl[p]); // false without paddles
for (int p = PAD_ZR + 1; p < PAD_COUNT; p++) pd[p] = SDL_GetGamepadButton(pad, pad_sdl[p]); // false without paddles or touchpad
return 1;
}
// Under lock, state 1: the open gamepad's buttons (Switch bits after TOTK_PAD_LAYOUT and the TOTK_BIND_* lines) and
// sticks; 0 without a connected gamepad.
// Under lock: the last pad_read's inputs by position, [PAD_GUIDE] the Home / Guide button (no Switch button), and its
// left and right trigger axes, 0..32767: what the gamepad combos and the free camera read
#define PAD_GUIDE PAD_COUNT
static uint8_t pad_seen[PAD_COUNT + 1];
static int16_t trigger_seen[2];
static int pad_read(uint64_t *b, int32_t sl[2], int32_t sr[2]) {
uint8_t pd[PAD_COUNT] = {0};
if (!pad_physical(pd)) return 0;
if (!pad_physical(pd)) {
memset(pad_seen, 0, sizeof pad_seen);
memset(trigger_seen, 0, sizeof trigger_seen);
return 0;
}
memcpy(pad_seen, pd, sizeof pd);
pad_seen[PAD_GUIDE] = SDL_GetGamepadButton(pad, SDL_GAMEPAD_BUTTON_GUIDE);
trigger_seen[0] = SDL_GetGamepadAxis(pad, SDL_GAMEPAD_AXIS_LEFT_TRIGGER);
trigger_seen[1] = SDL_GetGamepadAxis(pad, SDL_GAMEPAD_AXIS_RIGHT_TRIGGER);
*b |= input_map_pad_buttons(pd, pad_layout_get());
stick(SDL_GAMEPAD_AXIS_LEFTX, SDL_GAMEPAD_AXIS_LEFTY, stick_dead_get(0), sl);
stick(SDL_GAMEPAD_AXIS_RIGHTX, SDL_GAMEPAD_AXIS_RIGHTY, stick_dead_get(1), sr);
return 1;
}
uint32_t input_pad_combo(const char *env, const char *s) {
uint32_t mask = 0;
char name[32];
size_t n = 0;
for (const char *c = s;; c++) {
if (*c && *c != '+' && *c != ' ') {
if (n < sizeof name - 1) name[n++] = *c;
continue;
}
if (n) {
name[n] = 0;
int p = !strcasecmp(name, "guide") || !strcasecmp(name, "home") ? PAD_GUIDE : input_pad_id(name);
if (p == PAD_NONE) {
rt_log("input: %s=%s: %s is not a gamepad button (south east west north lstick rstick "
"l r zl zr start back guide dpad_*, paddles)", env, s, name);
return 0;
}
mask |= 1u << p;
n = 0;
}
if (!*c) break;
}
return mask;
}
// TOTK_FREECAM_PAD (live): the combo that switches the free camera (freecam.c), for example zl+zr+lstick (LT+RT+L3);
// none, the default (the settings table), for no combo. Under lock.
static uint32_t freecam_pad_mask(void) {
static unsigned seen;
static int read;
static uint32_t mask;
unsigned v = cfg_version();
if (read && v == seen) return mask;
read = 1, seen = v;
const char *s = cfg_value("TOTK_FREECAM_PAD");
mask = *s && strcasecmp(s, "none") ? input_pad_combo("TOTK_FREECAM_PAD", s) : 0;
return mask;
}
// TOTK_FREECAM_KEY (live): the key that switches the free camera; none, the default (the settings table), for no key.
// Under lock.
static int freecam_key(void) {
static unsigned seen;
static int read, key;
unsigned v = cfg_version();
if (read && v == seen) return key;
read = 1, seen = v;
const char *s = cfg_value("TOTK_FREECAM_KEY");
key = !*s || !strcasecmp(s, "none") ? KEY_NONE : input_key_id(s);
if (key == KEY_NONE && *s && strcasecmp(s, "none"))
rt_log("input: TOTK_FREECAM_KEY=%s is not a key name (docs/controls.md)", s);
return key;
}
static float trigger_unit(int16_t v) { // 0..1 past a 5 % dead zone
float t = v / 32767.0f;
return t < 0.05f ? 0 : (t - 0.05f) / 0.95f;
}
// The free camera combo, latched like Minus+Plus (input_map.c, chord): once every button of it is down (on the gamepad,
// or pressed by an input script) the free camera steps once (off, move, lock), and the buttons stay hidden from the
// game until all are released; the free camera key steps it on its press. While the free camera moves it gets the
// input and the game gets nothing, so Link stands still: the sticks (the keys' sticks merged into sl and sr), the
// trigger axes or else ZL and ZR as buttons, a press of L or R as a speed click, and the mouse's motion, which
// input_direct_mouse_sample then keeps from the game's camera. ZL, ZR, L and R are the merged Switch buttons, so the
// keys bound to them count. Locked, the game gets the input as it is (freecam.c: the game steers Link by the camera it
// draws). Off for other updates and with the freecam patch set off. Under lock.
static void freecam_gate(uint64_t *b, int32_t sl[2], int32_t sr[2]) {
static int held, key_held, available = -1, shoulder[2];
if (available < 0) available = freecam_available();
uint32_t mask = available ? freecam_pad_mask() : 0, raw = 0;
int layout = pad_layout_get();
for (int p = PAD_SOUTH; p <= PAD_GUIDE; p++) {
if (!(mask >> p & 1)) continue;
// A position counts as down on the gamepad or when the input script presses the Switch buttons it stands for,
// as a gamepad would; the keys bound to those buttons do not (the free camera key is theirs). Home has no
// Switch button: gamepad only.
uint8_t one[PAD_COUNT] = {0};
if (p < PAD_COUNT) one[p] = 1;
if (pad_seen[p] || (p < PAD_COUNT && script_seen & input_map_pad_buttons(one, layout))) raw |= 1u << p;
}
if (!mask) held = 0;
else if (held) held = raw != 0;
else if (raw == mask) {
held = 1;
freecam_cycle();
}
int key = available ? freecam_key() : KEY_NONE;
int key_down = key != KEY_NONE && ikb_foreground() && ikb_down(key);
if (key_down && !key_held) freecam_cycle();
key_held = key_down;
if (available && freecam_state() == FREECAM_MOVE) {
float lt = trigger_unit(trigger_seen[0]), rt = trigger_unit(trigger_seen[1]);
if (*b >> B_ZL & 1) lt = 1;
if (*b >> B_ZR & 1) rt = 1;
FreecamPad fp = {sl[0] / (float)STICK_MAX, sl[1] / (float)STICK_MAX, sr[0] / (float)STICK_MAX,
sr[1] / (float)STICK_MAX, lt, rt};
freecam_pad(&fp);
for (int k = 0; k < 2; k++) {
int down = (int)(*b >> (k ? B_R : B_L) & 1);
if (down && !shoulder[k]) freecam_speed_click(k);
shoulder[k] = down;
}
if (ikb_captured() && ikb_foreground() && input_cursor_allowed()) {
int32_t x, y;
ikb_mouse_take(&x, &y); // what the stick emulation left (none in that mode: it is in sr already)
float deg = 0.08f * mouse_sens_get(); // the game camera's rate a count (mouse_direct.c DEG_PER_COUNT)
if (x || y) freecam_mouse(x * deg, y * deg);
}
*b = 0;
sl[0] = sl[1] = sr[0] = sr[1] = 0;
return;
}
shoulder[0] = shoulder[1] = 1; // a shoulder held when the free camera starts is no click
if (!held) return;
uint8_t sub[PAD_COUNT] = {0};
for (int p = PAD_SOUTH; p < PAD_COUNT; p++) sub[p] = mask >> p & 1;
*b &= ~input_map_pad_buttons(sub, pad_layout_get());
}
int input_pad_stick_percent(double pct[2]) {
int ok = 0;
pct[0] = pct[1] = 0;
@@ -641,6 +999,33 @@ static void poll_merged(uint64_t *buttons, int32_t *lx, int32_t *ly, int32_t *rx
if (!counts || mouse_ignore[k]) down[k] = 0;
}
was_captured = cap;
// On the Purah Pad's map (menu_cursor.c finds it, TOTK_MAP_CLICK) the left mouse button presses A at the
// map's cursor, which the mouse moves there, instead of its binding (Y by default). A press is one or the
// other from the moment it goes down until it is released, so a button held as the map opens or closes
// keeps what it pressed.
static int map_held, map_a;
if (!down[KEY_MOUSE_L]) map_held = map_a = 0;
else if (!map_held) map_held = 1, map_a = menu_cursor_map() && cfg_bool("TOTK_MAP_CLICK");
if (map_a) down[KEY_MOUSE_L] = 0, b |= 1ull << B_A;
// While a dialogue box is on screen (menu_cursor.c, TOTK_DIALOGUE_CLICK) the left mouse button presses B,
// which advances the text and also shows the rest of a line at once, and the right one presses A, instead
// of their bindings: Y by default, which opens the dialogue log there, and ZL. A press is one or the other
// from the moment it goes down until it is released, so a click that closes the last box does not turn
// into an attack while it is still held, and a button held as the box opens does not skip its first line.
// Dialogue choices have the pointer, and their clicks are menu_cursor.c's: a left click there is A.
static const uint8_t click_key[2] = {KEY_MOUSE_L, KEY_MOUSE_R}, click_btn[2] = {B_B, B_A};
static int click_held[2], click_talk[2];
for (int i = 0; i < 2; i++) {
int key = click_key[i];
if (!down[key]) click_held[i] = click_talk[i] = 0;
else if (!click_held[i]) click_held[i] = 1, click_talk[i] = menu_cursor_dialogue();
if (click_talk[i]) down[key] = 0, b |= 1ull << click_btn[i];
}
// The quick save and quick load keys are quicksave's while it is on (quicksave.c): they reach no binding
// then, and do nothing while the settings menu or a text entry is open
if (quicksave_on()) quicksave_keys(down, !g_menu && !g_block);
if (cap && !g_menu && !g_block) gameplay_tweaks_prepare_keys(down, b);
else gameplay_tweaks_reset();
b |= input_map_buttons(down);
int32_t k[2];
walk_get();
@@ -658,13 +1043,10 @@ static void poll_merged(uint64_t *buttons, int32_t *lx, int32_t *ly, int32_t *rx
// Before the screens were read (the menu cursor off) the buttons alone decide, as before.
if (selector && menu_cursor_shortcut() == 0) selector = 0;
mouse_camera(k, selector);
// On the map the left stick moves the cursor and the right one zooms: the mouse moves the cursor there,
// the scroll wheel zooms (map_zoom_stick). Elsewhere the wheel is unbound; its notches are dropped.
int map = menu_cursor_map();
if (map) pick(&sl[0], &sl[1], k[0], k[1]);
// On the map the left stick moves the cursor and the right one zooms: the mouse moves the cursor there
// (the scroll wheel zooms, wheel_route)
if (menu_cursor_map()) pick(&sl[0], &sl[1], k[0], k[1]);
else pick(&sr[0], &sr[1], k[0], k[1]);
int32_t zoom = map_zoom_stick(ikb_wheel_take(), map);
if (zoom) pick(&sr[0], &sr[1], 0, zoom);
int32_t shake = shake_stick(input_map_held(down, B_SHAKE));
if (shake) sr[0] = shake, sr[1] = 0;
// A mouse shake (mouse_direct.c) moves the stick with the mouse, side by side, and lets go when it rests
@@ -678,7 +1060,18 @@ static void poll_merged(uint64_t *buttons, int32_t *lx, int32_t *ly, int32_t *rx
if (pad_used) __atomic_store_n(&g_kbm_last, 0, __ATOMIC_RELAXED);
else if (kbm_used) __atomic_store_n(&g_kbm_last, 1, __ATOMIC_RELAXED);
}
script_apply(&b, sl, sr);
// Without the keyboard and mouse poll above (TOTK_INPUT=none in scripted runs, or the window in the background), a
// script's MOUSE lines still move the right stick wherever the mouse would (mouse_camera)
if (!(state > 0 && ikb_foreground()) && input_script_mouse_recent() && !input_direct_mouse_active()) {
int32_t k[2];
mouse_camera(k, 0);
pick(&sr[0], &sr[1], k[0], k[1]);
}
script_seen = 0;
script_apply(&script_seen, sl, sr);
b |= script_seen;
wheel_route(&b, sl, sr);
gameplay_tweaks_apply(__atomic_load_n(&gfx_counters.frames, __ATOMIC_RELAXED), input_gameplay_active(), &b, &sl[0], &sl[1], &sr[0], &sr[1]);
rec_apply(b, sl, sr);
// Minus and Plus held together (gamepad or keys) open or close the menu and never reach the game
static int combo_held;
@@ -687,6 +1080,7 @@ static void poll_merged(uint64_t *buttons, int32_t *lx, int32_t *ly, int32_t *rx
static int overlay_held; // L3+R3 step the performance overlay (F10)
int overlay = input_overlay_gate(&overlay_held, &b);
sl[0] = st[0], sl[1] = st[1], sr[0] = st[2], sr[1] = st[3];
freecam_gate(&b, sl, sr); // TOTK_FREECAM_PAD steps the free camera, which takes the pad while moving (freecam.c)
plat_mutex_unlock(&lock);
if (toggle) menu_toggle();
if (overlay) menu_perf_cycle();
@@ -710,10 +1104,12 @@ static volatile uint64_t g_block_closed, g_menu_closed;
int input_cursor_allowed(void) {
const char *in = cfg_get("TOTK_INPUT");
return g_block != 1 && g_menu != 1 && mouse_sens_get() > 0 && !(in && !strcmp(in, "none")) && !menu_cursor_pointer();
return g_block != 1 && g_menu != 1 && (gameplay_tweaks_capture_needed() || mouse_sens_get() > 0) &&
!(in && !strcmp(in, "none")) && !menu_cursor_pointer();
}
void input_block(int on) {
if (on) gameplay_tweaks_reset();
if (!on) __atomic_store_n(&g_block_closed, plat_now_ns(), __ATOMIC_RELEASE);
plat_xchg32(&g_block, on ? 1 : 2);
ikb_cursor_update();
@@ -722,6 +1118,7 @@ void input_block(int on) {
// The in-game menu (ui/menu.cpp) blocks the game's input the same way: g_menu 0 closed, 1 open, 2 closed, waiting for
// the release. The cursor is released while it is open, for the menu's mouse.
void input_menu(int open) {
if (open) gameplay_tweaks_reset();
if (!open) __atomic_store_n(&g_menu_closed, plat_now_ns(), __ATOMIC_RELEASE);
plat_xchg32(&g_menu, open ? 1 : 2);
if (!open) ikb_menu_closed(); // the capture before Esc comes back
@@ -748,7 +1145,10 @@ static int blocked(volatile int32_t *flag, volatile uint64_t *closed, const char
void input_poll(uint64_t *buttons, int32_t *lx, int32_t *ly, int32_t *rx, int32_t *ry) {
poll_merged(buttons, lx, ly, rx, ry);
if (!g_block && !g_menu) menu_cursor_poll(buttons);
// While quick load drives the game's load menu the pointer leaves it alone and the game gets only its presses
if (!g_block && !g_menu && !quicksave_busy()) menu_cursor_poll(buttons);
// A quick load under way goes on while the settings menu or a text entry opens: the held picture ends with it
if ((quicksave_busy() || (!g_block && !g_menu)) && quicksave_poll(buttons, lx, ly, rx, ry)) return;
const int32_t axes[4] = {*lx, *ly, *rx, *ry};
int text = blocked(&g_block, &g_block_closed, "text entry", *buttons, axes),
menu = blocked(&g_menu, &g_menu_closed, "menu", *buttons, axes);
@@ -826,17 +1226,83 @@ int input_rumble_triggers_enabled(void) {
return cfg_bool("TOTK_RUMBLE_TRIGGERS");
}
int input_rumble(uint16_t low, uint16_t high, uint32_t ms) {
int ok = 0;
static int triggers = -1;
static unsigned seen;
if (triggers < 0 || seen != cfg_version()) seen = cfg_version(), triggers = input_rumble_triggers_enabled();
// The rumble worker. input_rumble only stores the newest request (rq) and wakes the worker; the worker sends it to the
// gamepad. A Bluetooth HID write can block for tens of milliseconds, and the callers are the guest thread that runs
// SendVibrationValue and every path that takes `lock`, so no SDL rumble call is made on them. Requests that pile up
// while the worker is in a write are dropped except the newest (Savage Wind Recomp, commit a8ad674, does the same for
// issue #730).
//
// The worker takes its own handle on the open gamepad under `lock` (SDL_OpenGamepad of an open pad's id returns the same
// object with its reference count raised) and releases `lock` before the write, so a scan_pads close of `pad` meanwhile
// only drops one reference and the object lives until the worker's SDL_CloseGamepad. SDL itself serialises the write
// with its other joystick calls (SDL_RumbleJoystick runs under the joystick lock), so a poll or motion_main's
// SDL_UpdateGamepads that lands inside a slow write still waits for it; the thread that sends rumble and the other
// `lock` users that make no SDL gamepad call do not.
typedef struct { uint16_t low, high; uint32_t ms; int pending; } RumbleReq;
static PlatMutex rq_lock = PLAT_MUTEX_INIT; // guards rq, rumble_stop and rumble_thread; taken after `lock`, never before it
static PlatCond rq_cond = PLAT_COND_INIT;
static RumbleReq rq;
static int rumble_stop;
static PlatThread *rumble_thread;
static void rumble_write(uint16_t low, uint16_t high, uint32_t ms) {
SDL_Gamepad *g = NULL;
int triggers = input_rumble_triggers_enabled();
plat_mutex_lock(&lock);
if (state == 1 && pad && pad_rumble) {
ok = SDL_RumbleGamepad(pad, low, high, ms);
if (triggers) SDL_RumbleGamepadTriggers(pad, high, high, ms); // unsupported pads return false: ignored
}
if (state == 1 && pad && pad_rumble) g = SDL_OpenGamepad(SDL_GetGamepadID(pad));
plat_mutex_unlock(&lock);
if (!g) return;
SDL_RumbleGamepad(g, low, high, ms);
if (triggers) SDL_RumbleGamepadTriggers(g, high, high, ms); // unsupported pads return false: ignored
SDL_CloseGamepad(g);
}
static void rumble_main(void *arg) {
(void)arg;
plat_mutex_lock(&rq_lock);
for (;;) {
while (!rq.pending && !rumble_stop) plat_cond_wait(&rq_cond, &rq_lock);
if (!rq.pending) break;
RumbleReq r = rq;
rq.pending = 0;
plat_mutex_unlock(&rq_lock);
rumble_write(r.low, r.high, r.ms);
plat_mutex_lock(&rq_lock);
}
plat_mutex_unlock(&rq_lock);
}
// Stops the motors and the worker at exit: a pad keeps its last request running for its duration otherwise.
static void rumble_exit(void) {
plat_mutex_lock(&rq_lock);
PlatThread *t = rumble_thread;
rq = (RumbleReq){0, 0, 0, 1};
rumble_stop = 1;
plat_cond_signal(&rq_cond);
plat_mutex_unlock(&rq_lock);
if (t) plat_thread_join_ns(t, 300000000ull); // a write stuck past this is left to the exit
}
// Drops the request that has not been sent yet (the gamepad it was for went away). A request in flight holds its own
// handle and ends by itself. Under lock.
static void rumble_cancel(void) {
plat_mutex_lock(&rq_lock);
rq.pending = 0;
plat_mutex_unlock(&rq_lock);
}
int input_rumble(uint16_t low, uint16_t high, uint32_t ms) {
int ok = __atomic_load_n(&rumble_ready, __ATOMIC_ACQUIRE);
if (!ok) return 0;
plat_mutex_lock(&rq_lock);
if (!rumble_thread && !rumble_stop) {
rumble_thread = plat_thread_new(rumble_main, NULL, "rumble");
if (!rumble_thread) rt_fatal("input: cannot start the rumble thread");
atexit(rumble_exit);
}
rq = (RumbleReq){low, high, ms, 1};
plat_cond_signal(&rq_cond);
plat_mutex_unlock(&rq_lock);
return ok;
}
@@ -856,21 +1322,120 @@ void input_motion_axes(const float a[3], const float g[3], double acc[3], double
gyro[2] = g[1];
}
// Under lock: (re)enable the sensors when the open gamepad changed; 1 if it has both and they are on.
static int sensors_ready(void) {
SDL_JoystickID id = SDL_GetGamepadID(pad);
// Copy a controller name into cap bytes without splitting a UTF-8 sequence: a name cut mid-character would show as
// garbage in the menu and be written to totk.ini the same way.
static void copy_name(char *dst, size_t cap, const char *src) {
if (!src) src = "";
size_t n = strlen(src);
if (n >= cap) {
n = cap - 1;
while (n > 0 && ((unsigned char)src[n] & 0xC0) == 0x80) n--; // back off to the start of the character
}
memcpy(dst, src, n);
dst[n] = 0;
}
// Under lock: the identity of src (motion_source) for the saved bias. Its name, plus a hash of SDL's serial when the pad
// reports one (Switch and PlayStation pads report their Bluetooth address), so two controllers of one model keep their
// own bias; the hash keeps the address out of totk.ini and the log, which players post with bug reports.
static void pad_identity(SDL_Gamepad *src, char *dst, size_t cap) {
const char *name = SDL_GetGamepadName(src), *serial = SDL_GetGamepadSerial(src);
char id[160];
if (serial && *serial) {
uint32_t h = 2166136261u; // FNV-1a
for (const char *c = serial; *c; c++) h = (h ^ (uint8_t)*c) * 16777619u;
snprintf(id, sizeof id, "%s #%08x", name ? name : "", h);
} else snprintf(id, sizeof id, "%s", name ? name : "");
// Steam's virtual pad takes the name of the controller behind it but sends Steam's corrected motion: its bias
// is its own (pad_bias_select would otherwise load the raw controller's)
// A controller read past Steam Input sends what Steam set it to: on the Steam Controller that is motion the
// controller already corrected, so the bias of the same controller read with Steam closed does not apply either
if (steam_virtual(src)) strncat(id, " (Steam Input)", sizeof id - strlen(id) - 1);
else if (steam_hidden_n && steam_hidden_id(SDL_GetGamepadID(src)))
strncat(id, " (under Steam)", sizeof id - strlen(id) - 1);
copy_name(dst, cap, id);
}
// Under lock, for each gamepad the sensor code sees (a first one, or one connected after another went away): the
// previous controller's bias and any attempt still collecting from it are dropped, then the bias saved in totk.ini is
// taken when gyro_bias_pad names this controller. It is taken with gyro_calibration off too: the switch only decides
// whether motion_feed subtracts it, so turning the switch on mid-run applies the saved bias.
static void pad_bias_select(SDL_Gamepad *src) {
char id[128];
pad_identity(src, id, sizeof id);
motion_bias_reset(motion_global());
calib_pad_name[0] = 0;
const char *saved = cfg_get("TOTK_GYRO_BIAS_PAD");
if (saved && !strcmp(saved, id)) {
motion_bias_load(motion_global());
copy_name(calib_pad_name, sizeof calib_pad_name, SDL_GetGamepadName(src));
rt_log("input: gyro bias loaded from totk.ini for %s", calib_pad_name);
}
}
// Under lock: the gamepad the sensors are read from, NULL without one. The open pad when it has a gyro and an
// accelerometer, or when Steam hid nothing. Otherwise (Steam's virtual pad, which has neither) the first controller
// Steam hid that has both, looked for once a RESCAN_MS; one without them is not opened again until it reconnects.
static SDL_Gamepad *motion_source(void) {
static SDL_JoystickID rejected[8];
if (motion_extra && !SDL_GamepadConnected(motion_extra)) {
rt_log("input: \"%s\" (motion only) disconnected", SDL_GetGamepadName(motion_extra));
SDL_CloseGamepad(motion_extra);
motion_extra = NULL;
}
int pad_on = pad && SDL_GamepadConnected(pad);
// Newer Steam clients give the virtual pad motion too, but already corrected by Steam (and gated by the layout's
// gyro settings), so the bias calibrated on the raw controller would count twice and the camera drift. Under
// Steam Input the real controller's raw sensors come first; the virtual pad's are the fallback.
if (pad_on && has_motion(pad) && !(steam_hidden_n && steam_virtual(pad))) {
if (motion_extra) { SDL_CloseGamepad(motion_extra); motion_extra = NULL; }
return pad;
}
if (!motion_extra && steam_hidden_n && plat_now_ns() / 1000000u >= next_motion_scan) {
next_motion_scan = plat_now_ns() / 1000000u + RESCAN_MS;
int n = 0;
SDL_JoystickID *ids = SDL_GetGamepads(&n), skip = pad_on ? SDL_GetGamepadID(pad) : 0;
for (int i = 0; ids && i < n && !motion_extra; i++) {
int seen = 0;
for (int r = 0; r < 8; r++) seen |= rejected[r] == ids[i];
if (ids[i] == skip || seen || !steam_hidden_id(ids[i])) continue;
SDL_Gamepad *g = SDL_OpenGamepad(ids[i]);
if (g && has_motion(g)) {
motion_extra = g;
rt_log("input: motion from \"%s\" (%04x:%04x), the controller behind Steam Input's virtual gamepad",
SDL_GetGamepadName(g), SDL_GetGamepadVendor(g), SDL_GetGamepadProduct(g));
} else {
if (g) SDL_CloseGamepad(g);
memmove(rejected + 1, rejected, sizeof rejected - sizeof rejected[0]);
rejected[0] = ids[i];
}
}
SDL_free(ids);
}
return motion_extra ? motion_extra : pad_on ? pad : NULL;
}
// Under lock: (re)enable the sensors when the motion source changed; 1 if it has both and they are on.
static int sensors_ready(SDL_Gamepad *src) {
SDL_JoystickID id = SDL_GetGamepadID(src);
if (id == sensor_pad) return sensor_ok;
sensor_pad = id;
pad_bias_select(src);
// Nothing drains the SDL event queue: no event per sample (the data still updates, SDL_SendJoystickSensor)
SDL_SetEventEnabled(SDL_EVENT_GAMEPAD_SENSOR_UPDATE, false);
sensor_ok =SDL_GamepadHasSensor(pad, SDL_SENSOR_GYRO) && SDL_GamepadHasSensor(pad, SDL_SENSOR_ACCEL) &&
SDL_SetGamepadSensorEnabled(pad, SDL_SENSOR_GYRO, true) &&
SDL_SetGamepadSensorEnabled(pad, SDL_SENSOR_ACCEL, true);
if (sensor_ok) rt_log("input: motion sensors on (gyro %.0f Hz, accelerometer %.0f Hz)",
(double)SDL_GetGamepadSensorDataRate(pad, SDL_SENSOR_GYRO),
(double)SDL_GetGamepadSensorDataRate(pad, SDL_SENSOR_ACCEL));
sensor_ok = has_motion(src) &&
SDL_SetGamepadSensorEnabled(src, SDL_SENSOR_GYRO, true) &&
SDL_SetGamepadSensorEnabled(src, SDL_SENSOR_ACCEL, true);
if (sensor_ok) {
rt_log("input: motion sensors on (gyro %.0f Hz, accelerometer %.0f Hz)",
(double)SDL_GetGamepadSensorDataRate(src, SDL_SENSOR_GYRO),
(double)SDL_GetGamepadSensorDataRate(src, SDL_SENSOR_ACCEL));
motion_restart(motion_global()); // another controller: its own orientation, from its first reading
} else if (has_motion(src)) // after PR #1024: the SDL error, not "no sensors", when enabling them failed
rt_log("input: \"%s\" has a gyro and an accelerometer but SDL could not turn them on (%s): the six-axis sensor "
"reads a controller at rest", SDL_GetGamepadName(src), SDL_GetError());
else rt_log("input: \"%s\" has no gyro and accelerometer: the six-axis sensor reads a controller at rest",
SDL_GetGamepadName(pad));
SDL_GetGamepadName(src));
return sensor_ok;
}
@@ -895,10 +1460,11 @@ static void motion_main(void *arg) {
float a[3], g[3];
int have = 0;
plat_mutex_lock(&lock);
if (pad && SDL_GamepadConnected(pad)) {
SDL_Gamepad *src = motion_source();
if (src) {
SDL_UpdateGamepads();
have = sensors_ready() && SDL_GetGamepadSensorData(pad, SDL_SENSOR_ACCEL, a, 3) &&
SDL_GetGamepadSensorData(pad, SDL_SENSOR_GYRO, g, 3);
have = sensors_ready(src) && SDL_GetGamepadSensorData(src, SDL_SENSOR_ACCEL, a, 3) &&
SDL_GetGamepadSensorData(src, SDL_SENSOR_GYRO, g, 3);
}
plat_mutex_unlock(&lock);
if (!have || !input_motion_enabled()) continue;
@@ -908,16 +1474,54 @@ static void motion_main(void *arg) {
}
}
// Under lock: the sensor thread, once; -1 when SDL is not running.
static void motion_thread_start(void) {
if (!state) start();
if (motion_thread) return;
if (!input_motion_enabled()) rt_log("input: motion off (TOTK_MOTION=0); it can be turned on while the game runs");
if (state != 1) motion_thread = -1;
else {
if (!plat_thread_spawn(motion_main, NULL, "motion", 0)) rt_fatal("input: cannot start the motion thread");
motion_thread = 1;
}
}
void input_motion_start(void) {
plat_mutex_lock(&lock);
if (!state) start();
if (!motion_thread) {
if (!input_motion_enabled()) rt_log("input: motion off (TOTK_MOTION=0); it can be turned on while the game runs");
if (state != 1) motion_thread = -1;
else {
if (!plat_thread_spawn(motion_main, NULL, "motion", 0)) rt_fatal("input: cannot start the motion thread");
motion_thread = 1;
}
motion_thread_start();
plat_mutex_unlock(&lock);
}
void input_motion_calibrate(void) {
plat_mutex_lock(&lock);
// The menu can run before the game starts the six-axis sensor (the title screen): the thread starts here then.
if (input_gyro_calibration_enabled() && input_motion_enabled()) motion_thread_start();
const char *why = NULL;
SDL_Gamepad *src = motion_thread == 1 ? motion_source() : NULL;
if (!input_gyro_calibration_enabled()) why = "gyro_calibration is off";
else if (!input_motion_enabled()) why = "motion is off (TOTK_MOTION=0)";
else if (motion_thread != 1) why = "no SDL gamepad support";
else if (!src) why = "no gamepad";
// sensors_ready here, not at the sensor thread's next look at a new pad: that look selects the pad's bias and
// would cancel the attempt that starts below.
else if (!sensors_ready(src)) why = "the gamepad has no gyro and accelerometer";
if (why) rt_log("input: calibrate gyro ignored: %s", why);
else {
char id[128];
pad_identity(src, id, sizeof id);
copy_name(calib_pad_name, sizeof calib_pad_name, SDL_GetGamepadName(src));
motion_calibrate_start(motion_global(), id, kern_now_ns());
rt_log("input: gyro calibration started on %s", calib_pad_name);
}
plat_mutex_unlock(&lock);
}
int input_gyro_calibration_enabled(void) { return motion_calibration_enabled(); }
int input_motion_calib_state(char *pad, size_t cap) {
plat_mutex_lock(&lock);
int st = motion_thread == 1 ? motion_calib_poll(motion_global(), kern_now_ns()) : MOTION_CALIB_NONE;
if (pad && cap) snprintf(pad, cap, "%s", calib_pad_name);
plat_mutex_unlock(&lock);
return st;
}
+83
View File
@@ -28,6 +28,20 @@ uint64_t input_buttons_last(void);
// mouse_direct.c: the right stick's side a mouse shake gives while Ultrahand holds an object (-1 / +1), 0 while the
// mouse does not shake; input.c puts it on the stick
int input_direct_mouse_shake(void);
enum {
INPUT_CAM_UNCLASSIFIED = 0,
INPUT_CAM_FREE_ROAM,
INPUT_CAM_AIM,
INPUT_CAM_SCOPE,
INPUT_CAM_LOCK_ON,
INPUT_CAM_MENU_WHEEL,
INPUT_CAM_ABILITY,
INPUT_CAM_ULTRAHAND_OBJECT,
INPUT_CAM_VEHICLE,
INPUT_CAM_DISABLED,
};
int input_camera_context(void);
int input_gameplay_active(void);
// menu_cursor.c: the L ability wheel or a D-pad strip has the focus: 1 / 0, -1 with the menu cursor off (not read)
int menu_cursor_shortcut(void);
// menu_cursor.c: the pointer in the game's menus (1.4.3). poll: once per pad read, adds a click's A or B; pointer: a
@@ -35,6 +49,36 @@ int menu_cursor_shortcut(void);
void menu_cursor_poll(uint64_t *buttons);
int menu_cursor_pointer(void);
int menu_cursor_map(void); // the Purah Pad's map is open: the mouse's stick is the left one (its cursor)
// a dialogue box is on screen and TOTK_DIALOGUE_CLICK is on: left click is B, right click A (input.c poll_merged)
int menu_cursor_dialogue(void);
// A menu screen (not the ability wheel, a D-pad strip or the map) has the game's focus box, whichever device was used
// last: input.c turns the scroll wheel into steps of its focus. 0 with the menu cursor off.
int menu_cursor_menu(void);
// A D-pad strip's screen (ShortCut_00) is open; it has no focus box while held. 0 with the menu cursor off.
int menu_cursor_strip(void);
// The Purah Pad's camera is open: its frame and pointer without the map the Scope has. 0 with the menu cursor off.
int menu_cursor_camera(void);
// menu_cursor.c, the game's menus by name for quicksave.c (game thread, 1.4.3): a screen of that layout is open; the
// screen with the focus box (its layout name) and the focused node, 0 with none; the focused screen's shown button of
// parts layout parts with root pane root (usable_out: it can be pressed), 0 none; the load list's first entry with a
// save; the focus to node (1 once it is there)
int menu_ui_open(const char *layout);
int menu_ui_focus(char *screen, size_t n, uint64_t *node);
uint64_t menu_ui_button(const char *parts, const char *root, int *usable_out);
uint64_t menu_ui_first_save(void);
int menu_ui_focus_to(uint64_t node);
// quicksave.c (TOTK_QUICKSAVE): keys: the keys held now, its two keys (TOTK_QUICKSAVE_KEY, TOTK_QUICKLOAD_KEY) start
// it when pressed and act is set, and are cleared from down either way; request: save (0) or load (1), as the keys
// and the script lines QUICKSAVE / QUICKLOAD do; guest: once per game pad read on the game thread, where quick save
// calls into the game; poll: once per game pad read, 1 while quick load drives the game's load menu with its own
// presses in place of the input; busy: quick load runs
struct Cpu;
int quicksave_on(void); // TOTK_QUICKSAVE is on and the game is 1.4.3
void quicksave_keys(uint8_t *down, int act);
void quicksave_request(int load);
void quicksave_guest(struct Cpu *c);
int quicksave_poll(uint64_t *buttons, int32_t *lx, int32_t *ly, int32_t *rx, int32_t *ry);
int quicksave_busy(void);
// The same for host UI (the text entry): never blocked. input_block(1) while a text entry is open: input_poll then
// reports nothing; input_block(0) when it closes: nothing until all buttons and stick directions are released.
void input_poll_ui(uint64_t *buttons, int32_t *lx, int32_t *ly, int32_t *rx, int32_t *ry);
@@ -47,9 +91,25 @@ void input_menu(int open);
// of the combo, sticks are lx, ly, rx, ry. Returns 1 in the poll where the combo goes down (toggle the menu once).
int input_menu_gate(int *held, int menu_open, uint64_t *buttons, int32_t sticks[4]);
int input_overlay_gate(int *held, uint64_t *buttons); // L3+R3: 1 in the poll both go down
// A gamepad combo setting: buttons by position joined with '+' (guide+south: Home and the bottom face button, the
// pad: names of the bind_ lines plus guide or home). Bit p is PAD_* p, bit PAD_COUNT the Home button; 0 for an empty
// value or one with a name that is no button, which logs a line naming env.
uint32_t input_pad_combo(const char *env, const char *s);
int input_pad_read(uint64_t *buttons, int32_t *lx, int32_t *ly);
// The gamepad layout in effect (PAD_LAYOUT_*, input_map.h; TOTK_PAD_LAYOUT, live); -1 without a gamepad. Any thread.
int input_pad_layout(void);
// Free camera (freecam.c). input.c steps it with TOTK_FREECAM_PAD and, while it moves, hands it the gamepad and gives
// the game none: sticks -1..1 with up +y after the dead zone, triggers 0..1; each L or R press is one speed click.
// Locked, the view stays and the game gets the input.
typedef struct { float lx, ly, rx, ry, lt, rt; } FreecamPad;
enum { FREECAM_OFF, FREECAM_MOVE, FREECAM_LOCK };
int freecam_available(void); // game 1.4.3 with the freecam patch set on
int freecam_state(void); // FREECAM_*
void freecam_cycle(void); // off, move, lock, off; logs; input thread
void freecam_pad(const FreecamPad *p);
void freecam_speed_click(int faster); // R (1) doubles the speed, L (0) halves it
void freecam_mouse(double right_deg, double down_deg); // a turn from the mouse, added at the next step
// How far the open gamepad's left (pct[0]) and right (pct[1]) sticks are from the centre now, in percent of full
// deflection, before the dead zone: the menu shows it on the dead zone rows, so a drifting stick's resting value can be
// read off. 0 (and both 0) without a connected gamepad. Any thread.
@@ -91,6 +151,23 @@ int input_rumble_triggers_enabled(void);
void input_motion_start(void);
// TOTK_MOTION is not "0" (a live setting: read again when cfg_version changes). Off: the sensor reads at rest.
int input_motion_enabled(void);
// The Controls tab's Calibrate gyro row: start a bias measurement on the open gamepad (starts the sensor thread when
// the game has not yet). Callable from any thread.
void input_motion_calibrate(void);
// What the Calibrate gyro row shows (MOTION_CALIB_*): NONE no bias for this controller, COLLECTING, DONE a bias in
// effect (measured in this run or loaded from totk.ini), FAILED the last attempt got no samples and no bias is in
// effect, MOVED the last attempt was rejected because the controller moved. pad receives the name of the controller the
// bias belongs to (empty when none), copied so the caller does not read a buffer another thread may be rewriting.
enum { MOTION_CALIB_NONE, MOTION_CALIB_COLLECTING, MOTION_CALIB_DONE, MOTION_CALIB_FAILED, MOTION_CALIB_MOVED };
int input_motion_calib_state(char *pad, size_t cap);
// The bias's own switch (gyro_calibration, live). Off: no collection, the fusion takes the raw gyro, and the row's
// state reads as before any calibration while the saved keys stay in totk.ini.
int input_gyro_calibration_enabled(void);
// The fusion's own read of the same switch (motion_fusion.c); input.c reaches it for the row's state.
int motion_calibration_enabled(void);
// The drift tracker's switch (gyro_auto_bias, live): the drift left after calibration, learned while the controller
// lies still, is subtracted too.
int motion_auto_bias_enabled(void);
// SDL sensor values (accelerometer m/s^2, gyro rad/s, SDL gamepad axes) to the Switch controller frame motion_feed
// takes (acceleration in G as gravity reads, rotation rad/s). The mapping is documented in input_win.c.
void input_motion_axes(const float sdl_acc[3], const float sdl_gyro[3], double acc_g[3], double gyro[3]);
@@ -108,3 +185,9 @@ MotionFusion *motion_global(void); // the gamepad's, fed by input_win.c
void motion_feed(MotionFusion *m, const double acc_g[3], const double gyro_rad_s[3], uint64_t now_ns);
int motion_read(MotionFusion *m, MotionState *out, int max, uint64_t now_ns); // newest first; 0 = none in 200 ms
void motion_restart(MotionFusion *m); // angle and direction start over at the next sample
// Start a bias measurement at now_ns: samples while the controller rests, then the bias or a rejection (MOTION_CALIB_*).
// pad is the controller's identity, written to totk.ini with the bias.
void motion_calibrate_start(MotionFusion *m, const char *pad, uint64_t now_ns);
int motion_calib_poll(MotionFusion *m, uint64_t now_ns); // MOTION_CALIB_*; ends an attempt whose samples stopped
void motion_bias_load(MotionFusion *m); // take the bias from totk.ini (TOTK_GYRO_BIAS_*)
void motion_bias_reset(MotionFusion *m); // no bias and no attempt (another controller)
+12 -6
View File
@@ -44,7 +44,8 @@ static const char *const action_names[ACTION_COUNT] = {
"LSTICK_LEFT", "LSTICK_UP", "LSTICK_RIGHT", "LSTICK_DOWN", "RSTICK_LEFT", "RSTICK_UP", "RSTICK_RIGHT", "RSTICK_DOWN", "SHAKE"};
static const char *const pad_names[PAD_COUNT] = {
NULL, "south", "east", "west", "north", "lstick", "rstick", "l", "r", "start", "back",
"dpad_left", "dpad_up", "dpad_right", "dpad_down", "zl", "zr", "lpaddle1", "rpaddle1", "lpaddle2", "rpaddle2"};
"dpad_left", "dpad_up", "dpad_right", "dpad_down", "zl", "zr", "lpaddle1", "rpaddle1", "lpaddle2", "rpaddle2",
"touchpad"};
static const char *const key_names[KEY_COUNT] = { // each group starts at its id; the ids of a group are consecutive
[KEY_A] = "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u",
"v", "w", "x", "y", "z",
@@ -65,13 +66,13 @@ const char *input_pad_name(int pad) { return pad > PAD_NONE && pad < PAD_COUNT ?
void input_map_reset(void) { input_map = defaults; }
static int key_id(const char *name) {
int input_key_id(const char *name) {
for (int k = KEY_A; k < KEY_COUNT; k++)
if (key_names[k] && !strcasecmp(key_names[k], name)) return k;
return KEY_NONE;
}
static int pad_id(const char *name) {
int input_pad_id(const char *name) {
for (int p = PAD_SOUTH; p < PAD_COUNT; p++)
if (!strcasecmp(pad_names[p], name)) return p;
return PAD_NONE;
@@ -132,12 +133,12 @@ int input_map_bind(const char *button, const char *list) {
int ok = 0;
if (!strncasecmp(tok, "pad:", 4) && action < B_SL_LEFT) {
const char *name = trim(tok + 4);
int p = pad_id(name);
int p = input_pad_id(name);
if (!strcasecmp(name, "default")) pad_def = ok = 1;
else if (p && np < INPUT_PAD_BINDING_MAX) pads[np++] = (uint8_t)p, ok = 1;
} else if (!strncasecmp(tok, "key:", 4)) {
const char *name = trim(tok + 4);
int k = key_id(name);
int k = input_key_id(name);
if (!strcasecmp(name, "default")) key_def = ok = 1;
else if (k && nk < INPUT_BINDING_MAX) keys[nk++] = (uint8_t)k, ok = 1;
}
@@ -306,12 +307,17 @@ int input_pad_layout_pick(const char *setting, int east_labelled_a) {
int input_prompts_pick(const char *prompts, const char *pad_layout) {
if (prompts && *prompts)
return !strcasecmp(prompts, "xbox") ? PROMPTS_XBOX : !strcasecmp(prompts, "pc") ? PROMPTS_PC : PROMPTS_NINTENDO;
return !strcasecmp(prompts, "xbox") ? PROMPTS_XBOX
: !strcasecmp(prompts, "playstation") || !strcasecmp(prompts, "ps") ? PROMPTS_PLAYSTATION
: !strcasecmp(prompts, "pc") ? PROMPTS_PC : PROMPTS_NINTENDO;
return pad_layout && !strcasecmp(pad_layout, "xbox_prompts") ? PROMPTS_XBOX : PROMPTS_NINTENDO;
}
const char *input_prompts_folder(int prompts, const char *pad_layout) {
if (prompts == PROMPTS_PC) return "romfs-patches-pc";
if (prompts == PROMPTS_PLAYSTATION)
return input_pad_layout_pick(pad_layout, 0) == PAD_LAYOUT_NINTENDO ? "romfs-patches-playstation"
: "romfs-patches-playstation-xbox";
if (prompts != PROMPTS_XBOX) return NULL;
// The folders are read at start, before a pad is open: auto counts as Xbox, as for a pad without Nintendo labels.
// A Nintendo-labelled pad under auto plays by label too (its A is on the button labelled A), so it matches as well.
+16 -10
View File
@@ -37,13 +37,14 @@ enum {
// Gamepad inputs by position (Nintendo layout, as SDL names them), platform-neutral like the key ids. ZL and ZR are the
// analog triggers; input_win.c translates SDL buttons and axes to these (one place). The paddles are the back buttons
// of an Xbox Elite, DualSense Edge or Steam Controller (SDL's LEFT_PADDLE1 and so on); no Switch button has them by
// default, a bind line or the remapping rows add them.
// of an Xbox Elite, DualSense Edge or Steam Controller (SDL's LEFT_PADDLE1 and so on), the touchpad is the click of a
// DualSense or DualShock 4 touchpad (SDL's TOUCHPAD); no Switch button has them by default, a bind line or the
// remapping rows add them. A pad without one never reports it held.
enum {
PAD_NONE = 0,
PAD_SOUTH, PAD_EAST, PAD_WEST, PAD_NORTH, PAD_LSTICK, PAD_RSTICK, PAD_L, PAD_R, PAD_START, PAD_BACK,
PAD_DPAD_LEFT, PAD_DPAD_UP, PAD_DPAD_RIGHT, PAD_DPAD_DOWN, PAD_ZL, PAD_ZR,
PAD_LPADDLE1, PAD_RPADDLE1, PAD_LPADDLE2, PAD_RPADDLE2,
PAD_LPADDLE1, PAD_RPADDLE1, PAD_LPADDLE2, PAD_RPADDLE2, PAD_TOUCHPAD,
PAD_COUNT
};
@@ -72,6 +73,8 @@ void input_map_reset(void);
// stick directions the keys drive), then SHAKE. Keys: a-z 0-9 space tab lshift ... (key_names in input_map.c). Pads: south east ...
const char *input_action_name(int action);
const char *input_key_name(int key);
int input_key_id(const char *name); // KEY_NONE for a name without a key
int input_pad_id(const char *name); // PAD_NONE for a name without a gamepad button
const char *input_pad_name(int pad);
// Replaces every binding of the action `button` (an action name) with `list`: comma separated "pad:<name>" and
// "key:<name>" entries, "key:default" / "pad:default" for that part's defaults, or "none" for no input. A part the list
@@ -90,18 +93,21 @@ int input_pad_layout_pick(const char *setting, int east_labelled_a);
// Button prompts (TOTK_PROMPTS): the controller whose buttons the game's prompts show. Nintendo: the game's own. Xbox:
// LB RB LT RT, Menu, View and a d-pad cross for the other buttons, and the face buttons named by the label of the
// button the pad layout presses (runtime/romfs.c overlay_init, tools/make_romfs_patches.py --prompts). PC: the key or
// button the pad layout presses (runtime/romfs.c overlay_init, tools/make_romfs_patches.py --prompts). PlayStation: the
// face buttons as ○ × △ □, L1 R1 L2 R2, Options and Share, likewise on the button the pad layout presses. PC: the key or
// mouse button the keyboard defaults press each button with, the mouse for the right stick.
enum { PROMPTS_NINTENDO, PROMPTS_XBOX, PROMPTS_PC };
// The prompts for a TOTK_PROMPTS value ("nintendo", "xbox" or "pc", any case). Unset or empty: Xbox while the pad
// layout setting is "xbox_prompts", else Nintendo.
enum { PROMPTS_NINTENDO, PROMPTS_XBOX, PROMPTS_PLAYSTATION, PROMPTS_PC };
// The prompts for a TOTK_PROMPTS value ("nintendo", "xbox", "playstation" or "pc", any case). Unset or empty: Xbox
// while the pad layout setting is "xbox_prompts", else Nintendo.
int input_prompts_pick(const char *prompts, const char *pad_layout);
// The folder next to romfs-index.bin that holds those prompts for a TOTK_PAD_LAYOUT value, NULL for the game's own. The
// Nintendo layout plays an Xbox pad by position, so its folder names the face buttons the other way round
// (romfs-patches-xbox: the right button does A and is labelled B); xbox and auto put every Switch button on the button
// labelled with its letter (auto picks the layout per pad by its labels), so they share romfs-patches-xbox-label. The PC
// prompts follow no pad: romfs-patches-pc whatever the layout (romfs.c overlay_init serves romfs-patches-pc-<w>x<h>
// under that name at a game resolution of another shape).
// labelled with its letter (auto picks the layout per pad by its labels), so they share romfs-patches-xbox-label. The
// PlayStation prompts have the same two folders: romfs-patches-playstation (Nintendo layout, A on the right button is
// circle) and romfs-patches-playstation-xbox (xbox and auto, A on the bottom button is cross). The PC prompts follow no
// pad: romfs-patches-pc whatever the layout (romfs.c overlay_init serves romfs-patches-pc-<w>x<h> under that name at a
// game resolution of another shape).
const char *input_prompts_folder(int prompts, const char *pad_layout);
// down[pad] != 0 for the gamepad inputs held. Returns the Switch button bits (0..15) the layout's pad table presses.
uint64_t input_map_pad_buttons(const uint8_t down[PAD_COUNT], int layout);
+41 -2
View File
@@ -12,18 +12,21 @@
#include <SDL3/SDL.h>
#include "cfg.h"
#include "host.h"
#include "input.h"
#include "input_map.h"
#include "input_sdl.h"
#include "input_wsys.h"
#include "gameplay_tweaks.h"
#include "platform/platform.h"
static SDL_Window *win;
static volatile uint8_t key_held[KEY_COUNT];
static volatile int32_t esc_held, f8_held, focused;
static volatile int32_t mouse_dx, mouse_dy; // relative motion since the last ikb_mouse_take, whole counts
static volatile int32_t mouse_wheel; // wheel turned while captured, in 1/120 notches (ikb_wheel_take)
static volatile int32_t mouse_wheel; // wheel turned while captured or over the window, in 1/120 notches
// (ikb_wheel_take)
static float rem_x, rem_y; // window thread: the fractions SDL reported beyond them
static volatile int32_t mouse_travel; // raw counts moved in total, captured or not (ikb_mouse_travel)
static float travel_rem; // window thread: the fraction of a count beyond mouse_travel
@@ -143,6 +146,7 @@ static void cursor_apply(void) {
plat_xchg32(&mouse_dy, 0);
rem_x = rem_y = 0;
plat_xchg32(&captured, want);
if (!want) gameplay_tweaks_reset();
}
// The pointer's place in the window (the window thread): x and y are SDL window units, the same space the mouse
@@ -199,8 +203,37 @@ void ikb_menu_closed(void) {
if (o & CUR_ESC) plat_cas32(&cur_rel, 0, o);
}
// pointer_image = 1: the pointer over the window while the cursor is not captured is cursor_art.c's, sized by the
// window's display scale; 0 (the default) keeps SDL's arrow. Window thread, at the window's creation and whenever the
// settings change (input_sdl_idle), so the menu switches it live. SDL's arrow stays when SDL refuses the image.
static void art_cursor(SDL_Window *w) {
static SDL_Cursor *art;
static int shown = -1, failed;
static unsigned seen = ~0u;
unsigned v = cfg_version();
if (v == seen && shown >= 0) return;
seen = v;
int want = cfg_bool("TOTK_POINTER_IMAGE");
if (want == shown) return;
if (want && !art && !failed) {
float scale = SDL_GetWindowDisplayScale(w);
int size = (int)lrintf(32 * (scale > 0 ? scale : 1)), hot;
size = size < 32 ? 32 : size > 128 ? 128 : size;
SDL_Surface *s = SDL_CreateSurface(size, size, SDL_PIXELFORMAT_ARGB8888);
if (s && s->pitch == size * 4) {
cursor_art(s->pixels, size, &hot);
art = SDL_CreateColorCursor(s, hot, hot);
}
if (s) SDL_DestroySurface(s);
if (!art) failed = 1, rt_log("input: the pointer's image failed (%s); the arrow stays", SDL_GetError());
}
SDL_SetCursor(want && art ? art : SDL_GetDefaultCursor());
shown = want;
}
void input_sdl_window(SDL_Window *w) {
win = w;
art_cursor(w);
wake_event = SDL_RegisterEvents(1);
plat_xchg32(&focused, (SDL_GetWindowFlags(w) & SDL_WINDOW_INPUT_FOCUS) != 0);
__atomic_store_n(&ptr_have, 0, __ATOMIC_RELEASE); // the pointer's place is unknown until it enters or moves
@@ -209,6 +242,7 @@ void input_sdl_window(SDL_Window *w) {
void input_sdl_idle(void) {
if (cur_pending) cursor_apply();
if (win) art_cursor(win);
pointer_apply();
}
@@ -266,10 +300,15 @@ void input_sdl_event(const SDL_Event *e) {
__atomic_store_n(&ptr_have, 0, __ATOMIC_RELEASE);
break;
case SDL_EVENT_MOUSE_WHEEL: // notches, + away from the player (a flipped wheel reports the other sign)
if (captured) {
// Captured, or released over the focused window: a game menu with the pointer takes it (input.c)
if (captured || (focused && __atomic_load_n(&ptr_have, __ATOMIC_ACQUIRE))) {
float y = e->wheel.direction == SDL_MOUSEWHEEL_FLIPPED ? -e->wheel.y : e->wheel.y;
plat_add32(&mouse_wheel, (int32_t)(y * 120));
}
if (input_gameplay_active()) {
double delta = e->wheel.direction == SDL_MOUSEWHEEL_FLIPPED ? e->wheel.y : -e->wheel.y;
gameplay_tweaks_wheel(delta, ikb_down(KEY_C), ikb_down(KEY_MOUSE_R));
}
break;
case SDL_EVENT_WINDOW_FOCUS_GAINED:
plat_xchg32(&focused, 1);
+54 -4
View File
@@ -13,6 +13,7 @@
#include "input_win.h"
#include "input_map.h"
#include "input_wsys.h"
#include "gameplay_tweaks.h"
#include "nvn_api.h"
#include "ui/menu.h"
#include "vk.h"
@@ -84,7 +85,8 @@ uint32_t input_key_char(int key) {
// ---- mouse camera: raw motion accumulated by the window thread, one stick sample per presented frame
static volatile LONG mouse_dx, mouse_dy; // raw counts since the last frame sample
static volatile LONG mouse_travel; // raw counts moved in total, captured or not (ikb_mouse_travel)
static volatile LONG mouse_wheel; // wheel turned while captured, in WHEEL_DELTA units (ikb_wheel_take)
static volatile LONG mouse_wheel; // wheel turned while captured or over the window, in WHEEL_DELTA units
// (ikb_wheel_take)
static volatile LONG cur_captured; // cursor hidden and confined to the client area
static volatile LONG cur_active; // WM_ACTIVATEAPP: the window's application is active
// Bits: CUR_REL, Esc or activation by a click on the title bar or border: until a client click; CUR_ESC, set with CUR_REL
@@ -118,9 +120,43 @@ static void cursor_update(HWND h) {
if (cur_captured) ClipCursor(NULL);
InterlockedExchange(&cur_captured, 0);
}
if (!cur_captured) gameplay_tweaks_reset();
ReleaseSRWLockExclusive(&cur_lock);
}
// The pointer shown over the client area while the cursor is not captured (cursor_art.c), 32 pixels at 96 DPI and
// larger with the window's DPI; made again when the DPI changes. Window thread. NULL when Windows refuses it: the
// window class's arrow stays.
static HCURSOR art_cursor(HWND h) {
static HCURSOR cur;
static UINT made_dpi;
UINT dpi = GetDpiForWindow(h);
if (!dpi) dpi = USER_DEFAULT_SCREEN_DPI;
if (cur && dpi == made_dpi) return cur;
int size = MulDiv(32, (int)dpi, USER_DEFAULT_SCREEN_DPI), hot;
size = size < 32 ? 32 : size > 128 ? 128 : size;
BITMAPV5HEADER bh = {.bV5Size = sizeof bh, .bV5Width = size, .bV5Height = -size, .bV5Planes = 1, .bV5BitCount = 32,
.bV5Compression = BI_BITFIELDS, .bV5RedMask = 0xff0000, .bV5GreenMask = 0xff00,
.bV5BlueMask = 0xff, .bV5AlphaMask = 0xff000000u};
void *bits = NULL;
HDC dc = GetDC(NULL);
HBITMAP color = CreateDIBSection(dc, (BITMAPINFO *)&bh, DIB_RGB_COLORS, &bits, NULL, 0);
ReleaseDC(NULL, dc);
HBITMAP mask = CreateBitmap(size, size, 1, 1, NULL);
HCURSOR made = NULL;
if (color && mask && bits) {
cursor_art(bits, size, &hot);
ICONINFO ii = {.fIcon = FALSE, .xHotspot = (DWORD)hot, .yHotspot = (DWORD)hot, .hbmMask = mask,
.hbmColor = color};
made = (HCURSOR)CreateIconIndirect(&ii);
}
if (color) DeleteObject(color);
if (mask) DeleteObject(mask);
if (!made) return cur; // the old size, or NULL
cur = made, made_dpi = dpi; // the old one may still be on screen: kept (a DPI change is rare)
return cur;
}
int input_cursor_released(void) { return (cur_rel & CUR_REL) != 0; }
void input_cursor_suspend(int on) {
@@ -148,13 +184,27 @@ int input_window_msg(HWND h, UINT m, WPARAM w, LPARAM l, LRESULT *res) {
InterlockedAdd(&mouse_dy, y);
}
}
// The wheel comes in the same message (usButtonData, signed, + away from the player)
if (cur_captured && ri.header.dwType == RIM_TYPEMOUSE && (ri.data.mouse.usButtonFlags & RI_MOUSE_WHEEL))
// The wheel comes in the same message (usButtonData, signed, + away from the player). It counts while the
// cursor is captured, or released over the client area: a game menu with the pointer (menu_cursor.c) takes it
// as steps of its focus. input.c drops the notches where nothing takes them.
float px, py;
if (ri.header.dwType == RIM_TYPEMOUSE && (ri.data.mouse.usButtonFlags & RI_MOUSE_WHEEL) &&
(cur_captured || ikb_pointer(&px, &py)))
InterlockedAdd(&mouse_wheel, (SHORT)ri.data.mouse.usButtonData);
break; // DefWindowProc must see WM_INPUT for cleanup
}
case WM_MOUSEWHEEL:
if (input_gameplay_active())
gameplay_tweaks_wheel(-(double)(short)HIWORD(w) / WHEEL_DELTA,
ikb_down(KEY_C), ikb_down(KEY_MOUSE_R));
break;
case WM_SETCURSOR:
if (cur_captured && LOWORD(l) == HTCLIENT) { SetCursor(NULL); *res = TRUE; return 1; }
if (LOWORD(l) == HTCLIENT) {
// pointer_image = 1: the pointer of cursor_art.c in place of the window class's arrow (0, the default:
// the arrow, left to DefWindowProc)
HCURSOR c = cur_captured || !cfg_bool("TOTK_POINTER_IMAGE") ? NULL : art_cursor(h);
if (cur_captured || c) { SetCursor(c); *res = TRUE; return 1; }
}
break;
case WM_SYSCOMMAND: // Alt pressed alone would enter the window menu loop, which stalls the game: Alt is a game key
if ((w & 0xFFF0) == SC_KEYMENU && l == 0) { *res = 0; return 1; }
+8 -2
View File
@@ -13,10 +13,16 @@ void ikb_pointer_set(float nx, float ny); // moves the pointer there (the wind
int ikb_captured(void); // the cursor is captured for the mouse camera
void ikb_mouse_take(int32_t *dx, int32_t *dy); // raw mouse motion since the last call, in counts
uint32_t ikb_mouse_travel(void); // raw counts the mouse moved in total (|dx| + |dy|), captured or not
int32_t ikb_wheel_take(void); // whole wheel notches turned while captured since the last call (+ away
// from the player); a high-resolution wheel's part of a notch is kept
int32_t ikb_wheel_take(void); // whole wheel notches turned since the last call while the cursor was
// captured or over the focused window (+ away from the player); a
// high-resolution wheel's part of a notch is kept
void ikb_cursor_update(void); // what input_cursor_allowed says may have changed
void ikb_menu_closed(void); // the menu closed: a capture that Esc gave up comes back
// ---- shared by the back ends
// cursor_art.c: the pointer's image at size x size pixels (0xAARRGGBB, straight alpha, rows from the top) and its
// hotspot (*hot, the same in x and y). Pure.
void cursor_art(uint32_t *argb, int size, int *hot);
// ---- what input.c provides the back end
int input_cursor_allowed(void); // no text entry or menu open, the mouse camera on, input not disabled
+1
View File
@@ -783,6 +783,7 @@ int probe_ipc(void) {
return 0;
}
ldr_load(rt_config()->exefs);
hostfn_count(1); // the stats line reads the host-call count
kern_run_on_guest_main(guest_main);
probe_unknown_service();
RtStats s = rt_stats();
+47
View File
@@ -246,6 +246,44 @@ static void wake_sync_waiters(void) {
}
}
// ---- a short poll before a sleep
// Most guest waits and waits for a virtual core end within microseconds. The thread polls for TOTK_KSPIN_US (default
// 20) with G released before it sleeps on its condition variable: a wake in that time costs no OS wake-up (4-12 us
// on a desktop Ryzen, more from a deep C-state) and the waker's signal finds nobody asleep. Off with fewer than 6 logical
// processors, where the poll would take a CPU that a running thread needs; TOTK_KSPIN_US=0 turns it off. Savage Wind
// Recomp polls the same way before it parks (runtime/ksync.c cond_wait). TOTK_KSPIN_US=ab polls 20 us in the
// B blocks of TOTK_AB only.
static int64_t g_kspin_ns = -1;
static int g_kspin_ab;
static uint64_t kspin_ns(void) {
int64_t v = __atomic_load_n(&g_kspin_ns, __ATOMIC_RELAXED);
if (v < 0) {
const char *e = cfg_get("TOTK_KSPIN_US");
g_kspin_ab = e && !strcmp(e, "ab");
long long us = e && *e && !g_kspin_ab ? atoll(e) : 20;
uint32_t cpus = plat_cpu_usable();
v = us <= 0 || cpus < 6 ? 0 : us * 1000;
__atomic_store_n(&g_kspin_ns, v, __ATOMIC_RELAXED);
rt_log("kernel: waits poll %lld us before they sleep%s (TOTK_KSPIN_US, %u logical processors)",
(long long)(v / 1000), g_kspin_ab ? " in the B blocks" : "", cpus);
}
return v && (!g_kspin_ab || rt_ab()) ? (uint64_t)v : 0;
}
// Holding G: releases it and polls *p until it reaches at_least or ns pass, then takes G again. 1 if it was reached.
static int kspin(const int *p, int at_least, uint64_t ns) {
uint64_t end = kern_now_ns() + ns;
int ok = 0;
unlock();
for (unsigned i = 1; !(ok = __atomic_load_n(p, __ATOMIC_ACQUIRE) >= at_least); i++) {
plat_pause();
if (!(i & 31) && kern_now_ns() >= end) break;
}
lock();
return ok;
}
// SleepConditionVariableSRW counts milliseconds: round up (late is legal, early is not) and re-check the deadline
// against the performance counter, because the wait may also end early.
static uint32_t block_inner(RtThread *t, int kind, int64_t ns) {
@@ -262,6 +300,8 @@ static uint32_t block_inner(RtThread *t, int kind, int64_t ns) {
uint64_t now = kern_now_ns();
int forever = ns < 0 || (uint64_t)ns > UINT64_MAX - now;
uint64_t deadline = forever ? 0 : now + (uint64_t)ns;
uint64_t poll = kspin_ns();
if (poll) kspin(&t->woke, 1, forever || poll < (uint64_t)ns ? poll : (uint64_t)ns);
while (!t->woke) {
if (forever) {
plat_cond_wait(&t->cv, &G);
@@ -991,6 +1031,9 @@ static void core_take(RtThread *t) {
while (__atomic_load_n(&t->cur_core, __ATOMIC_RELAXED) < 0 && kern_now_ns() < end) plat_pause();
lock();
if (t->cur_core >= 0) g_ap_spin_ok++;
} else if (t->cur_core < 0) { // a holder may block or yield any moment (kspin_ns)
uint64_t poll = kspin_ns();
if (poll) kspin(&t->cur_core, 0, poll);
}
int sampled = 0;
while (t->cur_core < 0) {
@@ -1402,6 +1445,7 @@ static RtThread *thr_new(int prio, int core, uint64_t mask) {
Cpu *c = plat_aligned_alloc(sizeof(Cpu), 64);
if (!t || !c) rt_fatal("kernel: thread allocation");
memset(c, 0, sizeof *c);
rt_fpcr_threshold(c);
plat_cond_init(&t->cv);
t->prio = prio;
t->core = core;
@@ -1518,6 +1562,7 @@ uint32_t kern_main_thread(Cpu **cpu) {
t->cpu->sp = t->stack_top;
t->tid = plat_thread_id();
perf_main_thread();
perf_core_thread(PCORE_MAIN);
PlatIntr *self = ap_open_self();
lock();
t->hthr = self;
@@ -2215,6 +2260,7 @@ static void fiber_switch_to(RtThread *t, const Cpu *from, Fiber *to) {
dst->tpidr = from->tpidr;
dst->tpidrro = from->tpidrro;
dst->fpcr = from->fpcr;
rt_fpcr_threshold(dst); // fiber_resumed syncs MXCSR on the other side; the threshold follows fpcr at once
dst->fpsr = from->fpsr;
dst->excl_addr = ~0ull;
dst->thread = t;
@@ -2247,6 +2293,7 @@ void kern_fiber_initialize(Cpu *c) {
plat_fiber_free(f->host);
}
memset(f->cpu, 0, sizeof *f->cpu);
rt_fpcr_threshold(f->cpu);
f->cpu->excl_addr = ~0ull;
f->addr = addr;
f->func = c->x[1];
+7
View File
@@ -38,3 +38,10 @@ extern volatile int kern_test_cv_old_order; // WaitProcessWideKeyAtomi
// the key (MNG's pre-fix order, the negative control)
extern void (*volatile kern_test_cv_hook)(void); // called right after the lock release, holding the kernel lock
extern void (*volatile svc_test_exit_hook)(unsigned code); // svc 0x07 calls it instead of ExitProcess (probes)
// ---- mod plugin service run (plugin_init.c sets these; the game calls none of the SVCs they serve)
extern uint64_t rt_svc_tick_offset; // added to GetSystemTick (0x1E): the service run's second run picks other ticks
extern int (*rt_plugin_svc)(Cpu *c, uint32_t imm, uint64_t pc); // with RT_TRACE_PLUGIN: sees each SVC
// first; 1: refused, the result is in x0 and the SVC does not run
extern uint32_t (*rt_process_memory)(int unmap, uint64_t dst, uint32_t process, uint64_t src, uint64_t size);
// Map/UnmapProcessMemory (0x74/0x75); NULL outside the service run: fatal
+113
View File
@@ -10,6 +10,7 @@
#include "cfg.h"
#include "host.h"
#include "kernel.h"
#include "layout.h"
#include "platform/platform.h"
#define STACK 0x10000
@@ -682,6 +683,25 @@ static int cmp_u64(const void *a, const void *b) {
return x < y ? -1 : x > y;
}
// A refused commit waits and retries (memory.c commit, oom.c rt_oom_wait): three forced refusals, then the page maps.
static void test_oom_commit(void) {
const RtGuestLayout *g = mem_layout();
uint64_t a = g->alias.base + g->alias.size - 0x10000;
rt_oom_force(RT_OOM_COMMIT, 3);
uint64_t t0 = plat_now_ms();
uint32_t r = mem_map_physical(a, 0x1000);
uint64_t ms = plat_now_ms() - t0;
CHECK(r == 0 && rt_oom_forced_left(RT_OOM_COMMIT) == 0 && ms >= 20,
"MapPhysicalMemory after 3 refused commits: result %#x, %d refusals left, %llu ms", r,
rt_oom_forced_left(RT_OOM_COMMIT), (unsigned long long)ms);
rt_oom_force(RT_OOM_COMMIT, 0);
if (r == 0) {
*(volatile uint64_t *)(uintptr_t)a = 1;
CHECK(mem_unmap_physical(a, 0x1000) == 0, "UnmapPhysicalMemory after the refused commits");
}
printf("oom: commit waited %llu ms through 3 refusals\n", (unsigned long long)ms);
}
static void test_platform(void) {
PlatThread *t = plat_thread_new(plat_worker, (void *)(intptr_t)1, "probe-kernel plat");
CHECK(t, "plat_thread_new");
@@ -719,6 +739,90 @@ static void test_platform(void) {
CHECK(over[N / 2] < 500000, "plat_sleep_ns(1 ms) median overshoot %.3f ms (want < 0.5)", over[N / 2] / 1e6);
}
// ---- crash report (main.c crash_handler): a child faults on a guest thread with known values in rbx and x19; the
// report must hold the host registers, the faulting instruction's bytes and the memory both values point at.
#define CRASH_CHILD_ENV "TOTK_PROBE_KERNEL_CRASH_CHILD"
static uint64_t crash_host_words[6] = {0, 0, 0x5ca1ab1e0c0de001ull, 0, 0, 0};
static uint64_t crash_guest_words[6] = {0, 0, 0x5ca1ab1e0c0de002ull, 0, 0, 0};
// The compound shape note (main.c crash_compound_shape, 1.2.1): a shape of 3 records whose child 0 has no shape, child
// 1 has one but its live bit is clear, child 2 is live and filled.
static uint64_t crash_shape[0x1a0 / 8], crash_records[3 * 0x78 / 8], crash_child_shape;
static void crash_shape_fill(Cpu *c) {
uint8_t *s = (uint8_t *)crash_shape, *r = (uint8_t *)crash_records;
static const char *const names[3] = {"PartA", "PartB", "PartC"};
for (int i = 0; i < 3; i++) {
uint64_t name = (uint64_t)(uintptr_t)(r + i * 0x78 + 0x14);
memcpy(r + i * 0x78 + 8, &name, 8);
memcpy(r + i * 0x78 + 0x14, names[i], strlen(names[i]) + 1);
}
uint64_t child = (uint64_t)(uintptr_t)&crash_child_shape, vt = MOD_MAIN_BASE + 0x45e1218;
uint64_t rec = (uint64_t)(uintptr_t)crash_records;
uint32_t n = 3, bits = 0x5;
memcpy(r + 0x78, &child, 8);
memcpy(r + 2 * 0x78, &child, 8);
memcpy(s, &vt, 8);
memcpy(s + 0x78, &n, 4);
memcpy(s + 0x80, &rec, 8);
memcpy(s + 0x88, &bits, 4);
memcpy(s + 0x190, &n, 4);
c->x[20] = (uint64_t)(uintptr_t)crash_shape;
c->x[21] = 0x1000038;
c->x[30] = MOD_MAIN_BASE + 0xe056d4;
}
static void crash_child_main(Cpu *c) {
const char *mode = getenv(CRASH_CHILD_ENV);
if (mode && !strcmp(mode, "shape")) crash_shape_fill(c);
c->x[19] = (uint64_t)(uintptr_t)&crash_guest_words[2];
c->sp -= 0x100; // a frame on the guest stack, as a crashing function has
__asm__ volatile("movq %0, %%rbx\n\tmovq 0x10, %%rax" : : "r"(&crash_host_words[2]) : "rax", "rbx", "memory");
}
// The report line that holds needle, NULL when none does
static const char *report_line(const char *out, const char *needle, char *line, size_t cap) {
const char *p = strstr(out, needle);
if (!p) return NULL;
while (p > out && p[-1] != '\n') p--;
size_t n = strcspn(p, "\r\n");
snprintf(line, cap, "%.*s", (int)(n < cap ? n : cap - 1), p);
return line;
}
static void test_crash_report(void) {
static char out[65536];
char line[512], want[64];
int code = plat_run_self(CRASH_CHILD_ENV, "1", out, sizeof out, 30000);
CHECK(code == 71 && strstr(out, "FATAL: access violation") && strstr(out, "reading address 0x10"),
"crash child: exit code %d, no access violation at 0x10 reported", code);
snprintf(want, sizeof want, "rbx %016llx", (unsigned long long)(uintptr_t)&crash_host_words[2]);
CHECK(strstr(out, want), "crash report: no host register line with %s", want);
CHECK(report_line(out, "host code at rip-", line, sizeof line) && strstr(line, "| 48 8b 04 25 10 00 00 00"),
"crash report: the faulting instruction's bytes are missing");
const char *h = report_line(out, "*5ca1ab1e0c0de001", line, sizeof line);
CHECK(h && strstr(h, "rbx"), "crash report: no memory line for rbx (%s)", h ? h : "none");
const char *g = report_line(out, "*5ca1ab1e0c0de002", line, sizeof line);
CHECK(g && strstr(g, "x19"), "crash report: no memory line for x19 (%s)", g ? g : "none");
CHECK(strstr(out, "guest stack sp+0x00:"), "crash report: no guest stack words");
CHECK(report_line(out, " memory commit: this process ", line, sizeof line) && !strstr(line, "process -1 MB"),
"crash report: no memory commit line");
printf("crash report: exit code %d, host registers, code bytes, memory at rbx and x19, guest stack, commit %s\n", code,
failures ? "checked with failures" : "present");
if (rt_game_version != 121) return;
code = plat_run_self(CRASH_CHILD_ENV, "shape", out, sizeof out, 30000);
CHECK(report_line(out, " compound shape ", line, sizeof line) && strstr(line, "3 children, 3 records") &&
strstr(line, "live bits: 00000005"),
"crash report: no compound shape line (%s)", strstr(out, "compound shape") ? line : "none");
CHECK(report_line(out, "child 0:", line, sizeof line) && strstr(line, "shape 0 \"PartA\""),
"crash report: child 0 should have no shape (%s)", line);
CHECK(report_line(out, "child 1:", line, sizeof line) && strstr(line, "(off) \"PartB\""),
"crash report: child 1 should be off (%s)", line);
CHECK(report_line(out, "child 2:", line, sizeof line) && !strstr(line, "(off)") && strstr(line, "\"PartC\""),
"crash report: child 2 should be live (%s)", line);
printf("crash report, compound shape: exit code %d, %s\n", code, failures ? "checked with failures" : "children listed");
}
int probe_kernel(void) {
a_lock_waiter = hostfn_register("probe-kernel lock waiter", lock_waiter);
a_cv_waiter = hostfn_register("probe-kernel condvar waiter", cv_waiter);
@@ -742,7 +846,16 @@ int probe_kernel(void) {
printf("probe-kernel: FAILED (no PLT stub for %s in main)\n", TICK_SYMBOL);
return 1;
}
const char *child = getenv(CRASH_CHILD_ENV);
if (child && *child) {
kern_run_on_guest_main(crash_child_main);
printf("crash child: returned without a fault\n");
return 1;
}
test_platform();
test_oom_commit();
test_crash_report();
hostfn_count(1); // test_lifted_ticks and the stats line read the host-call count
kern_run_on_guest_main(probe_main);
RtStats s = rt_stats();
printf("stats: %llu SVCs, %llu threads, %llu host calls\n", (unsigned long long)s.svcs,
+96 -16
View File
@@ -47,11 +47,12 @@ typedef struct {
uint64_t *plt_slot, *plt_stub, nplt; // PLT stubs sorted by GOT slot (ldr_plt_stub), built on first use
// statistics
uint64_t kinds[K_COUNT], sym_import, sym_own;
uint32_t imports, import_to[MOD_COUNT], weak_unresolved, strong_unresolved;
uint32_t imports, import_to[RT_MAX_MODULES], weak_unresolved, strong_unresolved;
uint32_t init_off;
} Mod;
static Mod mods[MOD_COUNT];
static Mod mods[RT_MAX_MODULES];
GuestFn ldr_plugin_import;
static int nmods;
static uint64_t identity_refs, stubs;
static int *ovr_used, *obs_used; // per linked table entry, plus probe overrides counted separately
@@ -74,6 +75,51 @@ static void hex32(const uint8_t d[32], char out[65]) {
for (int i = 0; i < 32; i++) snprintf(out + 2 * i, 3, "%02x", d[i]);
}
static uint8_t *read_path_verified(const char *path, const char *want, size_t *len, const char *hint) {
uint8_t *p = read_file(path, len);
if (!p) rt_fatal("loader: cannot read %s (%s)", path, hint);
uint8_t d[32];
char hex[65];
rt_sha256(p, *len, d);
hex32(d, hex);
if (strcmp(hex, want)) rt_fatal("loader: %s has SHA-256 %s, expected %s", path, hex, want);
return p;
}
// Mod plugins of the layout whose file is gone (their mod was removed): a rebuild without them is due (cheats.c
// rebuild_if_needed), keyed by their paths.
static int plugins_gone;
static uint32_t plugins_gone_key = 0x811C9DC5u;
int ldr_plugins_gone(uint32_t *key) {
if (plugins_gone) *key = (*key ^ plugins_gone_key) * 0x01000193u;
return plugins_gone;
}
// 1 when the plugin file of lay is the one the build lifted; logged when not.
static int plugin_file_ok(const RtLayoutEntry *lay) {
size_t len;
uint8_t *p = read_file(lay->file, &len);
if (!p) {
rt_log("loader: %s: cannot read %s; the plugin is left out", lay->name, lay->file);
if (!plat_file_exists(lay->file)) {
plugins_gone++;
for (const char *c = lay->file; *c; c++) plugins_gone_key = (plugins_gone_key ^ (uint8_t)*c) * 0x01000193u;
}
return 0;
}
uint8_t d[32];
char hex[65];
rt_sha256(p, len, d);
free(p);
hex32(d, hex);
if (strcmp(hex, lay->sha256)) {
rt_log("loader: %s: %s changed since the build lifted it; the plugin is left out", lay->name, lay->file);
return 0;
}
return 1;
}
uint8_t *ldr_read_verified(const char *dir, const char *file, size_t *len) {
const char *want = NULL;
for (int i = 0; i < rt_exefs_sha256_count; i++)
@@ -81,14 +127,7 @@ uint8_t *ldr_read_verified(const char *dir, const char *file, size_t *len) {
if (!want) rt_fatal("loader: no expected SHA-256 for %s in modules.c", file);
char path[1024];
snprintf(path, sizeof path, "%s/%s", dir, file);
uint8_t *p = read_file(path, len);
if (!p) rt_fatal("loader: cannot read %s (extract the game first: tools/extract.py)", path);
uint8_t d[32];
char hex[65];
rt_sha256(p, *len, d);
hex32(d, hex);
if (strcmp(hex, want)) rt_fatal("loader: %s has SHA-256 %s, expected %s", path, hex, want);
return p;
return read_path_verified(path, want, len, "extract the game first: tools/extract.py");
}
// ---- NSO
@@ -141,6 +180,32 @@ static void nso_segment(const uint8_t *raw, const Seg *s, uint8_t *dst, const ch
}
}
// The plugin service run's stand-in for rtld (plugin_init.c): an ExeFS NSO's image, read and checked like a module but
// neither relocated, linked nor sealed. Nothing runs it; exlaunch only reads it while it walks the address space.
uint64_t ldr_nso_size(const char *dir, const char *file) {
size_t len;
uint8_t *raw = ldr_read_verified(dir, file, &len);
Seg seg[3];
uint64_t size = nso_segments(raw, len, file, seg);
free(raw);
return size;
}
void ldr_map_image(const char *dir, const char *file, uint64_t base, uint64_t *text_end, uint64_t *data_off) {
size_t len;
uint8_t *raw = ldr_read_verified(dir, file, &len);
Seg seg[3];
uint64_t size = nso_segments(raw, len, file, seg);
if (!plat_mem_commit(base, size)) rt_fatal("loader: cannot commit %s at %#llx", file, (unsigned long long)base);
for (int i = 0; i < 3; i++) {
if ((uint64_t)seg[i].mem_off + seg[i].size > size) rt_fatal("loader: %s segment %d exceeds the image", file, i);
nso_segment(raw, &seg[i], (uint8_t *)(uintptr_t)(base + seg[i].mem_off), file, i);
}
free(raw);
*text_end = seg[0].mem_off + seg[0].size;
*data_off = seg[2].mem_off;
}
// ---- symbols
static const char *sym_name(const Mod *m, uint32_t i) { return m->strtab + m->syms[i].name; }
static int sym_defined(const Mod *m, uint32_t i) { return m->syms[i].shndx != 0; }
@@ -273,9 +338,12 @@ static uint64_t decode_ctor_flag(const Mod *m) {
return 0;
}
// A plugin (lay->file set) comes from its mod folder, checked against the hash the build took when it lifted it.
static void load_module(Mod *m, const char *dir, const RtLayoutEntry *lay) {
size_t len;
uint8_t *raw = ldr_read_verified(dir, lay->name, &len);
uint8_t *raw = lay->file ? read_path_verified(lay->file, lay->sha256, &len, "the mod's code module the build "
"lifted; rebuild after changing mods")
: ldr_read_verified(dir, lay->name, &len);
Seg seg[3];
uint64_t size = nso_segments(raw, len, lay->name, seg);
if (size != lay->size)
@@ -291,6 +359,7 @@ static void load_module(Mod *m, const char *dir, const RtLayoutEntry *lay) {
}
free(raw);
m->pub.name = lay->name;
m->pub.plugin = lay->file != NULL;
m->pub.base = lay->base;
m->pub.size = size;
m->pub.text_end = seg[0].mem_off + seg[0].size;
@@ -328,7 +397,11 @@ static Res resolve(Mod *m, uint32_t si, int jump) {
uint64_t guest = sym_defined(m, si) ? m->pub.base + m->syms[si].value : find_symbol(name, NULL);
GuestFn f;
Res r;
if (jump && (f = hostfn_observer(name))) {
if (jump && m->pub.plugin && ldr_plugin_import) { // the plugin service run counts the plugin's calls by name
uint64_t to = (f = hostfn_override(name)) ? hostfn_register(name, f) : guest;
if (!to) to = hostfn_register(name, unresolved_stub);
r = (Res){hostfn_register_observer(name, ldr_plugin_import, to), RES_OBSERVER};
} else if (jump && (f = hostfn_observer(name))) {
r = (Res){hostfn_register_observer(name, f, guest), RES_OBSERVER};
mark_used(1, name);
} else if ((f = hostfn_override(name))) {
@@ -444,9 +517,15 @@ static void seal(Mod *m) {
void ldr_load(const char *exefs_dir) {
if (nmods) rt_fatal("ldr_load called twice");
if (!mem_layout()->pool) rt_fatal("ldr_load before mem_init");
if (rt_layout_count > MOD_COUNT) rt_fatal("loader: %d modules in the layout", rt_layout_count);
for (int i = 0; i < rt_layout_count; i++) load_module(&mods[i], exefs_dir, &rt_layout[i]);
nmods = rt_layout_count;
if (rt_layout_count > RT_MAX_MODULES) rt_fatal("loader: %d modules in the layout", rt_layout_count);
int n = 0;
for (int i = 0; i < rt_layout_count; i++) {
// A mod plugin's file that is gone or changed since the build is left out at play time: its patch set cannot
// run (plugin_init.c plugins_start keeps it off); the plugin service run needs it and stops.
if (rt_layout[i].file && !rt_config()->plugin_init && !plugin_file_ok(&rt_layout[i])) continue;
load_module(&mods[n++], exefs_dir, &rt_layout[i]);
}
nmods = n;
ovr_used = calloc(hostfn_table_size(0) + 1, sizeof(int));
obs_used = calloc(hostfn_table_size(1) + 1, sizeof(int));
for (int i = 0; i < nmods; i++) {
@@ -557,7 +636,7 @@ uint64_t ldr_plt_stub(const char *module, const char *name) {
typedef struct {
const char *name;
uint64_t kinds[K_COUNT], total, sym_import, sym_own;
uint32_t imports, to[MOD_COUNT], weak, init_off, init_array;
uint32_t imports, to[RT_MAX_MODULES], weak, init_off, init_array;
} Expect;
static const Expect expect_121[] = {
{"main", {508816, 1415, 32, 641}, 510904, 2088, 0, 675, {0, 16, 647}, 12, 0x30, 10673},
@@ -643,6 +722,7 @@ static void check_got(void) {
hostfn_seal();
Cpu *c = plat_aligned_alloc(sizeof(Cpu), 64);
memset(c, 0, sizeof *c);
rt_fpcr_threshold(c);
uint8_t *stack = mem_kernel_alloc(0x10000, 16);
c->sp = (uint64_t)(uintptr_t)stack + 0x10000;
c->excl_addr = ~0ull;
+156 -6
View File
@@ -21,7 +21,8 @@
//
// Also here: the runtime services the generated code calls besides rt_dispatch and rt_svc (rt_brk, rt_udf,
// rt_ticks, the function profiler hook), logging, SHA-256, and the crash reporter (a vectored exception handler that
// names the lifted function, the guest registers and the guest frame-pointer chain).
// names the lifted function, the host and guest registers, the machine code around the fault, the guest frame-pointer
// chain and the memory the registers point at).
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
@@ -29,6 +30,7 @@
#include "cfg.h"
#include "host.h"
#include "layout.h"
#include "platform/platform.h"
#include "sha256.h"
@@ -159,6 +161,16 @@ const RtConfig *rt_config(void) { return &cfg; }
volatile int g_fnprof = 0; // resolution.c switches it on until the game sets its render size (res_fn_hit)
void fnprof_hit(uint64_t addr, uint64_t lr, uint64_t x0) { (void)lr, res_fn_hit(addr, x0); }
// cpu.h RT_FPCR_NOTE: diagnostic only, the write itself takes effect as before (runtime/simd.h slow paths).
void rt_fpcr_rmode(uint64_t fpcr, uint64_t lr) {
static int seen;
if (__atomic_exchange_n(&seen, 1, __ATOMIC_RELAXED)) return;
static const char *const mode[] = {"nearest", "+inf", "-inf", "zero"};
char at[128];
rt_log("fpcr: guest code set rounding mode %s (FPCR %#llx), in a function called from %s", mode[(fpcr >> 22) & 3],
(unsigned long long)fpcr, ldr_describe(lr, at, sizeof at));
}
void rt_brk(Cpu *c, uint32_t imm, uint64_t pc) {
char at[128], lr[128];
rt_fatal("brk #%#x at %s (lr %s)", imm, ldr_describe(pc, at, sizeof at), ldr_describe(c->x[30], lr, sizeof lr));
@@ -188,8 +200,8 @@ static int by_host(const void *a, const void *b) {
}
// The lifted function that contains a host code address, by the nearest function start below it; 0 outside the lifted
// code.
static uint64_t lifted_function(uintptr_t rip) {
// code. *host, when given, gets the function's host start.
static uint64_t lifted_function_at(uintptr_t rip, uintptr_t *host) {
if (!fn_rev) {
static RtModule mods[MAX_MODULES];
int n = rt_linked_modules(mods, MAX_MODULES);
@@ -211,11 +223,113 @@ static uint64_t lifted_function(uintptr_t rip) {
if (fn_rev[mid].host <= rip) lo = mid + 1;
else hi = mid;
}
if (lo && host) *host = fn_rev[lo - 1].host;
return lo ? fn_rev[lo - 1].guest : 0;
}
static uint64_t lifted_function(uintptr_t rip) { return lifted_function_at(rip, NULL); }
static int readable(uint64_t a, uint64_t n) { return plat_mem_readable(a, n); }
// The machine code around the faulting instruction: 32 bytes before rip, then 32 from rip. The user's totk.exe is built
// on their machine, so its offsets need not match ours; these bytes and the offset into the lifted function find the
// same instruction in a local build of that version, and with it the guest instruction and the operands' registers.
static void crash_code_bytes(uintptr_t rip) {
uint8_t b[64];
int before = 32;
if (!plat_mem_read(rip - 32, b, sizeof b)) {
before = 0; // rip near the start of a mapping: the bytes from rip only
if (!plat_mem_read(rip, b + 32, 32)) return;
}
rt_logf(" host code at rip-%d:", before);
for (int i = 32 - before; i < 64; i++) rt_logf("%s%02x", i == 32 ? " | " : " ", b[i]);
rt_log_raw("\n", 1);
}
// 64 bytes around each register value that points at readable memory, as 8-byte words from 16 bytes below the value,
// the word holding the value marked with *. Host and guest registers that land on the same window share a line. A
// guest pointer is a host address here (the guest address space is mapped one to one), so both kinds are read alike.
// The guest registers come from the Cpu, which the lifted code writes back only at calls and returns, so the host
// registers carry the faulting function's live values.
typedef struct { uint64_t start; char names[56]; uint64_t w[8]; } CrashWin;
static void crash_win_add(CrashWin *wins, int *n, int cap, const char *name, uint64_t v) {
if (v < 0x10000 || v > 0x00007fffffffffffull) return; // small integers and non-canonical values
uint64_t start = (v & ~7ull) - 16;
for (int i = 0; i < *n; i++)
if (wins[i].start == start) {
size_t len = strlen(wins[i].names);
if (len + strlen(name) + 2 < sizeof wins[i].names)
snprintf(wins[i].names + len, sizeof wins[i].names - len, " %s", name);
return;
}
if (*n == cap || !plat_mem_read(start, wins[*n].w, sizeof wins[*n].w)) return;
wins[*n].start = start;
snprintf(wins[*n].names, sizeof wins[*n].names, "%s", name);
(*n)++;
}
static void crash_memory(const PlatCrash *x, const Cpu *c) {
static CrashWin wins[64]; // the crash handler runs once (busy flag), so static storage needs no allocation
static const char *const gpr_names[16] = PLAT_GPR_NAMES;
int n = 0;
char name[8];
if (x->has_regs)
for (int i = 0; i < 16; i++) crash_win_add(wins, &n, 64, gpr_names[i], x->gpr[i]);
if (c) {
for (int i = 0; i < 31; i++) snprintf(name, sizeof name, "x%d", i), crash_win_add(wins, &n, 64, name, c->x[i]);
crash_win_add(wins, &n, 64, "sp", c->sp);
}
if (!n) return;
rt_logf(" memory at the register values (8-byte words from value-16, * the value's word):\n");
for (int i = 0; i < n; i++) {
rt_logf(" %016llx %-12s", (unsigned long long)wins[i].start, wins[i].names);
for (int k = 0; k < 8; k++) rt_logf(" %s%016llx", k == 2 ? "*" : "", (unsigned long long)wins[i].w[k]);
rt_log_raw("\n", 1);
}
// The guest stack above sp: the crashing function's spills and locals, and the callers' saved registers
uint64_t s[16];
if (c && plat_mem_read(c->sp, s, sizeof s))
for (int i = 0; i < 16; i += 4)
rt_logf(" guest stack sp+0x%02x: %016llx %016llx %016llx %016llx\n", i * 8, (unsigned long long)s[i],
(unsigned long long)s[i + 1], (unsigned long long)s[i + 2], (unsigned long long)s[i + 3]);
}
// 1.2.1: a fault right after a compound physics shape was asked for its first child's material (the call returning to
// main+0xe056d4 reads the result without a check). The shape (vtable main+0x45e1218, built by main+0x7359fc) is in x20
// there. It returns null when no child slot is both live (bitmap at +0x88) and filled (shape pointer at +0 of the
// 0x78-byte records at +0x80). Every child is filled when the shape is built, so the list tells children removed later
// (null shape) from children switched off (clear bit), and the names name the object. Runs only in the crash handler.
static void crash_compound_shape(const Cpu *c) {
if (!c || rt_game_version != 121 || c->x[30] != MOD_MAIN_BASE + 0xe056d4) return;
uint64_t shape = c->x[20];
if (!readable(shape, 0x1a0) || LD64(shape) != MOD_MAIN_BASE + 0x45e1218) {
rt_logf(" compound shape: x20 %#llx is not one\n", (unsigned long long)shape);
return;
}
uint32_t children = LD32(shape + 0x190), records = LD32(shape + 0x78);
uint64_t rec = LD64(shape + 0x80);
rt_logf(" compound shape %#llx (holder %#llx): %u children, %u records at %#llx, live bits:",
(unsigned long long)shape, (unsigned long long)(c->x[21] - 0x38), children, records,
(unsigned long long)rec);
uint32_t n = children > 0x400 ? 0x400 : children; // the bitmap holds 0x400 bits
for (uint32_t w = 0; w < (n + 31) / 32; w++) rt_logf(" %08x", LD32(shape + 0x88 + 4 * w));
rt_log_raw("\n", 1);
if (records > 0x400 || !readable(rec, (uint64_t)records * 0x78)) return;
for (uint32_t i = 0; i < records; i++) {
uint64_t r = rec + (uint64_t)i * 0x78, child = LD64(r), s = LD64(r + 8);
char name[33];
size_t k = 0;
for (; k < 32 && readable(s + k, 1); k++) {
name[k] = *(const char *)(uintptr_t)(s + k);
if (!name[k]) break;
}
name[k] = 0;
int live = LD32(shape + 0x88 + 4 * (i >> 5)) >> (i & 31) & 1;
rt_logf(" child %3u: shape %#llx%s \"%s\"\n", i, (unsigned long long)child, live ? "" : " (off)", name);
}
}
static void crash_handler(const PlatCrash *x) {
static volatile int32_t busy;
if (plat_xchg32(&busy, 1)) plat_exit(71);
@@ -230,8 +344,22 @@ static void crash_handler(const PlatCrash *x) {
rt_log_raw("\n", 1);
if (x->cxx_type)
rt_logf(" C++ type %s%s%s\n", x->cxx_type, x->cxx_what ? ", what(): " : "", x->cxx_what ? x->cxx_what : "");
uint64_t f = x->module ? 0 : lifted_function(rip);
if (f) rt_logf(" in lifted function f_%llx = %s\n", (unsigned long long)f, ldr_describe(f, d, sizeof d));
// A driver that runs out of memory faults or throws (std::bad_alloc) instead of returning an error: the commit
// tells that apart from a driver bug, as rt_fatal's line does for our own failed allocations.
double proc, used, limit;
plat_commit_info(&proc, &used, &limit);
rt_logf(" memory commit: this process %.0f MB, the system %.0f of %.0f MB\n", proc, used, limit);
uintptr_t fstart = 0;
uint64_t f = x->module ? 0 : lifted_function_at(rip, &fstart);
if (f)
rt_logf(" in lifted function f_%llx = %s, host +%#llx into it\n", (unsigned long long)f,
ldr_describe(f, d, sizeof d), (unsigned long long)(rip - fstart));
if (x->has_regs) {
static const char *const gpr_names[16] = PLAT_GPR_NAMES;
for (int i = 0; i < 16; i++)
rt_logf(" %-3s %016llx%s", gpr_names[i], (unsigned long long)x->gpr[i], i % 4 == 3 ? "\n" : "");
crash_code_bytes(rip);
}
// abort and invalid parameter: where the host code called it; a fault in another module: the driver code and the
// host calls that led into it
uintptr_t exe = plat_exe_base();
@@ -266,6 +394,8 @@ static void crash_handler(const PlatCrash *x) {
} else {
rt_logf(" not on a guest thread\n");
}
crash_memory(x, c);
crash_compound_shape(c);
kern_free_cores_note();
fflush(stderr);
plat_exit(71);
@@ -438,6 +568,7 @@ static int selftest(void) {
CHECK(s.functions > 0, "no functions linked");
Cpu *c = plat_aligned_alloc(sizeof(Cpu), 64);
memset(c, 0, sizeof *c);
rt_fpcr_threshold(c);
uint64_t r = rt_call(c, probe, 1, (uint64_t)7);
CHECK(rt_dispatch_lookup(probe) && r == 42 && host_probe_hits == 1 && c->x[30] == 0,
"a registered host function does not dispatch through rt_call");
@@ -480,7 +611,7 @@ static int usage(const char *argv0) {
"--probe-cfg | --probe-dpi | --probe-mods | --probe-playtime | --probe-kernel | --probe-ipc | --probe-services | --probe-fs | --probe-gfx-abi | "
"--probe-nvn | --probe-nvn-tex | --probe-window | --probe-shader | --probe-vkmem | "
"--probe-vkexec | --probe-astc | --probe-movie | --probe-crash-call | --probe-crash-null | --probe-discord | "
"--prepare-shaders | --warm-shaders | --boot |--seconds S [--shot PNG]]\n", argv0);
"--prepare-shaders | --warm-shaders | --boot | --plugin-init DIR | --seconds S [--shot PNG]]\n", argv0);
return 2;
}
@@ -532,6 +663,20 @@ int main(int argc, char **argv) {
// Timed guest waits (kernel.c block_inner) sleep in whole milliseconds; at the default 15.6 ms tick a 1 ms wait
// costs a full tick. TOTK_TIMER_1MS=0 keeps the default for comparison.
if (cfg_bool("TOTK_TIMER_1MS")) plat_timer_1ms();
int power = plat_power_full();
if (power >= 0)
rt_log("power: %s", power ? "OS power throttling off (EcoQoS, timer resolution in the background)"
: "OS power throttling: the opt-out was refused");
// Hybrid CPUs: the threads every frame goes through prefer the P-cores (perf_core_thread). TOTK_PCORE=0: off.
if (rt_knob("PCORE", "1")) {
char why[160];
int n = plat_perf_core_setup(why, sizeof why);
if (n) rt_log("power: %s; the game's main and render threads and the vk replay, recorder and present threads "
"prefer the %d P-core ones (TOTK_PCORE=0 turns it off)", why, n);
else rt_log("power: %s: no P-core preference", why);
} else {
rt_log("power: TOTK_PCORE=0: no P-core preference");
}
cfg = (RtConfig){.exefs = rt_default_exefs, .romfs = rt_default_romfs, .profile = rt_default_profile,
.gpu = cfg_get("TOTK_GPU")};
portable_paths(&cfg); // command-line paths below still win
@@ -555,6 +700,10 @@ int main(int argc, char **argv) {
} else if (!strcmp(argv[i], "--shot")) {
if (++i == argc) return usage(argv[0]);
cfg.shot = argv[i];
} else if (!mode && !strcmp(argv[i], "--plugin-init")) { // the plugin service run (plugin_init.c)
if (++i == argc) return usage(argv[0]);
mode = argv[i - 1];
cfg.plugin_init = argv[i];
} else if (!mode && !strncmp(argv[i], "--", 2)) {
mode = argv[i];
} else {
@@ -599,5 +748,6 @@ int main(int argc, char **argv) {
if (!strcmp(mode, "--prepare-shaders")) return vk_pipeline_prepare_shaders();
if (!strcmp(mode, "--warm-shaders")) return vk_pipeline_warm_shaders();
if (!strcmp(mode, "--boot")) { cfg.boot = 1; rt_boot(); return 0; }
if (!strcmp(mode, "--plugin-init")) { rt_boot_plugin_init(); return 0; }
return usage(argv[0]);
}
+30 -8
View File
@@ -57,7 +57,7 @@ static uint8_t *alias_pages; // 1 per mapped 4 KiB page of the alias regi
typedef struct { uint64_t dst, src, size; } StackMap;
static StackMap stack_maps[MAX_STACK_MAPS];
static unsigned nstack_maps;
static uint8_t *module_perm[MOD_COUNT]; // per data page of each module: perm | ATTR_PERMISSION_LOCKED
static uint8_t *module_perm[RT_MAX_MODULES]; // per data page of each module: perm | ATTR_PERMISSION_LOCKED
static uint64_t align_up(uint64_t v, uint64_t a) { return (v + a - 1) & ~(a - 1); }
@@ -175,12 +175,29 @@ static int thaw_fault(uint64_t a) {
}
// Mapping changes thaw the regions they touch and run under frz_lock, so no freeze sees them half done.
static void commit(uint64_t a, uint64_t n, const char *what) {
typedef struct { uint64_t a, n; } CommitTry;
static int commit_try(void *arg) {
const CommitTry *t = arg;
if (rt_oom_forced(RT_OOM_COMMIT)) return 0;
plat_mutex_lock(&frz_lock);
thaw_range_locked(a, n, 3);
int ok = !n || plat_mem_commit(a, n);
thaw_range_locked(t->a, t->n, 3);
int ok = !t->n || plat_mem_commit(t->a, t->n);
plat_mutex_unlock(&frz_lock);
if (!ok) rt_fatal("memory: commit %s %#llx+%#llx failed", what, (unsigned long long)a, (unsigned long long)n);
return ok;
}
// A refused commit waits for memory (rt_oom_wait): the system's commit ran out for a moment (a page file growing, the
// driver's device memory charged to this process), and the Vulkan back end gives memory back at its next submit. The
// wait holds the caller's lock (lock or klock: only memory SVCs and kernel-region allocations wait behind it) but not
// frz_lock, which write faults on frozen regions need. Every caller waits, the boot's ones too: there a refusal has the
// same cause, and the wait only delays an end the game would reach anyway.
static void commit(uint64_t a, uint64_t n, const char *what) {
CommitTry t = {a, n};
if (commit_try(&t)) return;
char w[64];
snprintf(w, sizeof w, "memory: commit of %s at %#llx", what, (unsigned long long)a);
if (!rt_oom_wait(w, n, commit_try, &t))
rt_fatal("memory: commit %s %#llx+%#llx failed", what, (unsigned long long)a, (unsigned long long)n);
}
static void decommit(uint64_t a, uint64_t n, const char *what) {
@@ -246,11 +263,12 @@ void mem_init(void) {
L = (RtGuestLayout){
.aslr = {low, RT_ADDRESS_LIMIT - low},
.stack = {low + STACK_OFF, STACK_SIZE},
.heap = {low + HEAP_OFF, HEAP_CAP + res_tex_heap_extra_bytes()},
.heap = {low + HEAP_OFF, HEAP_CAP + res_tex_heap_extra_bytes() + res_grass_heap_extra_bytes()},
.alias = {alias, ALIAS_SIZE},
.kernel = {RT_KERNEL_BASE, RT_KERNEL_SIZE},
.hostfn = {RT_HOSTFN_BASE, RT_HOSTFN_SIZE},
.pool = pool ? strtoull(pool, NULL, 0) : DEFAULT_POOL + res_heap_extra_bytes() + res_tex_heap_extra_bytes(),
.pool = pool ? strtoull(pool, NULL, 0)
: DEFAULT_POOL + res_heap_extra_bytes() + res_tex_heap_extra_bytes() + res_grass_heap_extra_bytes(),
};
if (!L.pool) rt_fatal("memory: TOTK_APP_POOL is 0");
}
@@ -512,7 +530,7 @@ uint32_t mem_unmap_physical(uint64_t a, uint64_t n) { return alias_map(1, a, n);
// as taken (Code, RX), so the SDK never picks it.
static void taken_gap(uint64_t a, uint64_t *base, uint64_t *size) {
uint64_t lo = 0, hi = RT_ADDRESS_LIMIT;
RtRange known[3 + MOD_COUNT + 2];
RtRange known[3 + RT_MAX_MODULES + 2];
int n = 0;
known[n++] = (RtRange){L.aslr.base, low_size};
known[n++] = L.alias;
@@ -544,6 +562,9 @@ static uint64_t run_start(const uint8_t *p, uint64_t i, uint8_t v) { // first
return i;
}
// The plugin service run (plugin_init.c) shows rtld, its process-memory aliases and its free pool here.
void (*mem_query_hook)(uint64_t a, RtMemoryInfo *r);
uint32_t mem_query(uint64_t a, RtMemoryInfo *out) {
RtMemoryInfo r = {.base = a & ~(PAGE - 1), .size = PAGE};
uint64_t low = L.aslr.base;
@@ -614,6 +635,7 @@ uint32_t mem_query(uint64_t a, RtMemoryInfo *out) {
r.size = hi - lo;
}
plat_mutex_unlock_shared(&lock);
if (mem_query_hook) mem_query_hook(a, &r);
if (out) *out = r;
return R_OK;
}
+120
View File
@@ -0,0 +1,120 @@
// Inline equality compares and copies for the replay's per-draw paths (TOTK_MEMX=0|1|check, default 1).
// ucrtbase's memcmp walks 8 bytes a step with a call around it, and the replay compares and copies a few hundred
// bytes at a time thousands of times a frame (pipeline states, shader answers, descriptor signatures): MX_EQ and
// MX_CPY do the same work with 32-byte loads in the caller, so a constant size unrolls and a variable one loops
// without a call. MX_EQ answers only equal or not, never an order. MX_CPY is memcpy: source and destination never
// overlap. 1: the inline forms. 0: memcmp/memcpy as before. check: memcmp/memcpy, and every MX_EQ also runs the
// inline compare and logs a different answer (vk_memx_bad). The mode is read once per process (vk_memx_init); calls
// before that take the off path.
#pragma once
#include <stddef.h>
#include <stdint.h>
#include <string.h>
extern int vk_memx_mode; // -1 before vk_memx_init, 0 off, 1 on, 2 check
void vk_memx_init(void);
void vk_memx_bad(const char *file, int line, size_t n);
typedef uint64_t mx_v4 __attribute__((vector_size(32), aligned(1)));
typedef uint64_t mx_v2 __attribute__((vector_size(16), aligned(1)));
static inline __attribute__((always_inline)) mx_v4 mx_ld4(const uint8_t *p) {
mx_v4 v;
__builtin_memcpy(&v, p, 32);
return v;
}
static inline __attribute__((always_inline)) mx_v2 mx_ld2(const uint8_t *p) {
mx_v2 v;
__builtin_memcpy(&v, p, 16);
return v;
}
static inline __attribute__((always_inline)) uint64_t mx_ld1(const uint8_t *p) {
uint64_t v;
__builtin_memcpy(&v, p, 8);
return v;
}
static inline __attribute__((always_inline)) uint32_t mx_ldw(const uint8_t *p) {
uint32_t v;
__builtin_memcpy(&v, p, 4);
return v;
}
// 1 when the n bytes at a and b are equal. Sizes of 32 and up compare in 128-byte steps with one branch each, the
// last partial step as an overlapping 32-byte load from the end; smaller sizes take two overlapping loads.
static inline __attribute__((always_inline)) int mx_eq(const void *a, const void *b, size_t n) {
const uint8_t *p = a, *q = b;
if (n >= 32) {
size_t i = 0;
for (; i + 128 <= n; i += 128) {
mx_v4 d = (mx_ld4(p + i) ^ mx_ld4(q + i)) | (mx_ld4(p + i + 32) ^ mx_ld4(q + i + 32)) |
(mx_ld4(p + i + 64) ^ mx_ld4(q + i + 64)) | (mx_ld4(p + i + 96) ^ mx_ld4(q + i + 96));
if (d[0] | d[1] | d[2] | d[3]) return 0;
}
mx_v4 d = {0, 0, 0, 0};
for (; i + 32 <= n; i += 32) d |= mx_ld4(p + i) ^ mx_ld4(q + i);
if (i < n) d |= mx_ld4(p + n - 32) ^ mx_ld4(q + n - 32);
return !(d[0] | d[1] | d[2] | d[3]);
}
if (n >= 16) {
mx_v2 d = (mx_ld2(p) ^ mx_ld2(q)) | (mx_ld2(p + n - 16) ^ mx_ld2(q + n - 16));
return !(d[0] | d[1]);
}
if (n >= 8) return !((mx_ld1(p) ^ mx_ld1(q)) | (mx_ld1(p + n - 8) ^ mx_ld1(q + n - 8)));
if (n >= 4) return !((mx_ldw(p) ^ mx_ldw(q)) | (mx_ldw(p + n - 4) ^ mx_ldw(q + n - 4)));
for (size_t i = 0; i < n; i++)
if (p[i] != q[i]) return 0;
return 1;
}
// memcpy of n bytes between buffers that do not overlap: 32-byte moves, the last partial one overlapping the one
// before it (it rewrites bytes it already wrote with the same values).
static inline __attribute__((always_inline)) void mx_cpy(void *d, const void *s, size_t n) {
uint8_t *p = d;
const uint8_t *q = s;
if (n >= 32) {
mx_v4 last = mx_ld4(q + n - 32);
for (size_t i = 0; i + 32 <= n; i += 32) {
__asm__("" : "+r"(p)); // opaque to the loop-idiom pass, which would turn the loop back into a memcpy call
mx_v4 v = mx_ld4(q + i);
__builtin_memcpy(p + i, &v, 32);
}
__builtin_memcpy(p + n - 32, &last, 32);
return;
}
if (n >= 16) {
mx_v2 x = mx_ld2(q), y = mx_ld2(q + n - 16);
__builtin_memcpy(p, &x, 16), __builtin_memcpy(p + n - 16, &y, 16);
return;
}
if (n >= 8) {
uint64_t x = mx_ld1(q), y = mx_ld1(q + n - 8);
__builtin_memcpy(p, &x, 8), __builtin_memcpy(p + n - 8, &y, 8);
return;
}
if (n >= 4) {
uint32_t x = mx_ldw(q), y = mx_ldw(q + n - 4);
__builtin_memcpy(p, &x, 4), __builtin_memcpy(p + n - 4, &y, 4);
return;
}
for (size_t i = 0; i < n; i++) p[i] = q[i];
}
static inline __attribute__((always_inline)) int mx_eq_at(const void *a, const void *b, size_t n, const char *file,
int line) {
if (vk_memx_mode == 1) return mx_eq(a, b, n);
int r = !memcmp(a, b, n);
if (vk_memx_mode == 2 && mx_eq(a, b, n) != r) vk_memx_bad(file, line, n);
return r;
}
static inline __attribute__((always_inline)) void mx_cpy_sw(void *d, const void *s, size_t n) {
if (vk_memx_mode == 1) mx_cpy(d, s, n);
else memcpy(d, s, n);
}
#define MX_EQ(a, b, n) mx_eq_at((a), (b), (n), __FILE__, __LINE__)
#define MX_NE(a, b, n) (!MX_EQ(a, b, n))
#define MX_CPY(d, s, n) mx_cpy_sw((d), (s), (n))
+214 -11
View File
@@ -20,6 +20,14 @@
//
// Only while keyboard and mouse are the device used last (input_kbm_last): a gamepad player sees the menus unchanged.
// TOTK_MENU_CURSOR (live, default 1): 0 leaves the menus to the keys and the pad.
//
// With TOTK_MAP_CLICK=1 (live, default 0: one key per controller button) input.c makes the left mouse button A on the
// map (menu_cursor_map), so a click acts at the map's cursor. The map is found only while TOTK_MENU_CURSOR is on.
//
// The same read of the open screens tells input.c when a dialogue box is on screen (menu_cursor_dialogue), where the
// left mouse button presses B (it advances the text and skips its scroll) and the right one A, instead of their
// bindings (Y by default, which opens the dialogue log, and ZL). TOTK_DIALOGUE_CLICK (live, default 0: one key per
// controller button) switches that on its own: it does not need the pointer.
#include <math.h>
#include <stdint.h>
#include <stdio.h>
@@ -50,6 +58,10 @@ enum { DI_PROJ = 0x10, DI_VIEW = 0x50, LYT_ROOT = 0x18, LYT_SIZE = 0x28, LYT_NAM
// nn::ui2d::Pane
enum { PANE_PARENT = 0x18, PANE_SIZE = 0x50, PANE_FLAG = 0x58, PANE_ALPHA = 0x59, PANE_BASE = 0x5b, PANE_MTX = 0x70 };
// How far the pointer moves, in layout units (1280 x 720 across the picture: 1.5 window pixels at 1080p, 3 at 4K),
// before it takes back a focus that the wheel, the keys or the pad moved away from it (menu_cursor_poll)
#define DEAD_ZONE 6.0f
static uint64_t main_lo, main_hi;
static int ok_at(uint64_t p, uint64_t n) {
@@ -166,16 +178,24 @@ static void layout_name(uint64_t scr, char *out, size_t n) {
// 1.4.3 constructor keeps). The map has no focus box, so it is found here: the Purah Pad's frame (AppMenuOverlay_00)
// with AppMap_00 and the menu's background AppMenuBG_00 open. The Scope opens the frame over AppMap_00 without that
// background (Weeping of the Empire's engine/runtime/totk_menu_cursor.cpp census tells them apart the same way).
// The dialogue window (DIALOGUE_SCREEN) has no focus box either: the scan remembers its screen for dialogue_shown.
// A D-pad strip has no focus box either while it is held open: *strip is ShortCut_00 being open. *camera is the
// Purah Pad's camera (the ability wheel's camera): the frame and its pointer CameraPointer_00 open without AppMap_00,
// which the Scope has with them.
// TOTK_MENU_CURSOR_LOG=1 logs the open screens whenever the set changes.
enum { SM_COUNT = 0x8, SM_SCREENS = 0x10 };
static int map_open(void) {
#define DIALOGUE_SCREEN "MessageDialog_00" // the box a character's lines and the game's messages are shown in
#define DIALOGUE_GAP_MS 500 // how long after the box closed a click is still the dialogue's
static uint64_t dialogue_scr; // game thread only
static int map_open(int *strip, int *camera) {
uint64_t sm = screen_mgr();
if (!sm) return 0;
int32_t n = (int32_t)rd32(sm + SM_COUNT);
uint64_t arr = rd64(sm + SM_SCREENS);
*strip = *camera = 0;
if (n <= 0 || n > 1024 || !ok_at(arr, 8ull * (uint64_t)n)) return 0;
const char *e = cfg_get("TOTK_MENU_CURSOR_LOG");
int verbose = e && !strcmp(e, "1"), pad = 0, map = 0, bg = 0;
int verbose = e && !strcmp(e, "1"), pad = 0, map = 0, bg = 0, pointer = 0;
char list[1024];
size_t len = 0;
uint64_t h = 1469598103934665603ull;
@@ -187,6 +207,9 @@ static int map_open(void) {
pad |= !strcmp(nm, "AppMenuOverlay_00");
map |= !strcmp(nm, "AppMap_00");
bg |= !strcmp(nm, "AppMenuBG_00");
if (!strcmp(nm, DIALOGUE_SCREEN)) dialogue_scr = scr;
pointer |= !strcmp(nm, "CameraPointer_00");
*strip |= !strcmp(nm, "ShortCut_00");
if (!verbose) continue;
for (const char *c = nm; *c; c++) h = (h ^ (uint8_t)*c) * 1099511628211ull;
if (len < sizeof list - 64) len += (size_t)snprintf(list + len, sizeof list - len, "%s%s", len ? " " : "", nm);
@@ -194,8 +217,22 @@ static int map_open(void) {
static uint64_t last;
static int lines;
if (verbose && h != last && lines < 200) last = h, lines++, rt_log("menu_cursor: open screens: %s", list);
*camera = pad && pointer && !map && !bg;
return pad && map && bg;
}
// The dialogue window is open. Read at every pad read from the screen the last scan found open, so a click follows the
// box without the scan's 100 ms: the game keeps its screens, so the one found once is the one that opens the next time.
// A screen that is no longer that layout (a reload built the screens again) is forgotten until a scan finds it.
static int dialogue_shown(void) {
uint64_t scr = dialogue_scr;
if (!scr) return 0;
if (!game_object(scr, SCR_REQUEST + 1)) { dialogue_scr = 0; return 0; }
if (rd8(scr + SCR_STATE) != SCR_OPENED) return 0;
char nm[48];
layout_name(scr, nm, sizeof nm);
if (strcmp(nm, DIALOGUE_SCREEN)) { dialogue_scr = 0; return 0; }
return 1;
}
static void layout_size(uint64_t scr, float *lw, float *lh) {
*lw = 1920, *lh = 1080;
uint64_t lyt = rd64(scr + SCR_LAYOUT);
@@ -280,15 +317,29 @@ static int gameplay_screen(const char *nm) {
static volatile int32_t g_pointer; // a menu has the pointer: input_cursor_allowed releases the capture
static volatile int32_t g_map; // the Purah Pad's map is open (not the Scope): the mouse moves its cursor
static volatile int32_t g_dialogue; // a dialogue box is on screen and TOTK_DIALOGUE_CLICK is on: left B, right A
static volatile int32_t g_menu; // a menu screen has the focus box, from either device (the scroll wheel's steps)
static volatile int32_t g_strip; // a D-pad strip's screen is open (the scroll wheel's steps along it)
static volatile int32_t g_camera; // the Purah Pad's camera is open (the scroll wheel zooms it)
int menu_cursor_pointer(void) { return __atomic_load_n(&g_pointer, __ATOMIC_RELAXED); }
int menu_cursor_map(void) { return __atomic_load_n(&g_map, __ATOMIC_RELAXED); }
int menu_cursor_dialogue(void) { return __atomic_load_n(&g_dialogue, __ATOMIC_RELAXED); }
int menu_cursor_menu(void) { return __atomic_load_n(&g_menu, __ATOMIC_RELAXED); }
int menu_cursor_strip(void) { return __atomic_load_n(&g_strip, __ATOMIC_RELAXED); }
int menu_cursor_camera(void) { return __atomic_load_n(&g_camera, __ATOMIC_RELAXED); }
static int enabled(void) {
if (!RT_V143) return 0;
const char *v = cfg_get("TOTK_MENU_CURSOR"), *in = cfg_get("TOTK_INPUT");
return !(v && !strcmp(v, "0")) && !(in && !strcmp(in, "none"));
}
// The left click in dialogue: its own setting, on with the menu cursor off too
static int dialogue_enabled(void) {
if (!RT_V143) return 0;
const char *in = cfg_get("TOTK_INPUT");
return cfg_bool("TOTK_DIALOGUE_CLICK") && !(in && !strcmp(in, "none"));
}
static void set_pointer(int on) {
if (plat_xchg32(&g_pointer, on) == on) return;
@@ -317,27 +368,68 @@ static void log_screen(const Focus *f, const char *nm, int n, float lw, float lh
// Once per pad read on the game thread: the pointer's hover and clicks, as pad buttons (A, B) for this read
void menu_cursor_poll(uint64_t *buttons) {
static int inited, pending_a, held_l, held_r;
static int inited, pending_a, held_l, held_r, anchored;
static uint64_t pending_node, pending_until, hold_until, hold_bit, menu_seen;
static float last_px = -1, last_py = -1;
static uint64_t ptr_node, last_focus; // the item the pointer last pointed at, the focus at the last read
static float last_px = -1, last_py = -1, anchor_px, anchor_py;
if (!inited) {
inited = 1;
main_lo = MOD_MAIN_BASE, main_hi = MOD_MAIN_BASE + MAIN_SIZE;
if (RT_V143) rt_log("menu_cursor: on for 1.4.3 (TOTK_MENU_CURSOR=0 turns it off)");
}
if (!enabled()) { set_pointer(0); __atomic_store_n(&g_map, 0, __ATOMIC_RELAXED); return; }
Focus f = focus_now();
char nm[48] = "";
if (f.screen) layout_name(f.screen, nm, sizeof nm);
int cursor = enabled(), talk = dialogue_enabled();
if (!cursor && !talk) {
set_pointer(0);
__atomic_store_n(&g_map, 0, __ATOMIC_RELAXED);
__atomic_store_n(&g_dialogue, 0, __ATOMIC_RELAXED);
__atomic_store_n(&g_menu, 0, __ATOMIC_RELAXED);
__atomic_store_n(&g_strip, 0, __ATOMIC_RELAXED);
__atomic_store_n(&g_camera, 0, __ATOMIC_RELAXED);
return;
}
// The open screens are scanned every 100 ms, not at every pad read: each screen costs memory queries
uint64_t now = plat_now_ms();
static uint64_t map_at;
static int map, map_logged;
if (!map_at || now - map_at >= 100) map_at = now, map = map_open();
static int map, map_logged, dialogue_logged, strip, camera;
if (!map_at || now - map_at >= 100) map_at = now, map = map_open(&strip, &camera);
// Between two lines of a conversation the game closes the box and opens it again, so a click made in that gap still
// counts as dialogue for DIALOGUE_GAP_MS after the box was last open. The first clicks after a conversation fall
// in it too and are B or A, as they are for a player who taps the button through the last line.
// TOTK_MENU_CURSOR_LOG=1 logs how long each gap was.
static uint64_t dialogue_seen;
int box = talk && dialogue_shown();
if (!talk) dialogue_seen = 0;
if (box) {
static int gap_lines;
const char *e = cfg_get("TOTK_MENU_CURSOR_LOG");
uint64_t gap = dialogue_seen ? now - dialogue_seen : 0;
if (gap > 30 && gap < 5000 && gap_lines < 100 && e && !strcmp(e, "1"))
gap_lines++, rt_log("menu_cursor: the dialogue box was closed for %llu ms", (unsigned long long)gap);
dialogue_seen = now;
}
int dialogue = box || (dialogue_seen && now - dialogue_seen < DIALOGUE_GAP_MS);
if (dialogue && !dialogue_logged)
dialogue_logged = 1, rt_log("menu_cursor: a dialogue box is open (" DIALOGUE_SCREEN "): left click is B, "
"right click A (TOTK_DIALOGUE_CLICK=1)");
__atomic_store_n(&g_dialogue, dialogue, __ATOMIC_RELAXED);
if (!cursor) {
set_pointer(0);
__atomic_store_n(&g_map, 0, __ATOMIC_RELAXED);
__atomic_store_n(&g_menu, 0, __ATOMIC_RELAXED);
__atomic_store_n(&g_strip, 0, __ATOMIC_RELAXED);
__atomic_store_n(&g_camera, 0, __ATOMIC_RELAXED);
return;
}
__atomic_store_n(&g_strip, strip, __ATOMIC_RELAXED);
__atomic_store_n(&g_camera, camera, __ATOMIC_RELAXED);
Focus f = focus_now();
char nm[48] = "";
if (f.screen) layout_name(f.screen, nm, sizeof nm);
if (map && !map_logged) map_logged = 1, rt_log("menu_cursor: the map is open: the mouse moves its cursor");
__atomic_store_n(&g_map, map, __ATOMIC_RELAXED);
// With the gamepad as the last device the menus stay as they are on the console: no pointer, the capture kept.
// Moving the mouse (or a key) makes keyboard and mouse the last device and the pointer comes.
__atomic_store_n(&g_menu, f.screen && !gameplay_screen(nm) && !map, __ATOMIC_RELAXED);
int menu = f.screen && !gameplay_screen(nm) && ikb_foreground() && input_kbm_last();
if (menu) menu_seen = now;
// A menu's focus gap (a tab switch, a popup opening: no focus box for a frame or two) keeps the pointer where it
@@ -352,7 +444,7 @@ void menu_cursor_poll(uint64_t *buttons) {
return;
}
if (gap) return; // a click's focus request waits for the next screen
if (!menu) { pending_a = 0; last_px = last_py = -1; return; }
if (!menu) { pending_a = 0, anchored = 0, ptr_node = last_focus = 0; last_px = last_py = -1; return; }
if (pending_a) { // the focus asked for by a click: A once it is there
if (rd64(f.control + CTL_ACTIVE) == pending_node) {
pending_a = 0, hold_until = now + 60, hold_bit = 1ull << B_A;
@@ -366,11 +458,21 @@ void menu_cursor_poll(uint64_t *buttons) {
if (click_r) { hold_until = now + 60, hold_bit = 1ull << B_B; *buttons |= hold_bit; return; }
float px, py;
if (!picture_pos(&px, &py)) return;
// The focus moved to another item than the pointer's (the scroll wheel, the keys, the pad): the pointer takes it
// back only after it has left a dead zone of DEAD_ZONE layout units around where it was then, so a hand resting on
// the mouse does not undo a scroll. A click still acts at once.
if (f.node != last_focus) {
if (f.node != ptr_node) anchored = 1, anchor_px = px, anchor_py = py;
last_focus = f.node;
}
int moved = fabsf(px - last_px) > 0.001f || fabsf(py - last_py) > 0.001f;
if (!moved && !click_l) return;
last_px = px, last_py = py;
float lw, lh;
layout_size(f.screen, &lw, &lh);
if (anchored && !click_l && fabsf(px - anchor_px) * lw < DEAD_ZONE && fabsf(py - anchor_py) * lh < DEAD_ZONE)
return;
anchored = 0;
Xf xf = screen_xf(f.screen);
Pt p = {(px - 0.5f) * lw, (0.5f - py) * lh, px * 2 - 1, 1 - py * 2, NULL};
if (xf.ok && !xf_plain(&xf, lw, lh)) p.t = &xf;
@@ -379,6 +481,7 @@ void menu_cursor_poll(uint64_t *buttons) {
log_screen(&f, nm, n, lw, lh, p.t, n && stale_hit_panes(n, btn, lw, lh, p.t));
uint64_t at = n ? node_at(n, node, btn, &p, lw, lh) : 0;
if (!at) return;
ptr_node = at;
if (at != f.node) move_focus(&f, at);
if (click_l) {
if (at == f.node) { hold_until = now + 60, hold_bit = 1ull << B_A; *buttons |= hold_bit; }
@@ -396,3 +499,103 @@ int menu_cursor_shortcut(void) {
if (f.screen) layout_name(f.screen, nm, sizeof nm);
return f.screen && (!strcmp(nm, "ShortCutMainItem_00") || !strcmp(nm, "ShortCut_00"));
}
// ---- The game's menus for quicksave.c, on the game thread: the same reads and focus writes as above, by name
static void main_range(void) {
if (!main_lo) main_lo = MOD_MAIN_BASE, main_hi = MOD_MAIN_BASE + MAIN_SIZE;
}
// nn::ui2d::Pane: its name (+0xb0, 24 characters) and its children, an intrusive list whose links (+0x8 in each
// child) start at +0x20
enum { PANE_CHILDREN = 0x20, PANE_LINK = 0x8, PANE_NAME = 0xb0, PANE_NAME_MAX = 24 };
static int pane_named(uint64_t pane, const char *name) {
if (!ok_at(pane, PANE_NAME + PANE_NAME_MAX)) return 0;
char nm[PANE_NAME_MAX + 1];
memcpy(nm, (const void *)(uintptr_t)(pane + PANE_NAME), PANE_NAME_MAX);
nm[PANE_NAME_MAX] = 0;
return !strcmp(nm, name);
}
// The pane called name in the tree under pane, depth first, 0: none
static uint64_t pane_find(uint64_t pane, const char *name, int depth) {
if (pane_named(pane, name)) return pane;
if (depth >= 6 || !ok_at(pane, PANE_NAME + PANE_NAME_MAX)) return 0;
uint64_t head = pane + PANE_CHILDREN;
int n = 0;
for (uint64_t link = rd64(head); link != head && n < 64; link = rd64(link), n++) {
if (!ok_at(link, 16)) return 0;
uint64_t child = link - PANE_LINK;
if (!ok_at(child, PANE_NAME + PANE_NAME_MAX) || rd64(child + PANE_PARENT) != pane) return 0;
uint64_t hit = pane_find(child, name, depth + 1);
if (hit) return hit;
}
return 0;
}
int menu_ui_open(const char *layout) {
main_range();
uint64_t sm = screen_mgr();
if (!sm) return 0;
int32_t n = (int32_t)rd32(sm + SM_COUNT);
uint64_t arr = rd64(sm + SM_SCREENS);
if (n <= 0 || n > 1024 || !ok_at(arr, 8ull * (uint64_t)n)) return 0;
for (int32_t i = 0; i < n; i++) {
uint64_t scr = rd64(arr + 8ull * (uint64_t)i);
if (!game_object(scr, SCR_REQUEST + 1) || rd8(scr + SCR_STATE) != SCR_OPENED) continue;
char nm[48];
layout_name(scr, nm, sizeof nm);
if (!strcmp(nm, layout)) return 1;
}
return 0;
}
int menu_ui_focus(char *screen, size_t n, uint64_t *node) {
main_range();
Focus f = focus_now();
screen[0] = 0, *node = f.node;
if (f.screen) layout_name(f.screen, screen, n);
return f.screen != 0;
}
uint64_t menu_ui_button(const char *parts, const char *root, int *usable_out) {
main_range();
Focus f = focus_now();
if (!f.screen) return 0;
static uint64_t node[MAX_NODES], btn[MAX_NODES];
int n = nodes_of(f.screen, node, btn);
for (int i = 0; i < n; i++) {
uint64_t pane = root_pane(btn[i]);
char nm[48];
layout_name(btn[i] - SCR_LAYOUT + BTN_LAYOUT, nm, sizeof nm); // the button's parts layout
if (strcmp(nm, parts) || !pane_named(pane, root) || !pane_shown(pane)) continue;
if (usable_out) *usable_out = usable(btn[i]);
return node[i];
}
return 0;
}
// SystemLoadList_00 lists the saves as PaDataFileBtn_00 entries, newest first; an entry without a save fades
// N_Disable_00 out (and is not shown when the list is shorter). The first entry that holds a save, 0 none.
uint64_t menu_ui_first_save(void) {
main_range();
Focus f = focus_now();
if (!f.screen) return 0;
static uint64_t node[MAX_NODES], btn[MAX_NODES];
int n = nodes_of(f.screen, node, btn);
for (int i = 0; i < n; i++) {
uint64_t pane = root_pane(btn[i]);
char nm[48];
layout_name(btn[i] - SCR_LAYOUT + BTN_LAYOUT, nm, sizeof nm);
if (strcmp(nm, "PaDataFileBtn_00") || !usable(btn[i]) || !pane_shown(pane)) continue;
uint64_t filled = pane_find(pane, "N_Disable_00", 0);
if (filled && rd8(filled + PANE_ALPHA) >= 128) return node[i];
}
return 0;
}
int menu_ui_focus_to(uint64_t node) {
main_range();
Focus f = focus_now();
if (!f.screen || !node) return 0;
if (f.node == node) return 1;
move_focus(&f, node);
return 0;
}
Loaded 100 of 350 files, more files were not shown because too many files have changed in this diff. Show more