Mod Loaders - Revision history

ItsEasyActually at 17:59, 8 October 2025

2025-10-08T17:59:10Z

← Older revision		Revision as of 17:59, 8 October 2025
Line 14:		Line 14:
	=== ModInfo ===		=== ModInfo ===
	ModInfo is a required export from any code based mod. Without it, the mod loader will not load the mod and will throw an error alerting the user that a mod is not a valid mod.		ModInfo is a required export from any code based mod. Without it, the mod loader will not load the mod and will throw an error alerting the user that a mod is not a valid mod.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	// Example of exporting the ModInfo for SADX.		// Example of exporting the ModInfo for SADX.
Line 33:		Line 33:

	This is fired for all enabled mods first. It's fired in the order in which mods are loaded (top to bottom).		This is fired for all enabled mods first. It's fired in the order in which mods are loaded (top to bottom).
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void Init(const char* path, HelperFunctions& helperFunctions, const unsigned int index)		__declspec(dllexport) void Init(const char* path, HelperFunctions& helperFunctions, const unsigned int index)
Line 45:		Line 45:
	This is run after all mods have finished running their Init, but before the game has completely loaded. This is useful for any mods making APIs for other mods to utilize.		This is run after all mods have finished running their Init, but before the game has completely loaded. This is useful for any mods making APIs for other mods to utilize.
	{{Note\|text=This is only available in the SADX Mod Loader at this time.\|type=info}}		{{Note\|text=This is only available in the SADX Mod Loader at this time.\|type=info}}
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void OnInitEnd()		__declspec(dllexport) void OnInitEnd()
Line 56:		Line 56:
	=== OnFrame ===		=== OnFrame ===
	This export will run every frame. This can be useful if you need to check something within the game constantly. Users who utilize this should consider cautionary measures to prevent running large amounts of logic every frame if it can be avoided for performance reasons.		This export will run every frame. This can be useful if you need to check something within the game constantly. Users who utilize this should consider cautionary measures to prevent running large amounts of logic every frame if it can be avoided for performance reasons.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void OnFrame()		__declspec(dllexport) void OnFrame()
Line 67:		Line 67:
	=== OnInput ===		=== OnInput ===
	This export will run when the game processes input. More specifically, it will run just prior to the game actually processing that input.		This export will run when the game processes input. More specifically, it will run just prior to the game actually processing that input.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void OnInput()		__declspec(dllexport) void OnInput()
Line 78:		Line 78:
	=== OnControl ===		=== OnControl ===
	This export will run while the game is actively processing input.		This export will run while the game is actively processing input.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void OnControl()		__declspec(dllexport) void OnControl()
Line 89:		Line 89:
	=== OnRenderSceneStart ===		=== OnRenderSceneStart ===
	This export will run just before a game scene is rendered.		This export will run just before a game scene is rendered.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void OnRenderSceneStart()		__declspec(dllexport) void OnRenderSceneStart()
Line 100:		Line 100:
	=== OnRenderSceneEnd ===		=== OnRenderSceneEnd ===
	This export will run just after a game scene has finished rendering.		This export will run just after a game scene has finished rendering.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void OnRenderSceneEnd()		__declspec(dllexport) void OnRenderSceneEnd()
Line 111:		Line 111:
	=== OnRenderDeviceReset ===		=== OnRenderDeviceReset ===
	This export will run whenever the render device for the game is reset. For example, resizing the game window will cause the render device to be reset.		This export will run whenever the render device for the game is reset. For example, resizing the game window will cause the render device to be reset.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void OnRenderDeviceReset()		__declspec(dllexport) void OnRenderDeviceReset()
Line 122:		Line 122:
	=== OnRenderDeviceLost ===		=== OnRenderDeviceLost ===
	This export will run whenever a game scene fails to render.		This export will run whenever a game scene fails to render.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void OnRenderDeviceLost()		__declspec(dllexport) void OnRenderDeviceLost()
Line 133:		Line 133:
	=== OnExit ===		=== OnExit ===
	This export runs just prior to the game completely closing.		This export runs just prior to the game completely closing.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	__declspec(dllexport) void OnExit()		__declspec(dllexport) void OnExit()
Line 152:		Line 152:
	* Write <code>0xC3</code> to kill a function by writing a <code>ret</code> instruction.		* Write <code>0xC3</code> to kill a function by writing a <code>ret</code> instruction.
	* Write <code>0x90</code> five times to kill a function call by writing five <code>nop</code> instructions.		* Write <code>0x90</code> five times to kill a function call by writing five <code>nop</code> instructions.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy="">		<syntaxhighlight lang="cpp" copy="">
	WriteData<1>((Uint8*)0x005ADC40, 0xC3); // Writes 0xC3 (one byte) to the address 0x005ADC40, effectively disabling the function located at that address.		WriteData<1>((Uint8*)0x005ADC40, 0xC3); // Writes 0xC3 (one byte) to the address 0x005ADC40, effectively disabling the function located at that address.
Line 163:		Line 163:
	=== WriteJump ===		=== WriteJump ===
	WriteJump writes a <code>jmp</code> instruction at the specified memory address. You can use this to replace entire functions in the game with your own code.		WriteJump writes a <code>jmp</code> instruction at the specified memory address. You can use this to replace entire functions in the game with your own code.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp" copy>		<syntaxhighlight lang="cpp" copy>
	WriteJump((void*)0x005BBFE0, MyFunction); // Replaces the function at 0x005BBFE0 with a jump to MyFunction.		WriteJump((void*)0x005BBFE0, MyFunction); // Replaces the function at 0x005BBFE0 with a jump to MyFunction.
Line 173:		Line 173:
	=== WriteCall ===		=== WriteCall ===
	WriteCall writes a <code>call</code> instruction at the specified memory address. You can use this to call your own code from the game's functions without replacing them entirely.		WriteCall writes a <code>call</code> instruction at the specified memory address. You can use this to call your own code from the game's functions without replacing them entirely.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	WriteCall((void*)0x005AEF29, MyFunction); // Replaces the function call at 0x005AEF29 with a call to MyFunction.		WriteCall((void*)0x005AEF29, MyFunction); // Replaces the function call at 0x005AEF29 with a call to MyFunction.
Line 184:		Line 184:
	=== Patch List ===		=== Patch List ===
	A PatchList is comprised of an array of PatchInfo entries. The mod loader will generate these using WriteData.		A PatchList is comprised of an array of PatchInfo entries. The mod loader will generate these using WriteData.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	// TODO: Insert example.		// TODO: Insert example.
Line 195:		Line 195:
	* Calls are generated using WriteCall.		* Calls are generated using WriteCall.
	* Pointers are generated using WriteData.		* Pointers are generated using WriteData.
	{{~~Documentation~~\|header=Example\|content=		{{DocHeader\|header=Example\|content=
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	// TODO: Insert examples.		// TODO: Insert examples.
Line 202:		Line 202:

	= Example =		= Example =
	{{~~Documentation~~\|header=Example Export Table\|content=		{{DocHeader\|header=Example Export Table\|content=
	<syntaxhighlight lang="cpp" line copy>		<syntaxhighlight lang="cpp" line copy>
	// Inside of your mod's "main" cpp file (or whichever one houses your exports).		// Inside of your mod's "main" cpp file (or whichever one houses your exports).

ItsEasyActually at 13:37, 8 October 2025

2025-10-08T13:37:44Z

Show changes

PkR at 14:51, 3 October 2025

2025-10-03T14:51:32Z

@@ Line 10: / Line 10: @@
 Below is an overview of the general exports that are available in the mod loaders. An [[Mod_Loaders#Example|example]] of a complete export can be seen below.
 == Variable Exports ==
@@ Line 24: / Line 22: @@
 __declspec(dllexport) ModInfo SA2ModInfo = { ModLoaderVer };
 </syntaxhighlight>
 == Function Exports ==
 The mod loaders support loading various function exports from a mod. While these are all optional, many mods make use of at least one of these exports as their entry point. This is most commonly the [[Mod_Loaders#Init|Init]] export.
+Inside these exported functions you can put your own C++ code to manipulate data, replace assets or interface with the game.
 === Init ===
 The Init (short for Initialize) export is used for initializing information within your mod and passing some variables from the mod loader into the mod itself. The include the mod's path (local path to the mod folder from the game's root), HelperFunctions (see each respective page for each mod loader for more information on this struct), and the mod's index in the list.
@@ Line 143: / Line 139: @@
 </syntaxhighlight>
 == Exportable Lists ==
 The mod loaders also have support for exporting different types of lists. These are all optional exports.

ItsEasyActually: Formatting adjustments on spacing and adding separator lines between sub heading groups.

2025-10-03T14:27:57Z

Formatting adjustments on spacing and adding separator lines between sub heading groups.

← Older revision		Revision as of 14:27, 3 October 2025
Line 10:		Line 10:

	Below is an overview of the general exports that are available in the mod loaders. An [[Mod_Loaders#Example\|example]] of a complete export can be seen below.		Below is an overview of the general exports that are available in the mod loaders. An [[Mod_Loaders#Example\|example]] of a complete export can be seen below.


	== Variable Exports ==		== Variable Exports ==
Line 23:		Line 24:
	__declspec(dllexport) ModInfo SA2ModInfo = { ModLoaderVer };		__declspec(dllexport) ModInfo SA2ModInfo = { ModLoaderVer };
	</syntaxhighlight>		</syntaxhighlight>


	== Function Exports ==		== Function Exports ==
	The mod loaders support loading various function exports from a mod. While these are all optional, many mods make use of at least one of these exports as their entry point. This is most commonly the [[Mod_Loaders#Init\|Init]] export.		The mod loaders support loading various function exports from a mod. While these are all optional, many mods make use of at least one of these exports as their entry point. This is most commonly the [[Mod_Loaders#Init\|Init]] export.


	=== Init ===		=== Init ===
Line 38:		Line 41:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== OnInitEnd ===		=== OnInitEnd ===
Line 50:		Line 54:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== OnFrame ===		=== OnFrame ===
Line 60:		Line 65:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== OnInput ===		=== OnInput ===
Line 70:		Line 76:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== OnControl ===		=== OnControl ===
Line 80:		Line 87:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== OnRenderSceneStart ===		=== OnRenderSceneStart ===
Line 90:		Line 98:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== OnRenderSceneEnd ===		=== OnRenderSceneEnd ===
Line 100:		Line 109:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== OnRenderDeviceReset ===		=== OnRenderDeviceReset ===
Line 110:		Line 120:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== OnRenderDeviceLost ===		=== OnRenderDeviceLost ===
Line 120:		Line 131:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== OnExit ===		=== OnExit ===
Line 130:		Line 142:
	}		}
	</syntaxhighlight>		</syntaxhighlight>


	== Exportable Lists ==		== Exportable Lists ==
Line 140:		Line 153:
	// TODO: Insert example.		// TODO: Insert example.
	</syntaxhighlight>		</syntaxhighlight>
			<hr>

	=== Jumps, Calls, and Pointer Lists ===		=== Jumps, Calls, and Pointer Lists ===
Line 150:		Line 164:
	// TODO: Insert examples.		// TODO: Insert examples.
	</syntaxhighlight>		</syntaxhighlight>


	= Example =		= Example =

ItsEasyActually at 14:08, 3 October 2025

2025-10-03T14:08:48Z

Show changes

ItsEasyActually: Created page with "The Mod Loaders are Dynamic Link Libraries (DLL) files that inject themselves into the Sonic Adventure titles by replacing existing DLL files from the game. This is what allows mods to exist external to editing the existing files within the game as well as inject their own code into the game. Below you'll find links to documentation pertaining to each mod loader respectively. * SADX Mod Loader * SA2B Mod Loader"

2025-10-03T11:36:50Z

Created page with "The Mod Loaders are Dynamic Link Libraries (DLL) files that inject themselves into the Sonic Adventure titles by replacing existing DLL files from the game. This is what allows mods to exist external to editing the existing files within the game as well as inject their own code into the game. Below you'll find links to documentation pertaining to each mod loader respectively. * SADX Mod Loader * SA2B Mod Loader"

New page

The Mod Loaders are Dynamic Link Libraries (DLL) files that inject themselves into the Sonic Adventure titles by replacing existing DLL files from the game. This is what allows mods to exist external to editing the existing files within the game as well as inject their own code into the game.

Below you'll find links to documentation pertaining to each mod loader respectively.

* [[SADX Mod Loader]]

* [[SA2B Mod Loader]]