Skip to content

Commit 476e2f3

Browse files
committed
Update manual and version number
1 parent b623f56 commit 476e2f3

File tree

3 files changed

+37
-32
lines changed

3 files changed

+37
-32
lines changed

USER_MANUAL.md

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -111,28 +111,6 @@ This menu allows you to modify your entire inventory, including standard items,
111111

112112
28. **Clear Area Flags** allows you to clear most of the flags for a specified area. A confirmation message is displayed when trying to do so, to prevent accidently clearing flags. The flags will be cleared on the next screen transition.
113113

114-
29. **Manage Custom States** allows you to create up to 15 states that keep track of the following:
115-
* All of your current **standard items**, **important items**, **badges** (also **equipped badges**), and **stored items**
116-
* The current **Sequence Position**
117-
* The following data for **Mario**:
118-
* Current HP
119-
* Max HP
120-
* Current FP
121-
* Max FP
122-
* Current SP
123-
* Max SP
124-
* Available BP
125-
* Max BP
126-
* Rank
127-
* Level
128-
* Star Powers
129-
* Star Points
130-
* Coins
131-
* All of the **partner**s' current stats
132-
* Which **partner**/**follower** is currently out
133-
* Whether or not **Mario** is currently in **Boat Mode**
134-
* The current **map** and **loading zone**
135-
136114
### Stats
137115
This menu allows you to modify Mario's stats, all of your partner's stats, whether or not partners are enabled or not, whether a partner is out or not, and whether or not a follower is out or not.
138116
* You are also able to change Yoshi's color and name from within the **Partners** menu. Upon changing the color, you must respawn Yoshi for the changes to take effect. This is done by either swapping partners, entering pipes, or bringing Yoshi out via the menu itself.
@@ -145,7 +123,7 @@ This menu allows you to save and load various settings. The settings are stored
145123
* Displays button combinations
146124
* Memory Watches (See [Memory](#memory))
147125
* Memory Editor settings (See [Memory](#memory))
148-
* Custom States
126+
* Custom States (See [Warps](#warps))
149127

150128
It should also be noted that the settings will be loaded automatically at boot, assuming that a settings file is present on one of the memory cards. If settings files exist on both memory cards, then the one in Slot A will be used.
151129

@@ -228,14 +206,16 @@ This menu allows you to change the HP, Max HP, FP, Max FP, held items, and statu
228206

229207
16. **Hit Check Visualization** displays lines for collision detections for anything that runs through the **hitCheckVecFilter** function.
230208

231-
17. **Yoshi Skip** displays various information about performing this skip. The main timer (labeled YST) is set to reset and start running once you leave a battle, and pauses once you press A. You can also manually reset this timer by holding Y for two seconds.
209+
17. **Yoshi Skip** displays various information about performing this skip. The main timer (labeled YST) is set to reset and start running once you leave a battle, and pauses once you press A. You can also manually reset this timer by holding B for two seconds.
232210

233-
18. **Palace Skip** displays various information about performing this skip. The main timer (labeled PST) is set to reset and start once you leave the pause menu, and pauses once you press X. You can also manually reset this timer by holding Y for two seconds. **PhaEmy** keeps track of the Y coordinate for the phantom ember, **ItemTimer** keeps track of the timer for the current item in the field, and **ParY** keeps track of your partner's Y coordinate.
211+
18. **Palace Skip** displays various information about performing this skip. The main timer (labeled PST) is set to reset and start once you leave the pause menu, and pauses once you press X. You can also manually reset this timer by holding B for two seconds. **PhaEmy** keeps track of the Y coordinate for the phantom ember, **ItemTimer** keeps track of the timer for the current item in the field, and **ParY** keeps track of your partner's Y coordinate.
234212

235-
19. **Bridge Skip** displays various information about performing this skip. The first field in this display is how many frames early/late you were with pressing A. If you press A on the correct frame, then the counter will remain at 0. You can also manually reset this counter by holding Y for two seconds. **HRP** is the pointer to the area of ground in the current room that you will respawn at upon touching a hazard. In order for **Bridge Skip** to work (as well as any other **Hazard Respawn Glitch**), this pointer must not be set, in which the value will be `0x00000000`.
213+
19. **Jabbi Hive Skip** displays various information about performing this skip. The first field in this display tells you how well your pause jump was (pressed **D-Pad Left** first, pressed **A** first, or pressed both buttons at the same time). **FBP** is the amount of frames between pressing **D-Pad Left** and **A** to do the unspin jump, and **FBUP** is the amount of frames between the two **A** presses for closing the menu.
214+
215+
19. **Bridge Skip** displays various information about performing this skip. The first field in this display is how many frames early/late you were with pressing A. If you press A on the correct frame, then the counter will remain at 0. You can also manually reset this counter by holding B for two seconds. **HRP** is the pointer to the area of ground in the current room that you will respawn at upon touching a hazard. In order for **Bridge Skip** to work (as well as any other **Hazard Respawn Glitch**), this pointer must not be set, in which the value will be `0x00000000`.
236216
* Note: **Bridge Skip** will be possible in the PAL version of the game when this display is active.
237217

238-
20. **Blimp Ticket Skip** displays various information about performing this skip. The up-right timer (labeled **URT**) is set to reset and start running once you leave the pause menu, and pauses once the held stick angle reaches 25 or higher on JP, and 27 or higher on US/EU. The straight-up timer (labeled **SUT**) is set to reset and start running once you leave the pause menu, and pauses once the held stick angle is 0.00. Both of these timers can be manually reset by holding Y for two seconds.
218+
20. **Blimp Ticket Skip** displays various information about performing this skip. The up-right timer (labeled **URT**) is set to reset and start running once you leave the pause menu, and pauses once the held stick angle reaches 25 or higher on JP, and 27 or higher on US/EU. The straight-up timer (labeled **SUT**) is set to reset and start running once you leave the pause menu, and pauses once the held stick angle is 0.00. Both of these timers can be manually reset by holding B for two seconds.
239219

240220
### Warps
241221
This menu allows you to warp to various places around the game. You have three separate options to choose from:
@@ -266,9 +246,32 @@ This menu allows you to warp to various places around the game. You have three s
266246
* If an invalid entrance is used, then Mario will be placed at/near the center of the chosen map.
267247

268248
* Some maps have entrances that don't actually work. Using them will simply place Mario at/near the center of the chosen map.
249+
269250
4. **Warp To Boss** allows you to warp to most bosses/mini-bosses in the game.
270251
* Note: Warping to a boss using this menu will adjust the game's **Sequence** value.
271252

253+
5. **Custom States** allows you to create up to 15 states that keep track of the following:
254+
* All of your current **standard items**, **important items**, **badges** (also **equipped badges**), and **stored items**
255+
* The current **Sequence Position**
256+
* The following data for **Mario**:
257+
* Current HP
258+
* Max HP
259+
* Current FP
260+
* Max FP
261+
* Current SP
262+
* Max SP
263+
* Available BP
264+
* Max BP
265+
* Rank
266+
* Level
267+
* Star Powers
268+
* Star Points
269+
* Coins
270+
* All of the **partner**s' current stats
271+
* Which **partner**/**follower** is currently out
272+
* Whether or not **Mario** is currently in **Boat Mode**
273+
* The current **map** and **loading zone**
274+
272275
## Misc
273276
There are several other changes that have been made outside of the menu:
274277
1. The build date on the title screen is always displayed.
@@ -283,7 +286,9 @@ There are several other changes that have been made outside of the menu:
283286

284287
6. A function in the game called **npcNameToPtr** can sometimes return an improper pointer, so an error message will be displayed on-screen when this happens. The message will be displayed for about 5 seconds.
285288

286-
7. Several crashes have been fixed/prevented:
289+
7. A function in the game called **animPoseMain** will crash if a negative value is passed to it, so the function will be prevented from running to avoid the crash, and an error message will be displayed on-screen when this would occur. The message will be displayed for about 5 seconds.
290+
291+
8. Several crashes have been fixed/prevented:
287292
* Petalburg intro cutscene - Mario will not have any greeting animation.
288293

289294
* Excess Express - When going to Poshley Heights - If you enter the western-most train car when the **Sequence** is past 338, then the **Sequence** will be set to 338.
@@ -296,6 +301,6 @@ There are several other changes that have been made outside of the menu:
296301

297302
* When defeating Blooper with an attack that causes both the body and the left tentacle to be defeated at roughly the same time.
298303

299-
8. The cutscene before the final Shadow Queen fight has been adjusted to prevent one of the game's heaps from becoming corrupted, in which less textboxes will appear at the start of the cutscene. Similarly, the cutscenes in Fahr Outpost and The Great Tree before the final Shadow Queen fight have also been adjusted to prevent one of the game's heaps from becoming corrupted, in which the textboxes that appear in those cutscenes will appear less frequently.
304+
9. The cutscene before the final Shadow Queen fight has been adjusted to prevent one of the game's heaps from becoming corrupted, in which less textboxes will appear at the start of the cutscene. Similarly, the cutscenes in Fahr Outpost and The Great Tree before the final Shadow Queen fight have also been adjusted to prevent one of the game's heaps from becoming corrupted, in which the textboxes that appear in those cutscenes will appear less frequently.
300305

301-
9. A memory leak that would occur when starting a new file has been fixed. This specific memory leak would occur when allocating memory that would be used for the inventory, as the game doesn't check if the memory has already been allocated or not.
306+
10. A memory leak that would occur when starting a new file has been fixed. This specific memory leak would occur when allocating memory that would be used for the inventory, as the game doesn't check if the memory has already been allocated or not.

ttyd-tools/rel/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ INCLUDES := include
5151

5252
MACHDEP = -mno-sdata -mgcn -DGEKKO -mcpu=750 -meabi -mhard-float
5353

54-
CFLAGS = -nostdlib -ffreestanding -ffunction-sections -fdata-sections -g -Os -Wall -Werror -Wformat-overflow=0 -Wextra -Wno-address-of-packed-member $(MACHDEP) $(INCLUDE)
54+
CFLAGS = -nostdlib -ffreestanding -ffunction-sections -fdata-sections -g -Os -Wall -Werror -Wextra -Wformat-overflow=0 -Wno-address-of-packed-member $(MACHDEP) $(INCLUDE)
5555
CXXFLAGS = -fno-exceptions -fno-rtti -std=gnu++17 $(CFLAGS)
5656

5757
LDFLAGS = -r -e _prolog -u _prolog -u _epilog -u _unresolved -Wl,--gc-sections -nostdlib -g $(MACHDEP) -Wl,-Map,$(notdir $@).map

ttyd-tools/rel/source/global.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace mod {
77

8-
const char *VersionNumber = "v3.0.56d";
8+
const char *VersionNumber = "v3.0.56";
99

1010
const char *RootLines[] =
1111
{

0 commit comments

Comments
 (0)