From 8c9c18a6d2832c482f55b5103ee6751c91108bcb Mon Sep 17 00:00:00 2001 From: Valiantsin Dzerakh Date: Tue, 17 Nov 2026 11:06:32 +0300 Subject: [PATCH] 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 --- docs/installer.md | 58 ++++++++++++++++++++++--------------------- installer/guilogic.py | 3 ++- installer/layout.py | 6 ++--- installer/steps.py | 8 ++++-- 4 files changed, 41 insertions(+), 34 deletions(-) diff --git a/docs/installer.md b/docs/installer.md index 24b3a22d..d828f898 100644 --- a/docs/installer.md +++ b/docs/installer.md @@ -44,14 +44,15 @@ The install folder (`main.c` `portable_paths()` reads this layout; it stays 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, 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 +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 (`/temp/-`, 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. +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 @@ -74,11 +75,12 @@ loads the saves 1.4.3 wrote. and BFTTF header). Without a firmware folder the setup warns and goes on; the game then lacks those glyphs. 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 (`/main/folded.txt`, its jump tables). + `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 (`/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` @@ -122,29 +124,29 @@ A cancelled or failed setup resumes from the last finished step (`totk-install.j ## Rebuilding for the mods -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. +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 `, started through `python -c` so the release folder is on `sys.path` 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 working, but its first rebuild compiles everything once: Ninja's records hold the old absolute paths of the -generated C and of the compiler's own headers. On Linux the command -starts the AppImage file itself (`$APPIMAGE --rebuild `), 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. +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 working, but its first rebuild compiles everything once: Ninja's records hold the old absolute +paths of the generated C and of the compiler's own headers. On Linux the command starts the AppImage file itself +(`$APPIMAGE --rebuild `), 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 diff --git a/installer/guilogic.py b/installer/guilogic.py index 3579a5ac..cd4fe53a 100644 --- a/installer/guilogic.py +++ b/installer/guilogic.py @@ -27,7 +27,8 @@ TEXT = Path(__file__).resolve().parent / 'text' UI_LANGUAGES = ('en', 'ru', 'pt-BR', 'zh-Hans') # 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', 'kit', 'fonts', 'extract', 'lift', 'compile', 'prepare', 'pc_prompts', 'shapes', 'dlss', 'cleanup') +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 diff --git a/installer/layout.py b/installer/layout.py index 3b6371f9..022a6fad 100644 --- a/installer/layout.py +++ b/installer/layout.py @@ -32,9 +32,9 @@ 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-.profdata when there is one; build/install-temp/-. Dev mode and -the Linux release install no build kit: the repository, or the AppImage file, is what the rebuild runs. 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-.profdata when there is one; build/install-temp/-. 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 diff --git a/installer/steps.py b/installer/steps.py index e0983bd1..f044216f 100644 --- a/installer/steps.py +++ b/installer/steps.py @@ -14,8 +14,8 @@ screen shapes and the prompts style this player needs, installer/screens.py), to 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, /- -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 +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//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 @@ -712,11 +712,15 @@ class Kit(Step): 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)