mirror of
https://github.com/valentderah/totk-pc-recomp.git
synced 2026-11-22 13:05:57 +00:00
A cheat file is now part of a mod: mods/<mod>/cheats/<build id>.txt, or the Atmosphere places inside the mod folder, the file name in any case. The port ships no cheat files any more (the MyNXCheats files and their notice row are gone). - tools/cheats.py --mods builds the code cheats of every mod folder; a cheat's key hashes "<mod folder>/<name>", so two mods' cheats of one name keep their own switches. - The setup reads the cheats from <install>/mods and writes the status to build-cache/cheats.status. - runtime/cheats.c reads the files of the enabled mods the port can use, in the Mods tab order, and the status from build-cache. - A mod with only cheats is usable. The Cheats tab groups the cheats by mod, and the Mods tab says how many cheats a mod brought. - The cheat texts are in all four menu languages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
66 lines
4.5 KiB
Markdown
66 lines
4.5 KiB
Markdown
# Cheats
|
|
|
|
The port reads Atmosphère cheat files, the format Switch homebrew and the emulators use. It ships no cheat files: a cheat file goes into a mod in the `mods` folder next to `totk.exe`, like any other mod ([tester-guide.md](tester-guide.md), "Mods"). Open the menu (F1) and switch the cheats on the Cheats tab. The switches are saved under `[cheats]` in `totk.ini`.
|
|
|
|
## Adding a cheat file
|
|
|
|
1. Find the cheat file for your update. Cheat sites and collections name it after the first 8 bytes of the game's build id:
|
|
|
|
| Update | File |
|
|
|---|---|
|
|
| 1.2.1 | `9B4E43650501A4D4.txt` |
|
|
| 1.4.3 | `277178B7DBA1B6D4.txt` |
|
|
|
|
The Cheats tab names the file the installed game reads when no mod holds one, and `logs\totk.log` says `cheats: no enabled mod holds cheats/<id>.txt`.
|
|
2. Put it in the `cheats` folder of a mod: `mods\My cheats\cheats\277178B7DBA1B6D4.txt`. A download laid out for the Switch's SD card or an emulator works as it is: unpack it into a folder of its own under `mods`, and the port finds `atmosphere\contents\0100F2C0115B6000\cheats`, `contents\0100F2C0115B6000\cheats` or `0100F2C0115B6000\cheats` inside it. The file name's case does not matter.
|
|
3. Start the game. Cheats that write the game's memory work now.
|
|
4. Cheats that change the game's code are greyed out with "run the setup again" until you run `TotK-Setup.exe` again on the same folder. It builds the code cheats of every mod into the game; saves and settings are kept.
|
|
5. Switch the cheats on the Cheats tab of the menu.
|
|
|
|
The Cheats tab lists the cheats grouped by mod, in the order of the Mods tab. A mod switched off on the Mods tab, or one the port cannot use, contributes no cheats; the change applies at the next start. The Mods tab says how many cheats each mod brought.
|
|
|
|
## The file format
|
|
|
|
Standard Atmosphère: a `[name]` line starts a cheat, `{name}` a master cheat that is always on, and the cheat's opcodes follow as 8-digit hex words. A name with no opcodes is shown as a heading. The file's title line (the one with `TID=`) is not shown.
|
|
|
|
```
|
|
[The Legend of Zelda: Tears of the Kingdom v1.4.3 TID=0100F2C0115B6000 BID=277178B7DBA1B6D4]
|
|
|
|
[Player]
|
|
[A code cheat]
|
|
040A0000 XXXXXXXX YYYYYYYY
|
|
|
|
[A data cheat (Hold ZL+X)]
|
|
80000104
|
|
580F0000 XXXXXXXX
|
|
640F0000 00000000 YYYYYYYY
|
|
20000000
|
|
```
|
|
|
|
The words above are placeholders: `XXXXXXXX` an offset, `YYYYYYYY` a value.
|
|
|
|
Each cheat's switch is `cheat_<hash> = 1`, where the hash is FNV-1a 32 of `<mod folder name>/<cheat name>`. A name repeated in one file gets `#2`, `#3` and so on. Renaming a mod's folder resets its cheats' switches to off.
|
|
|
|
## How cheats run
|
|
|
|
The game's code is compiled ahead of time, so a cheat cannot write new instructions into it while the game runs. The port sorts each cheat by what it writes (`tools/cheats.py` at setup, `runtime/cheats.c` in game):
|
|
|
|
| Kind | What the cheat does | How the port runs it |
|
|
|---|---|---|
|
|
| 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. |
|
|
| 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. |
|
|
|
|
A cheat whose code writes call or jump into a code cave the cheat writes itself (into main's zero padding) gets the cave inlined at the call site. The setup builds the code cheats of every mod in the `mods` folder, switched on or off, so switching a mod on later needs only a restart. A code cheat added or edited after the setup ran is greyed out until the setup runs again; a data cheat runs at the next start.
|
|
|
|
Not supported, and shown greyed out with the reason:
|
|
|
|
- the 0xC and 0xF opcode extensions;
|
|
- 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.
|
|
|
|
`build-cache\cheats.status` next to `totk.exe`, written by the setup, records which cheats were built and how; the log line `cheats: ...` sums them up at start. When the code cheats cannot be built, the setup warns and installs the game without them.
|