diff --git a/docs/building.md b/docs/building.md index 0baf5c95..8eb2a540 100644 --- a/docs/building.md +++ b/docs/building.md @@ -124,13 +124,13 @@ of them. `SDL3.dll`, `libiconv-2.dll` and `libopus-0.dll` next to the exe. 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\ omfs-patches-xbox`, `-xbox-label`, `-playstation` and `-playstation-xbox` + `build\\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 x` 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\ omfs-patches-x-hud16x9` (`-hud21x9`), which the game loads for `hud_width = 16:9` + `--out` then is `build\\romfs-patches-x-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 diff --git a/docs/controls.md b/docs/controls.md index 9a79db32..e2102f4b 100644 --- a/docs/controls.md +++ b/docs/controls.md @@ -71,11 +71,11 @@ The game reads its UI archive and fonts once at boot, so the prompts change at t 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 --prompts xbox` (and `--prompts xbox-label`) writes `build\ omfs-patches-xbox` (`-label`); `--prompts playstation` and `--prompts playstation-xbox` write `build\ omfs-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`. +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 --prompts xbox` (and `--prompts xbox-label`) writes `build\\romfs-patches-xbox` (`-label`); `--prompts playstation` and `--prompts playstation-xbox` write `build\\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-