mirror of
https://github.com/valentderah/totk-pc-recomp.git
synced 2026-11-22 21:15:57 +00:00
Add a player guide to mods and point the README and the tester guide to it
Mods were described only in one dense list in the tester guide. docs/mods.md walks a player through installing a mod, its order and switches, TKMM merges, code patches and their rebuild, what renaming a mod folder does, the reasons the Mods tab gives for an unused mod, and what to check when something looks wrong. docs/cheats.md gains a folder example and the rename note. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
8eb48493c0
commit
2e95221d23
4 files changed
+124
-32
No files matched your search
+4
-28
@@ -54,34 +54,10 @@ The line `vk: using gpu N: <name>` says which one ran.
|
||||
|
||||
## Mods
|
||||
|
||||
Mods made for emulators go into `mods/` next to `totk.exe`, one folder per mod, unpacked as they come:
|
||||
`mods/<name>/romfs/...` (the Atmosphere layout `mods/<name>/atmosphere/contents/0100F2C0115B6000/romfs` works
|
||||
too). The game loads them at the next start. The Mods tab of the in-game menu (F1) lists them: switch a mod off, or move
|
||||
it up or down. When two mods change the same file, the higher one wins.
|
||||
|
||||
- RomFS mods (textures, models, text, gameplay files) work.
|
||||
- Mods packaged for TKMM (`.tkcl`, "TKMM only") and mods that change the same files: merge them in TKMM and set an
|
||||
export location to an empty folder inside `mods/` (for example `mods/TKMM`). That folder is then one mod here.
|
||||
- Files made for another game version (names with `.Product.<number>.` that this version does not have) are left out;
|
||||
the Mods tab counts them. Look for the mod's release for your game version.
|
||||
- The resource size table (`System/Resource/ResourceSizeTable.Product.<n>...rsizetable.zs`), which tells the game how
|
||||
much memory each file needs, is rebuilt at every start with mods enabled: the tables the mods ship are merged and
|
||||
the entries of files a mod made larger or added are raised. The log line `RomFS: resource size table: ...` says
|
||||
how many. A mod's table for another game version still counts for that mod's own files.
|
||||
- Mods that patch the game code (`exefs/*.ips`, `exefs/*.pchtxt`, or `atmosphere/exefs_patches/<name>/*.ips`) work
|
||||
when the patches are for this game version and change only code: the game rebuilds itself with them at the next
|
||||
start (the setup's rebuild window, a few minutes) and switches them with the mod. Patches for another version are
|
||||
counted and left out; a file that writes the game's data, or that the port cannot express, keeps the whole mod off
|
||||
and the Mods tab says why. A patch over one of the port's own patches turns that built-in patch off while the mod
|
||||
is on (the Mods tab names it).
|
||||
- Mods with their own code (`exefs/subsdk*` or a replaced `exefs/main`, such as UltraCam) never load, their RomFS files
|
||||
included.
|
||||
- Cheats: an Atmosphère cheat file goes into a mod's `cheats` folder (`mods/<name>/cheats/<build id>.txt`, the
|
||||
build id `277178B7DBA1B6D4` for 1.4.3, `9B4E43650501A4D4` for 1.2.1). The Cheats tab of the menu switches them.
|
||||
Cheats that write memory work at the next start; for cheats that change the game's code the game opens the setup's
|
||||
rebuild window at start and comes back after it (a few minutes). The port ships no cheat files. Details: [cheats.md](cheats.md).
|
||||
|
||||
The log names every mod at the start (`mods: <name>: ...`) and how many of its files it serves.
|
||||
Mods and cheats made for the emulators go into `mods/` next to `totk.exe`, one folder per mod. [mods.md](mods.md) covers
|
||||
installing them, their order, code patches, what does not work and what to check when something looks wrong;
|
||||
[cheats.md](cheats.md) covers cheat files. The log names every mod at the start (`mods: <name>: ...`); when you
|
||||
report a problem with mods, list them with their download links.
|
||||
|
||||
## What to send back
|
||||
|
||||
|
||||
Reference in new issue
Block a user