Decompiling - Revision history

Shibboleet: /* Getting Set Up */

2025-05-20T18:29:17Z

Getting Set Up

← Older revision		Revision as of 18:29, 20 May 2025
Line 12:		Line 12:
	* [https://www.python.org/downloads/release/python-397/ Python 3.9.7]		* [https://www.python.org/downloads/release/python-397/ Python 3.9.7]
	* IDA Pro (recommended) or Ghidra (Not recommended)		* IDA Pro (recommended) or Ghidra (Not recommended)
	* [https://shibbo.net/smg/RMGK01_01.i64 SMG1 Korean IDB (For IDA)]		* [https://shibbo.net/smg/RMGK01_01(1).i64 SMG1 Korean IDB (For IDA)]
	* A ''Super Mario Galaxy'' Korean region DOL.		* A ''Super Mario Galaxy'' Korean region DOL.
	* [https://github.com/ninja-build/ninja/releases Ninja]		* [https://github.com/ninja-build/ninja/releases Ninja]

Shibboleet: /* Getting Set Up */

2025-05-20T18:29:00Z

Getting Set Up

← Older revision		Revision as of 18:29, 20 May 2025
Line 12:		Line 12:
	* [https://www.python.org/downloads/release/python-397/ Python 3.9.7]		* [https://www.python.org/downloads/release/python-397/ Python 3.9.7]
	* IDA Pro (recommended) or Ghidra (Not recommended)		* IDA Pro (recommended) or Ghidra (Not recommended)
	* [https://shibbo.net/smg/RMGK01_01.~~idb~~ SMG1 Korean IDB (For IDA)]		* [https://shibbo.net/smg/RMGK01_01.i64 SMG1 Korean IDB (For IDA)]
	* A ''Super Mario Galaxy'' Korean region DOL.		* A ''Super Mario Galaxy'' Korean region DOL.
	* [https://github.com/ninja-build/ninja/releases Ninja]		* [https://github.com/ninja-build/ninja/releases Ninja]

Shibboleet at 17:56, 20 May 2025

2025-05-20T17:56:44Z

← Older revision		Revision as of 17:56, 20 May 2025
Line 434:		Line 434:
	bdnz+ loop # branch back to the loop if the counter is not 8		bdnz+ loop # branch back to the loop if the counter is not 8
	</pre>		</pre>

			== Actor Decompiling ==
			An ''actor'' is how the game refers to something that is present in a ''scene'' (ie a Goomba or a Coin). The approach to decompiling an actor is rather repetitive, but can change based on the actor itself. However, most of them follow a straightforward structure. They contain a constructor that takes in a '''const char *''' pointer (which is the name of the actor) and passes that to the parent class, which can range from ''LiveActor'' to ''MapObjActor''.



	== Operator Overloads ==		== Operator Overloads ==

Shibboleet: /* Splitting */

2025-05-06T17:19:26Z

Splitting

← Older revision		Revision as of 17:19, 6 May 2025
Line 142:		Line 142:
	</pre>		</pre>

	Each segment needs a '''start''' and an '''end address, and the '''end''' address always needs to be larger than the '''start''' address. You can use IDA (or Ghidra) to see what segment a specific set of code / data belongs to. For this specific split:		Each segment needs a '''start''' and an '''end''' address, and the '''end''' address always needs to be larger than the '''start''' address. You can use IDA (or Ghidra) to see what segment a specific set of code / data belongs to. For this specific split:
	* '''.text''' begins at '''0x802616B4''' and ends at '''0x802618B4'''.		* '''.text''' begins at '''0x802616B4''' and ends at '''0x802618B4'''.
	* '''.data''' begins at '''0x805A7758''' and ends at '''0x805A7780'''.		* '''.data''' begins at '''0x805A7758''' and ends at '''0x805A7780'''.

Shibboleet at 17:19, 6 May 2025

2025-05-06T17:19:01Z

@@ Line 130: / Line 130: @@
 == Basics ==
 To properly decompile, it is vital to know how a lot of the assembly will translate into C / C++ code. Here are a couple of patterns that you will see when decompiling code.
 == Class Mapping ==

Shibboleet: /* Getting Set Up */

2025-05-06T17:10:51Z

Getting Set Up

← Older revision		Revision as of 17:10, 6 May 2025
Line 14:		Line 14:
	* [https://shibbo.net/smg/RMGK01_01.idb SMG1 Korean IDB (For IDA)]		* [https://shibbo.net/smg/RMGK01_01.idb SMG1 Korean IDB (For IDA)]
	* A ''Super Mario Galaxy'' Korean region DOL.		* A ''Super Mario Galaxy'' Korean region DOL.
			* [https://github.com/ninja-build/ninja/releases Ninja]

	After you have acquired all of these, setting up [https://github.com/shibbo/Petari Petari] is very simple.		After you have acquired all of these, setting up [https://github.com/shibbo/Petari Petari] is very simple.

Shibboleet at 17:09, 6 May 2025

2025-05-06T17:09:52Z

← Older revision		Revision as of 17:09, 6 May 2025
Line 9:		Line 9:
	To begin decompiling ''Super Mario Galaxy'', you first need to set up the environment. You will need the following tools:		To begin decompiling ''Super Mario Galaxy'', you first need to set up the environment. You will need the following tools:
	* [https://gitforwindows.org/ Git (Windows)]		* [https://gitforwindows.org/ Git (Windows)]
	* Any IDE ([https://code.visualstudio.com/ Visual Studio Recommended])		* Any IDE ([https://code.visualstudio.com/ Visual Studio Code Recommended])
	* [https://www.python.org/downloads/release/python-397/ Python 3.9.7]		* [https://www.python.org/downloads/release/python-397/ Python 3.9.7]
	* IDA Pro (recommended) or Ghidra (Not recommended)		* IDA Pro (recommended) or Ghidra (Not recommended)
Line 18:		Line 18:

	# With a new command prompt open, type in '''git clone https://github.com/shibbo/Petari'''. This will clone the repository into a directory called "Petari".		# With a new command prompt open, type in '''git clone https://github.com/shibbo/Petari'''. This will clone the repository into a directory called "Petari".
	# In this new "Petari" folder, place the SMG1 Korean '''main.dol''' into ~~this folder, and rename it to~~ '''~~baserom~~.dol'''.		# In this new "Petari" folder, place the SMG1 Korean '''main.dol''' into '''orig/RMGK01/main.dol'''.
	# Open a new command prompt in the "Petari" folder.		# Open a new command prompt in the "Petari" folder.
	# Run the command '''~~python setup.py~~'''. This will ~~verify your DOL~~ and ~~install all of~~ the ~~libraries used~~, ~~and the compilers we use to~~ compile the code.		# Run the command ''''ninja'''. This will download the decompilation toolkit (dtk) and "split" the binary, then compile the code.
	~~# Run the command '''python build.py'''. This will build the entire project. If you see any warnings, do not worry about them~~.

	== Environment ==		== Environment ==
Line 30:		Line 29:
	! Folder Name !! Description		! Folder Name !! Description
	\|-		\|-
	\| ~~archive~~ \|\| ~~The folder that gets created when '''build.py -link''' is ran. Contains an archive of~~ the ~~object files in each library~~.		\| assets \|\| Just assets for the README.
	\|-		\|-
	\| build \|\| The folder that gets created when '''~~build.py~~''' is ran. Contains the compiled object files.		\| build \|\| The folder that gets created when '''ninja''' is ran. Contains the compiled object files and the compilers.
	\|-		\|-
	\| ~~csv~~ \|\| Contains ~~CSV files that store~~ the ~~status of functions being matched~~.		\| config \|\| Contains the configurations for each SMG1 version for decompilation and splitting.
	\|-		\|-
	\| ~~data~~ \|\| ~~Contains map files and the percentage badges for the GitHub repo~~.		\| docs \|\| Documents relating to using '''dtk'''.
	\|-		\|-
	\| ~~docs~~ \|\| ~~The folder that gets created when '''progress.py''' is ran.~~ Contains all of the ~~Markdown documentation~~ for ~~matching status~~.		\| include \|\| Contains all of the header files for ''Super Mario Galaxy'' specific code.
	\|-		\|-
	\| ~~include~~ \|\| ~~Contains all of the header files~~ for ~~''Super Mario Galaxy'' specific code~~.		\| md \|\| Documentation for completed functions.
	\|-		\|-
	\| ~~libs~~ \|\| Contains ~~this folder structure but~~ for ~~different libraries used by the~~ game.		\| orig \|\| Contains the DOLs for each game version for splitting and matching.
	\|-		\|-
	\| ~~scripts~~ \|\| ~~Various scripts used in IDA~~ for ~~generating headers~~.		\| src \|\| Contains all of the source files for '''Super Mario Galaxy''' and its libraries.
	\|-		\|-
	\| ~~source~~ \|\| ~~Contains all of the source files for ''Super Mario Galaxy'' specific code~~.		\| tools \|\| Misc tools that dtk uses.
	\|}		\|}

Super Hackio: Add Overload Symbol suffixes

2024-12-27T14:57:52Z

Add Overload Symbol suffixes

← Older revision		Revision as of 14:57, 27 December 2024
Line 416:		Line 416:
	bdnz+ loop # branch back to the loop if the counter is not 8		bdnz+ loop # branch back to the loop if the counter is not 8
	</pre>		</pre>

			== Operator Overloads ==
			There are specific ways that CodeWarrior mangles symbols when overloading operators for classes.
			{\| class="wikitable"
			! Operator !! Mangled Symbol
			\|-
			\| "+" \|\| "pl"
			\|-
			\| "-" \|\| "mi"
			\|-
			\| "*" \|\| "ml"
			\|-
			\| "/" \|\| "dv"
			\|-
			\| "%" \|\| "md"
			\|-
			\| "^" \|\| "er"
			\|-
			\| "/=" \|\| "adv"
			\|-
			\| "&" \|\| "ad"
			\|-
			\| "\|" \|\| "or"
			\|-
			\| "~" \|\| "co"
			\|-
			\| "!" \|\| "nt"
			\|-
			\| "=" \|\| "as"
			\|-
			\| "<" \|\| "lt"
			\|-
			\| ">" \|\| "gt"
			\|-
			\| "+=" \|\| "apl"
			\|-
			\| "-=" \|\| "ami"
			\|-
			\| "*=" \|\| "amu"
			\|-
			\| "%=" \|\| "amd"
			\|-
			\| "^=" \|\| "aer"
			\|-
			\| "&=" \|\| "aad"
			\|-
			\| "\|=" \|\| "aor"
			\|-
			\| "<<" \|\| "ls"
			\|-
			\| ">>" \|\| "rs"
			\|-
			\| ">>=" \|\| "ars"
			\|-
			\| "<<=" \|\| "als"
			\|-
			\| "==" \|\| "eq"
			\|-
			\| "!=" \|\| "ne"
			\|-
			\| "<=" \|\| "le"
			\|-
			\| ">=" \|\| "ge"
			\|-
			\| "&&" \|\| "aa"
			\|-
			\| "\|\|" \|\| "oo"
			\|-
			\| "++" \|\| "pp"
			\|-
			\| "--" \|\| "mm"
			\|-
			\| "()" \|\| "cl"
			\|-
			\| "[]" \|\| "vc"
			\|-
			\| "->" \|\| "rf"
			\|-
			\| "," \|\| "cm"
			\|-
			\| "->*" \|\| "rm"
			\|}

Shibboleet: Class Mapping -- inheriting

2024-04-06T12:45:01Z

Class Mapping -- inheriting

@@ Line 210: / Line 210: @@
 };
 </pre>
 === Loops ===

Shibboleet: /* Base Class */

2024-04-06T12:21:02Z

Base Class

← Older revision		Revision as of 12:21, 6 April 2024
Line 143:		Line 143:
	* (r3 + 0xA) is also stored with a '''sth''', but with a '''-1''' value, so we know for sure that this type is ''signed''.		* (r3 + 0xA) is also stored with a '''sth''', but with a '''-1''' value, so we know for sure that this type is ''signed''.

	Keep in mind that a constructor does not have to initialize every single member variable in the class! So there could be other members in a class that aren't mentioned in the constructor at all. After you look at the constructor, look around at the ''member functions'' to see if they use any members that are not initialized in the constructor. You can always verify if your class setup is correct when you can find where this class is created using the '''new''' operator. Check if the size passed to the '''new''' call matches the size of the class that you have mapped. If it is smaller, you are missing ~~arguments~~. If it is bigger, you have too many! Remember that the vtable is implicitly stored at '''(this + 0x0)''', so you do not have to explicitly define it. With all of these members documented, our class setup looks a little like this so far:		Keep in mind that a constructor does not have to initialize every single member variable in the class! So there could be other members in a class that aren't mentioned in the constructor at all. After you look at the constructor, look around at the ''member functions'' to see if they use any members that are not initialized in the constructor. You can always verify if your class setup is correct when you can find where this class is created using the '''new''' operator. Check if the size passed to the '''new''' call matches the size of the class that you have mapped. If it is smaller, you are missing members. If it is bigger, you have too many! Remember that the vtable is implicitly stored at '''(this + 0x0)''', so you do not have to explicitly define it. With all of these members documented, our class setup looks a little like this so far:

	<pre>		<pre>