Version 3.0 Release

Author: Zephiles

README.md

@@ -1,12 +1,26 @@
-This contains the practice codes that I have made for Paper Mario: The Thousand-Year Door. The initial code for this project came from PistonMiner's work. https://github.com/PistonMiner/ttyd-tools
+## Credits
+* **PistonMiner** for their work on the TTYD scripting disassembly, the initial code for the rel framework, and the elf2rel, gcipack, and rellink utilities. (GitHub repo for these tools [here](https://github.com/PistonMiner/ttyd-tools).)
+* **Jdaster64** for their work on the Shufflizer. (GitHub repo for the Shufflizer [here](https://github.com/jdaster64/shufflizer).)
 
-The codes are stored on the save files (gci files) listed on the releases page. You must use the proper file for your version of the game.  
-G8ME = US, G8MJ = JP, G8MP = EU  
-https://github.com/Zephiles/ttyd-tools/releases
+## Overview
+These are practice codes that I have made for Paper Mario: The Thousand-Year Door. 
 
-To use them on console, you need to use a homebrew app to move the save file onto your memory card, and then use the provided gct files with your prefered homebrew app.  
-https://github.com/Zephiles/ttyd-tools/tree/master/ttyd-tools/relloader-ttyd/REL_Loader/GCT
+## Download
+The latest release can be found on the [releases page](https://github.com/Zephiles/TTYD-Practice-Codes/releases).
 
-To use them on an emulator such as Dolphin, you need to either import the save file onto the virtual memory card used by the emulator, or move the file into the GCI folder (this is a Dolphin thing). You must then use either the provided Action Replay code or the provided Gecko code. The Gecko code is shorter, so that is the prefered code to use. The Action Replay code is provided mainly for people who happen to be using the old Action Replay discs, or for people who are having issues applying Gecko codes in Dolphin.  
-https://github.com/Zephiles/ttyd-tools/tree/master/ttyd-tools/relloader-ttyd/REL_Loader/Action_Replay  
-https://github.com/Zephiles/ttyd-tools/tree/master/ttyd-tools/relloader-ttyd/REL_Loader/Gecko  
+## Usage
+See the [user manual](https://github.com/Zephiles/TTYD-Practice-Codes/blob/master/USER_MANUAL.md).
+
+## Prerequisites
+To build this, you need to have devkitPPC installed. Instructions for doing so can be found [here](https://devkitpro.org/wiki/Getting_Started). You also need to place **elf2rel.exe** in the **bin** folder. This file can either be compiled manually, or downloaded from [here](https://github.com/PistonMiner/ttyd-tools/releases/download/v2.4/elf2rel.exe).
+
+## Building
+To build, navigate to the root directory of the repository (the folder with the makefile in it) and run `make`. Any combination of rules can be applied to this.
+`make us`
+`make jp eu`
+`make us eu`
+
+## Special Thanks
+* **PistonMiner** for helping me with many C++ questions, and overall providing a ton of in-depth technical assistance.
+* **Jdaster64** for helping me with various formulas, providing logic about guard/superguard timing, and other C++ related help.
+* **Gibstack** for testing out the menu, and for confirming many battle actor names.

USER_MANUAL.md

@@ -0,0 +1,80 @@
+# User manual
+
+## Table of contents
+-   [Setup](#setup)
+-   [Menus](#menus)
+    -   [Inventory](#inventory)
+    -   [Cheats](#cheats)
+    -   [Stats](#stats)
+    -   [Battles](#battles)
+    -   [Displays](#displays)
+    -   [Warps](#warps)
+-   [Misc](#misc)
+
+## Setup
+* Download the GCI from the most recent release (found [here](https://github.com/Zephiles/TTYD-Practice-Codes/releases)).
+* Copy the GCI containing the Practice Codes to the memory card. (This file contains only code required to run the Practice codes. It has no relation to the standard TTYD save file.)
+  * For **Dolphin** users:
+    * Use the memcard manager located in **Tools > Memcard Manager (GC)** to import the GCI into the file Dolphin is using for a memory card.
+    * Alternatively, select "GCI Folder" for the format of the memory card in Slot A (in **Config dialog > GameCube > Device settings**), and copy the .gci file directly into the folder, located by default at **{Dolphin directory}/GC/<Region>/Card A**. *<Region>* will either be USA, JAP, or EUR depending on the region of the game that you're using.
+  * For **Nintendont** or other console users:
+    * Use the appropriate homebrew apps / folders, etc. to copy the file from your SD card to your GC memory card or virtual memory card.
+* Use the Gecko loader cheat code in the "relloader-ttyd" directory to make the game load the Practice Codes GCI.
+  * For **Dolphin** users:
+    * Right-click your TTYD game in the games list and go to **Properties > Gecko Codes**, and add the appropriate Gecko loader code for the region of the game you are using (found [here](https://github.com/Zephiles/TTYD-Practice-Codes/tree/master/ttyd-tools/relloader-ttyd/REL_Loader/Gecko)).
+    * (For older revisions of Dolphin v5, instead go to **Properties > Edit Config**, and copy the text code into the Gecko codes section of the "G8ME01.ini" file that opens, marked by the text **[Gecko]**; if the section doesn't exist, add it.)
+    * Enable cheats in **Config dialog > General**, and enable the loader code in **Properties > Gecko Codes** for TTYD.
+  * For **Nintendont** users:
+    * Copy the loader GCT (found [here](https://github.com/Zephiles/TTYD-Practice-Codes/tree/master/ttyd-tools/relloader-ttyd/REL_Loader/GCT)) onto your SD card, either to **/codes/** or into the folder with your TTYD ISO. 
+        * Note: It is important that you **do not** right click to save the GCT, or it will be saved incorrectly. You must download it via the **Download** button.
+    * Enable cheats in Nintendont's settings before booting the game.
+  * Alternatively, you can use the Action Replay loader code (e.g., if you have a physical Action Replay disc).
+
+## Menus
+### Inventory
+This menu allows you to modify your entire inventory, including standard items, important items, badges, and stored items.
+
+### Cheats
+1. **Change Sequence** allows you to change the current Sequence value, which is the value used to tell what part of the game you're currently at.
+2. **Save Coordinates** allows you to save Mario's and your partner's current positions and angles.
+3. **Load Coordinates** allows you to load the positions and angles saved from the previous code.
+4. **Spawn Item** allows you to spawn any item into the field.
+5. **Save Anywhere** allows you to save the game at any location, even if a save block is not present in the current room.
+6. **Text Storage** sets a specific value that causes Text Storage to be active. A partner is required to be out for this code to have an effect.
+7. **Time Stop Text Storage** sets a specific value that causes Time Stop Text Storage to be active. A partner is required to be out for this code to have an effect.
+8. **Speed Up Mario** applies a large speed boost to Mario. 
+9. **Disable Non-Cutscene Battles** disables any battles in the field that are started by a cutscene.
+10. **Auto Action Commands** automatically performs action commands for you, similar to how the Debug Badge works. This applies to most guards/superguards as well as for filling the run meter.
+11. **Infinite Item Usage** allows you to use any item without it being removed from the menu. You must hold the button combination when using the item for this code to work.
+12. **Reload Room** reloads the current room. This cannot be used on the title screen nor on the file select screen.
+13. **Levitate** allows you to levitate in the air. You must hold the button combination for this code to work.
+14. **Lock Mario's HP To Max** locks Mario's current HP to the max.
+15. **Allow Running From Any Battle** allows you to run from any battle, even if the battle would normally not allow this.
+16. **Bobbery Early** clears some values, which allows you to perform Bobbery Early more than once on a save file without the need to reload.
+17. **Force NPC Item Drop** forces any defeared enemy to drop a specified item. The item can be changed at will.
+18. **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.
+
+### Stats
+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.
+
+### Battles
+This menu allows you to change the HP, Max HP, FP, Max FP, and statuses of anyone in a battle (refered to as Actors).
+* Note: This menu can only be used while in a battle. 
+
+### Displays
+1. **On-Screen Timer** displays a timer at the bottom-right of the screen. This timer is set to run at the current FPS, and therefore will count from 0 to 59 (0 to 49 for EU at 50hz) before reaching one second.
+2. **Mario's Coordinates** displays Mario's coordinates at the bottom-left of the screen. If the On-Screen Timer is active, then the position of Mario's Coordinates will be shifted upwards.
+3. **Jump Storage** displays a value that determines whether you have Jump Storage or not. The value will be 0 when you don't have it, and 1 when you have it. While this display is active, you can press Y three times in succession to manually give yourself Jump Storage.
+4. **Button Input Display** displays which buttons are pressed at the bottom-left of the screen. When this display is active, the other displays that are placed at the bottom-left of the screen are shifted upwards.
+5. **Art Attack Hitboxes** displays boxes around enemies in battles when using Art Attack.
+6. **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.
+7. **Palace Skip** displays various information about performing this skip. The main timer (labeled YST) 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.
+
+### Warps
+This menu allows you to warp to various places around the game. A description for each option is displayed when the cursor is over one.
+
+## Misc
+There are several other changes that have been made outside of the menu:
+1. The current Sequence value is displayed in the pause menu next to Mario's stats.
+2. The sound effects for pausing, unpausing, bringing up the Z menu, and closing the Z menu are disabled.
+3. The unused Mega badges can be used in battles without the need for a boot/hammer upgrade.

ttyd-tools/bin/readme.txt

@@ -0,0 +1 @@
+Place elf2rel.exe in this folder.

ttyd-tools/rel/include/buttons.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#include <cstdint>
+
+namespace clearcache {
+
+void clear_DC_IC_Cache(void *ptr, uint32_t size);
+
+}

ttyd-tools/rel/include/clearcache.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include <cstdint>
+
+namespace mod {
+
+void saveMarioAndPartnerPositions();
+void loadMarioAndPartnerPositions();
+void saveAnywhere();
+void setTextStorage();
+void setTimeStopTextStorage();
+void speedUpMario();
+void reloadRoomMain();
+void reloadRoom();
+void levitate();
+void lockMarioHPToMax();
+void bobberyEarly();
+void spawnItem();
+
+void displaySequenceInPauseMenu();
+void displayOnScreenTimer();
+void displayMarioCoordinatesBoolCheck();
+void displayJumpStorageDetails();
+void displayButtonInputs();
+void displayYoshiSkipDetails();
+void displayPalaceSkipDetails();
+
+int32_t warpToMap(uint32_t value);
+
+}

ttyd-tools/rel/include/codes.h

@@ -0,0 +1,39 @@
+#pragma once
+
+#include <ttyd/seqdrv.h>
+
+#include <cstdint>
+
+namespace mod {
+
+bool checkButtonCombo(uint16_t combo);
+bool checkButtonComboEveryFrame(uint16_t combo);
+bool checkForSpecificSeq(ttyd::seqdrv::SeqIndex wantedSeq);
+bool checkIfInGame();
+void *getBattlePointer();
+void *getMarioBattlePointer();
+void *getPartnerBattlePointer();
+void *getActorPointer(uint32_t slot);
+uint32_t secondsToFrames(uint32_t seconds);
+uint32_t getSequencePosition();
+void setSequencePosition(uint32_t value);
+void setNextMap(const char *map);
+void setNextBero(const char *bero);
+bool compareStrings(const char *str1, const char *str2);
+bool compareStringsSize(const char *str1, const char *str2, uint32_t size);
+uint32_t getSystemLevel();
+void setSystemLevel(uint32_t value);
+void setSeq(const char *map, const char *bero);
+void setSpecificSeq(ttyd::seqdrv::SeqIndex seq, const char *map, const char *bero);
+void *clearMemory(void *destination, uint32_t size);
+int32_t getPartnerID();
+int32_t getFollowerID();
+void *getPartnerPointer();
+void *getFollowerPointer();
+void removePartnerFromOverworld();
+void removeFollowerFromOverworld();
+bool checkIfBadgeEquipped(int16_t badge);
+void recheckJumpAndHammerLevels();
+uint32_t getCurrentPitFloor();
+
+}

ttyd-tools/rel/include/commonfunctions.h

@@ -0,0 +1,96 @@
+#pragma once
+
+#include <cstdint>
+
+namespace mod {
+
+void drawFunctionOnDebugLayer(void (*func)());
+void drawFunctionOn2DLayer(void (*func)());
+
+void drawMenuWindow();
+
+void drawWindow(uint32_t color, int32_t x, int32_t y, int32_t width, 
+	int32_t height, int32_t curve);
+
+int32_t *drawIcon(int32_t position[3], int16_t iconNum, float scale);
+int32_t *drawIconFromItem(int32_t position[3], int16_t itemNum, float scale);
+void drawStringMultiline(float x, float y, const char *text);
+void startDrawString(uint8_t alpha, uint32_t color, float scale);
+
+void drawText(const char *text, int32_t x, int32_t y, uint8_t alpha, 
+	uint32_t color, float scale);
+
+void drawTextWithWindow(const char *text, int32_t textPosX, int32_t textPosY, uint8_t alpha, 
+	uint32_t textColor, float textScale, int32_t windowWidth, uint32_t windowColor, float windowCurve);
+
+void drawSingleColumnMain();
+void drawSingleColumn(uint32_t maxOptionsPerPage, uint32_t currentPage);
+
+void drawMultipleColumnsVertical(int32_t posX, int32_t posY, uint32_t currentMenuOption, 
+	uint32_t currentPage, uint32_t size, uint32_t maxOptionsPerPage, 
+		uint32_t maxOptionsPerRow, bool showCurrentOption, 
+			uint32_t posXIncrementAmount, const char **lines);
+
+void drawInventoryIconAndTextColumns();
+
+void drawItemIconsColumn(uint32_t indexStart, uint32_t indexIncrement, uint32_t size, 
+	int32_t posX, int32_t posY, uint32_t address, float scale);
+
+void drawItemTextColumn(uint32_t indexStart, uint32_t indexIncrement, uint32_t size, 
+	int32_t posX, int32_t posY, uint32_t address, uint8_t alpha, float scale);
+
+void drawMarioSpecialMovesOptions();
+void drawFollowersOptions();
+void drawMarioStats();
+void drawPartnerStats();
+void drawBattlesActorStats();
+void drawCurrentFollowerOut();
+void drawBattlesActorsList();
+void drawBattlesStatusesList();
+
+void drawErrorWindow(const char *text, int32_t textPosX, int32_t windowWidth);
+void drawErrorMessage(const char *line);
+void drawWarpsErrorMessage();
+void drawPartnerFollowerMessage(const char *message);
+void drawPartnerErrorMessage();
+void drawFollowersErrorMessage();
+void drawNotInBattleErrorMessage();
+void drawConfirmationWindow(const char *message);
+
+void drawSingleLineFromArray(int32_t posX, int32_t posY, 
+	int32_t currentMenuOption, const char **line);
+
+void drawSingleLineFromStringAndValue(int32_t posX, int32_t posY, 
+	const char *line, int32_t value);
+
+void drawSingleLineFromStringAndArray(int32_t posX, int32_t posY, 
+	int32_t currentMenuOption, const char *string, const char **line);
+
+void drawAdjustableValueSpawnItem();
+void drawAdjustableValue(bool changingItem, uint32_t currentMenu);
+void drawAddByIconMain(uint32_t currentMenu);
+void drawAddByIcon(uint32_t currentMenu);
+void drawAddById(uint32_t currentMenu);
+
+void drawPageNumber(int32_t posX, int32_t posY, uint32_t currentPage);
+void drawBoolOnOrOff(bool tempBool, const char *currentLine, int32_t posY);
+void drawCheatsBool(int32_t posY);
+void drawButtonCombo(uint16_t buttonCombo, int32_t posY, const char *description);
+void drawChangeButtonCombo(uint16_t &currentButtonCombo);
+void drawCheatsForcedDropItem();
+void drawCheatsClearArea();
+void drawWarpsOptions();
+void drawOnScreenTimerButtonCombos();
+
+void drawOnScreenTimer();
+void drawSequenceInPauseMenu();
+void drawMarioCoordinates();
+void drawJumpStorageDetails();
+void drawButtonInputs();
+void drawYoshiSkipDetails();
+void drawPalaceSkipDetails();
+
+void drawTitleScreenInfo();
+void drawFileSelectScreenInfo();
+
+}