From 4d871c7920490ca82b3e024317424db396803300 Mon Sep 17 00:00:00 2001 From: Pasha Kagan Date: Fri, 30 Oct 2026 07:31:56 +0200 Subject: [PATCH] Describe the shader cache pack in the installer documentation --- docs/installer.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/installer.md b/docs/installer.md index b6157b83..a3158d28 100644 --- a/docs/installer.md +++ b/docs/installer.md @@ -24,7 +24,7 @@ The install folder (`main.c` `portable_paths()` reads this layout; it stays port exefs/, romfs/ extracted from the player's files profile/ saves 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 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 ``` @@ -50,7 +50,9 @@ keeps `profile/`. Saves carry over both ways: 1.4.3 converts a 1.2.1 save on loa hashes and the game version's patch page) and link them with the prebuilt runtime library into `totk.exe` (`build_game.py --runtime-lib`; about 3 min on 24 cores). 5. **Prepare** the RomFS patches and the shaders (`tools/make_romfs_patches.py`, `tools/prepare_shaders.py`, - `totk.exe --prepare-shaders`) in the install folder. + `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. 6. **Clean up** the temp folder (generated C and objects, about 1.3 GB). A cancelled or failed setup resumes from the last finished step (`totk-install.json`).