<div style="margin: 15px; background-color: #202122; border: 1px solid #404244; padding: 10px; vertical-align:middle">
{{#switch: {{{type|}}}
|info=[[File:OOjs_UI_icon_info-progressive.svg|18px]]
|=[[File:OOjs_UI_icon_info-progressive.svg|18px]]
}}|{{{text}}}
</div>

Template:Note

2025-10-05T20:17:43Z

ItsEasyActually:

Template:Note

2025-10-05T20:07:33Z

ItsEasyActually:

{{{text}}}

Template:Note

2025-10-05T20:05:35Z

ItsEasyActually: Attempting a Template for Notes.

SA2B Mod Loader

2025-10-04T14:51:21Z

ItsEasyActually: Writing SA2B Mod Loader page and documentation.

[https://github.com/X-Hax/sa2-mod-loader/ Source Code]

= HelperFunctions API =

== Struct ==
Below is the initialized version of the HelperFunctions struct. For the definition of the struct, you can find that in [https://github.com/X-Hax/sa2-mod-loader/blob/master/SA2ModLoader/include/SA2ModInfo.h SA2ModInfo.h]
<syntaxhighlight lang="cpp">
HelperFunctions helperFunctions =
{
ModLoaderVer,
RegisterStartPosition,
ClearStartPositionList,
Register2PIntroPosition,
Clear2PIntroPositionList,
GetMainSavePath,
GetChaoSavePath,
RegisterEndPosition,
ClearEndPositionList,
RegisterMission23EndPosition,
ClearMission23EndPositionList,
HookExport,
GetReplaceablePath,
_ReplaceFile,
SetWindowTitle,
debug_text::SetFontSize,
debug_text::SetFontColor,
debug_text::DisplayString,
debug_text::DisplayStringFormatted,
debug_text::DisplayNumber,
&loaderSettings,
&modList,
&RegisterVoice,
&ReplaceTexture,
&UnreplaceFile,
&PushInterpolationFix,
&PopInterpolationFix,
};
</syntaxhighlight>

== Properties ==

=== Mod Loader Version ===
<syntaxhighlight lang="cpp">
int ModLoaderVer;
</syntaxhighlight>

This returns the version of the mod loader. This can be used to check if the user has an old version of the mod loader that may not have functionality your mod requires.

==== Example ====
<syntaxhighlight lang="cpp">
if (globalHelperFunctions.ModLoaderVer <= 10)
PrintDebug("This Mod Loader is way out of date.\n");
</syntaxhighlight>
<hr>

=== Mod Loader Settings ===
<syntaxhighlight lang="cpp">
LoaderSettings loaderSettings;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Mod List ===
<syntaxhighlight lang="cpp">
std::vector<Mod> modlist;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>

== Functions ==

=== Register Start Position ===
<syntaxhighlight lang="cpp">
void RegisterStartPosition(unsigned char character, const StartPosition& position)
</syntaxhighlight>

Registers a Start Position for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">
// This is a declaration of an SA2 StartPosition struct.
StartPosition myStageStartPos = {
1, // Level ID
0x4000, // Single Player Y Rotation
0x4000, // Multiplayer, Player 1 Y Rotation
0x4000, // Multiplayer, Player 2 Y Rotation
{ 100.0f, 200.0f, 100.0f }, // Single Player Start Position
{ 90.0f, 200.0f, 100.0f }, // Multiplayer, Player 1 Start Position
{ 110.0f, 200.0f, 100.0f } // Multiplayer, Player 2 Start Position
};

// We pass our StagePosition variable as a pointer to this function
// and we have specified Sonic, so the level for this ID would now use
// our StartPosition instead of the original.
globalHelperFunctions.RegisterStartPosition(Characters_Sonic, &myStageStartPos);
</syntaxhighlight>
<hr>

=== Clear Start Position List ===
<syntaxhighlight lang="cpp">
void ClearStartPositionList(unsigned char character)
</syntaxhighlight>

Clears the Start Positions for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register 2P Intro Position ===
<syntaxhighlight lang="cpp">
void Register2PIntroPosition(unsigned char character, const LevelEndPosition& position)
</syntaxhighlight>

Registers a Multiplayer Intro Position for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear 2P Intro Position List ===
<syntaxhighlight lang="cpp">
void Clear2PIntroPositionList(unsigned char character)
</syntaxhighlight>

Clears all Multiplayer Intro Positions for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Main Save Path ===
<syntaxhighlight lang="cpp">
const char* GetMainSavePath()
</syntaxhighlight>

Returns the game's Main Save File's path.

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Chao Save Path ===
<syntaxhighlight lang="cpp">
const char* GetChaoSavePath()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register End Position ===
<syntaxhighlight lang="cpp">
void RegisterEndPosition(unsigned char character, const StartPosition& position)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear End Position List ===
<syntaxhighlight lang="cpp">
void ClearEndPositionList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Mission 2/3 End Position ===
<syntaxhighlight lang="cpp">
void RegisterMission23EndPosition(unsigned char character, const LevelEndPosition& position)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Mission 2/3 End Position List ===
<syntaxhighlight lang="cpp">
void ClearMission23EndPositionList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Hook Export ===
<syntaxhighlight lang="cpp">
void HookExport(LPCSTR exportName, const void* newdata)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Replaceable Path ===
<syntaxhighlight lang="cpp">
const char* __cdecl GetReplaceablePath(const char* path)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace File ===
<syntaxhighlight lang="cpp">
void _ReplaceFile(const char* src, const char* dst)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Set Window Title ===
<syntaxhighlight lang="cpp">
void SetWindowTitle(const wchar_t* title)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Debug Text : Set Font Size ===
<syntaxhighlight lang="cpp">
void SetFontSize(float size)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Debug Text : Set Font Color ===
<syntaxhighlight lang="cpp">
void SetFontColor(int color)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Debug Text : Display String ===
<syntaxhighlight lang="cpp">
void DisplayString(int loc, const char* str)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Debug Text : Display String Formatted ===
<syntaxhighlight lang="cpp">
void DisplayStringFormatted(int loc, const char* Format, ...)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Debug Text : Display Number ===
<syntaxhighlight lang="cpp">
void DisplayNumber(int loc, int value, int numdigits)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Voice ===
<syntaxhighlight lang="cpp">
uint16_t RegisterVoice(const char* fileJP, const char* fileEN)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace Texture ===
<syntaxhighlight lang="cpp">
void ReplaceTexture(const char* pvm_name, const char* tex_name, const char* file_path, uint32_t gbix, uint32_t width, uint32_t height)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Unreplace File ===
<syntaxhighlight lang="cpp">
void UnreplaceFile(const char* file)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Push Interpolation Fix ===
<syntaxhighlight lang="cpp">
void PushInterpolationFix()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Pop Interpolation Fix ===
<syntaxhighlight lang="cpp">
void PopInterpolationFix()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get File Mod Index ===
<syntaxhighlight lang="cpp">
int GetFileModIndex(const char* path)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace File At Index ===
<syntaxhighlight lang="cpp">
void ReplaceFileAtIndex(const char* src, const char* dst, int modIndex)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

SADX Mod Loader

2025-10-04T14:41:23Z

ItsEasyActually: Added missing methods.

[https://github.com/X-Hax/sadx-mod-loader/ Source Code]

= HelperFunctions API =

== Struct ==
Below is the initialized version of the HelperFunctions struct. For the definition of the struct, you can find that in [https://github.com/X-Hax/sadx-mod-loader/blob/master/SADXModLoader/include/SADXModInfo.h SADXModInfo.h]
<syntaxhighlight lang="cpp">
HelperFunctions helperFunctions =
{
ModLoaderVer,
&RegisterStartPosition,
&ClearStartPositionList,
&RegisterFieldStartPosition,
&ClearFieldStartPositionList,
&RegisterPathList,
&ClearPathListList,
&RegisterCharacterPVM,
&ClearCharacterPVMList,
&RegisterCommonObjectPVM,
&ClearCommonObjectPVMList,
&RegisterTrialLevel,
&ClearTrialLevelList,
&RegisterTrialSubgame,
&ClearTrialSubgameList,
&GetMainSavePath,
&GetChaoSavePath,
&GetReplaceablePath,
&_ReplaceFile,
&SetWindowTitle,
&RegisterSoundList,
&RegisterMusicFile,
&LoadEXEData,
&LoadDLLData,
&_ReplaceFileForce,
&PushScaleUI,
&PopScaleUI,
&SetScaleFillMode,
&GetScaleFillMode,
&ReplaceTexture,
&MipmapBlacklistGBIX,
&RegisterEnglishVoiceDuration,
&RegisterJapaneseVoiceDuration,
&RegisterCharacterWelds,
&loaderSettings,
&modList,
&weightFuncs,
&RegisterVoice,
&PushInterpolationFix,
&PopInterpolationFix,
&RegisterPermanentTexlist,
&ExpandPVMList,
&UnreplaceFile,
&PrintDebugUnicode,
&PrintDebugLocal,
&PrintDebugCodepage,
&GetFileModIndex,
&ReplaceFileAtIndex
};
</syntaxhighlight>

== Properties ==

=== Mod Loader Version ===
<syntaxhighlight lang="cpp">
int ModLoaderVer;
</syntaxhighlight>

This returns the version of the mod loader. This can be used to check if the user has an old version of the mod loader that may not have functionality your mod requires.

==== Example ====
<syntaxhighlight lang="cpp">
if (globalHelperFunctions.ModLoaderVer <= 10)
PrintDebug("This Mod Loader is way out of date.\n");
</syntaxhighlight>
<hr>

=== Mod Loader Settings ===
<syntaxhighlight lang="cpp">
LoaderSettings loaderSettings;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Mod List ===
<syntaxhighlight lang="cpp">
std::vector<Mod> modlist;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Weight Functions ===
<syntaxhighlight lang="cpp">
BasicWeightFuncs weightFuncs;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>

== Functions ==

=== Register Start Position ===
<syntaxhighlight lang="cpp">
static void RegisterStartPosition(unsigned char character, const StartPosition& position)
</syntaxhighlight>

Registers a new Start Position for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">
StartPosition myStageStartPos = {
1, // Level ID
0, // Act ID
{ 100.0f, 200.0f, 100.0f }, // Position
0 // Y Rotation
};

// We pass our StagePosition variable as a pointer to this function
// and we have specified Sonic, so the level for this ID would now use
// our StartPosition instead of the original.
globalHelperFunctions.RegisterStartPosition(Characters_Sonic, &myStageStartPos);
</syntaxhighlight>
<hr>

=== Clear Start Position List ===
<syntaxhighlight lang="cpp">
static void ClearStartPositionList(unsigned char character)
</syntaxhighlight>

Clears the Start Positions for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">
// Running this inside of your mod's Init export would
// clear all of Sonic's Start Positions for his stages.
globalHelperFunctions.ClearStartPositionList(Characters_Sonic);
</syntaxhighlight>
<hr>

=== Register Field Position ===
<syntaxhighlight lang="cpp">
static void RegisterFieldStartPosition(unsigned char character, const FieldStartPosition& position)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Field Start Position List ===
<syntaxhighlight lang="cpp">
static void ClearFieldStartPositionList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Path List ===
<syntaxhighlight lang="cpp">
static void RegisterPathList(const PathDataPtr& paths)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Path List List ===
<syntaxhighlight lang="cpp">
static void ClearPathListList()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Character PVM ===
<syntaxhighlight lang="cpp">
static void RegisterCharacterPVM(unsigned char character, const PVMEntry& pvm)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Character PVM List ===
<syntaxhighlight lang="cpp">
static void ClearCharacterPVMList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Common Object PVM ===
<syntaxhighlight lang="cpp">
static void RegisterCommonObjectPVM(const PVMEntry& pvm)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Common Object PVM List ===
<syntaxhighlight lang="cpp">
static void ClearCommonObjectPVMList()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Trial Level ===
<syntaxhighlight lang="cpp">
static void RegisterTrialLevel(unsigned char character, const TrialLevelListEntry& level)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Trial Level List ===
<syntaxhighlight lang="cpp">
static void ClearTrialLevelList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Trial Subgame ===
<syntaxhighlight lang="cpp">
static void RegisterTrialSubgame(unsigned char character, const TrialLevelListEntry& level)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Trial Subgame List ===
<syntaxhighlight lang="cpp">
static void ClearTrialSubgameList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Main Save Path ===
<syntaxhighlight lang="cpp">
static const char* GetMainSavePath()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Chao Save Path ===
<syntaxhighlight lang="cpp">
static const char* GetChaoSavePath()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Replaceable Path ===
<syntaxhighlight lang="cpp">
const char* __cdecl GetReplaceablePath(const char* path)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace File ===
<syntaxhighlight lang="cpp">
void _ReplaceFile(const char* src, const char* dst)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Set Window Title ===
<syntaxhighlight lang="cpp">
void SetWindowTitle(const char* title)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Sound List ===
<syntaxhighlight lang="cpp">
int RegisterSoundList(const SoundList& list)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Music File ===
<syntaxhighlight lang="cpp">
int RegisterMusicFile(const MusicInfo& track)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Load EXE Data ===
<syntaxhighlight lang="cpp">
void LoadEXEData(const wchar_t* filename, const wchar_t* mod_dir)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Load DLL Data ===
<syntaxhighlight lang="cpp">
void LoadDLLData(const wchar_t* filename, const wchar_t* mod_dir)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace File Force ===
<syntaxhighlight lang="cpp">
void _ReplaceFileForce(const char* src, const char* dst)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Push Scale UI ===
<syntaxhighlight lang="cpp">
void PushScaleUI(uiscale::Align align, bool is_background, float ratio_h, float ratio_v)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Pop Scale UI ===
<syntaxhighlight lang="cpp">
void PopScaleUI()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Set Scale Fill Mode ===
<syntaxhighlight lang="cpp">
void SetScaleFillMode(uiscale::FillMode mode)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Scale Fill Mode ===
<syntaxhighlight lang="cpp">
uiscale::FillMode GetScaleFillMode()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace Texture ===
<syntaxhighlight lang="cpp">
void ReplaceTexture(const char* pvm_name, const char* tex_name, const char* file_path, uint32_t gbix, uint32_t width, uint32_t height)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Mipmap Blacklist GBIX ===
<syntaxhighlight lang="cpp">
void MipmapBlacklistGBIX(Uint32 index)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register English Voice Duration ===
<syntaxhighlight lang="cpp">
void RegisterEnglishVoiceDuration(const uint16_t voiceID, const uint16_t duration)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Japanese Voice Duration ===
<syntaxhighlight lang="cpp">
void RegisterJapaneseVoiceDuration(const uint16_t voiceID, const uint16_t duration)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Character Welds ===
<syntaxhighlight lang="cpp">
void RegisterCharacterWelds(const uint8_t character, const char* iniPath)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Voice ===
<syntaxhighlight lang="cpp">
uint16_t RegisterVoice(const char* fileJP, const char* fileEN, uint16_t durationJP, uint16_t durationEN)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Push Interpolation Fix ===
<syntaxhighlight lang="cpp">
void PushInterpolationFix()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Pop Interpolation Fix ===
<syntaxhighlight lang="cpp">
void PopInterpolationFix()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Permanent Texlist ===
<syntaxhighlight lang="cpp">
void RegisterPermanentTexlist(NJS_TEXLIST* texlist)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Unreplace File ===
<syntaxhighlight lang="cpp">
void UnreplaceFile(const char* file)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Expand PVM List ===
<syntaxhighlight lang="cpp">
TEX_PVMTABLE* ExpandPVMList(TEX_PVMTABLE* sourcepvmlist, const TEX_PVMTABLE &newpvmentry)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Unreplace File ===
<syntaxhighlight lang="cpp">
void UnreplaceFile(const char* file)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Print Debug Unicode ===
<syntaxhighlight lang="cpp">
void PrintDebugUnicode(char* utf8)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Print Debug Local ===
<syntaxhighlight lang="cpp">
void PrintDebugLocal(char* buf)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Print Debug Codepage ===
<syntaxhighlight lang="cpp">
void PrintDebugCodepage(char* buf, unsigned int source_cp)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get File Mod Index ===
<syntaxhighlight lang="cpp">
int GetFileModIndex(const char* path)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace File At Index ===
<syntaxhighlight lang="cpp">
void ReplaceFileAtIndex(const char* src, const char* dst, int modIndex)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

SADX Mod Loader

2025-10-04T14:29:58Z

ItsEasyActually: Adding initial SADX Mod Loader page + documentation.

[https://github.com/X-Hax/sadx-mod-loader/ Source Code]

= HelperFunctions API =

== Struct ==
Below is the initialized version of the HelperFunctions struct. For the definition of the struct, you can find that in [https://github.com/X-Hax/sadx-mod-loader/blob/master/SADXModLoader/include/SADXModInfo.h SADXModInfo.h]
<syntaxhighlight lang="cpp">
HelperFunctions helperFunctions =
{
ModLoaderVer,
&RegisterStartPosition,
&ClearStartPositionList,
&RegisterFieldStartPosition,
&ClearFieldStartPositionList,
&RegisterPathList,
&ClearPathListList,
&RegisterCharacterPVM,
&ClearCharacterPVMList,
&RegisterCommonObjectPVM,
&ClearCommonObjectPVMList,
&RegisterTrialLevel,
&ClearTrialLevelList,
&RegisterTrialSubgame,
&ClearTrialSubgameList,
&GetMainSavePath,
&GetChaoSavePath,
&GetReplaceablePath,
&_ReplaceFile,
&SetWindowTitle,
&RegisterSoundList,
&RegisterMusicFile,
&LoadEXEData,
&LoadDLLData,
&_ReplaceFileForce,
&PushScaleUI,
&PopScaleUI,
&SetScaleFillMode,
&GetScaleFillMode,
&ReplaceTexture,
&MipmapBlacklistGBIX,
&RegisterEnglishVoiceDuration,
&RegisterJapaneseVoiceDuration,
&RegisterCharacterWelds,
&loaderSettings,
&modList,
&weightFuncs,
&RegisterVoice,
&PushInterpolationFix,
&PopInterpolationFix,
&RegisterPermanentTexlist,
&ExpandPVMList,
&UnreplaceFile,
};
</syntaxhighlight>

== Properties ==

=== Mod Loader Version ===
<syntaxhighlight lang="cpp">
int ModLoaderVer;
</syntaxhighlight>

This returns the version of the mod loader. This can be used to check if the user has an old version of the mod loader that may not have functionality your mod requires.

==== Example ====
<syntaxhighlight lang="cpp">
if (globalHelperFunctions.ModLoaderVer <= 10)
PrintDebug("This Mod Loader is way out of date.\n");
</syntaxhighlight>
<hr>

=== Mod Loader Settings ===
<syntaxhighlight lang="cpp">
LoaderSettings loaderSettings;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Mod List ===
<syntaxhighlight lang="cpp">
std::vector<Mod> modlist;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Weight Functions ===
<syntaxhighlight lang="cpp">
BasicWeightFuncs weightFuncs;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>

== Functions ==

=== Register Start Position ===
<syntaxhighlight lang="cpp">
static void RegisterStartPosition(unsigned char character, const StartPosition& position)
</syntaxhighlight>

Registers a new Start Position for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">
StartPosition myStageStartPos = {
1, // Level ID
0, // Act ID
{ 100.0f, 200.0f, 100.0f }, // Position
0 // Y Rotation
};

// We pass our StagePosition variable as a pointer to this function
// and we have specified Sonic, so the level for this ID would now use
// our StartPosition instead of the original.
globalHelperFunctions.RegisterStartPosition(Characters_Sonic, &myStageStartPos);
</syntaxhighlight>
<hr>

=== Clear Start Position List ===
<syntaxhighlight lang="cpp">
static void ClearStartPositionList(unsigned char character)
</syntaxhighlight>

Clears the Start Positions for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">
// Running this inside of your mod's Init export would
// clear all of Sonic's Start Positions for his stages.
globalHelperFunctions.ClearStartPositionList(Characters_Sonic);
</syntaxhighlight>
<hr>

=== Register Field Position ===
<syntaxhighlight lang="cpp">
static void RegisterFieldStartPosition(unsigned char character, const FieldStartPosition& position)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Field Start Position List ===
<syntaxhighlight lang="cpp">
static void ClearFieldStartPositionList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Path List ===
<syntaxhighlight lang="cpp">
static void RegisterPathList(const PathDataPtr& paths)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Path List List ===
<syntaxhighlight lang="cpp">
static void ClearPathListList()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Character PVM ===
<syntaxhighlight lang="cpp">
static void RegisterCharacterPVM(unsigned char character, const PVMEntry& pvm)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Character PVM List ===
<syntaxhighlight lang="cpp">
static void ClearCharacterPVMList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Common Object PVM ===
<syntaxhighlight lang="cpp">
static void RegisterCommonObjectPVM(const PVMEntry& pvm)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Common Object PVM List ===
<syntaxhighlight lang="cpp">
static void ClearCommonObjectPVMList()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Trial Level ===
<syntaxhighlight lang="cpp">
static void RegisterTrialLevel(unsigned char character, const TrialLevelListEntry& level)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Trial Level List ===
<syntaxhighlight lang="cpp">
static void ClearTrialLevelList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Trial Subgame ===
<syntaxhighlight lang="cpp">
static void RegisterTrialSubgame(unsigned char character, const TrialLevelListEntry& level)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Trial Subgame List ===
<syntaxhighlight lang="cpp">
static void ClearTrialSubgameList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Main Save Path ===
<syntaxhighlight lang="cpp">
static const char* GetMainSavePath()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Chao Save Path ===
<syntaxhighlight lang="cpp">
static const char* GetChaoSavePath()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Replaceable Path ===
<syntaxhighlight lang="cpp">
const char* __cdecl GetReplaceablePath(const char* path)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace File ===
<syntaxhighlight lang="cpp">
void _ReplaceFile(const char* src, const char* dst)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Set Window Title ===
<syntaxhighlight lang="cpp">
void SetWindowTitle(const char* title)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Sound List ===
<syntaxhighlight lang="cpp">
int RegisterSoundList(const SoundList& list)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Music File ===
<syntaxhighlight lang="cpp">
int RegisterMusicFile(const MusicInfo& track)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Load EXE Data ===
<syntaxhighlight lang="cpp">
void LoadEXEData(const wchar_t* filename, const wchar_t* mod_dir)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Load DLL Data ===
<syntaxhighlight lang="cpp">
void LoadDLLData(const wchar_t* filename, const wchar_t* mod_dir)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace File Force ===
<syntaxhighlight lang="cpp">
void _ReplaceFileForce(const char* src, const char* dst)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Push Scale UI ===
<syntaxhighlight lang="cpp">
void PushScaleUI(uiscale::Align align, bool is_background, float ratio_h, float ratio_v)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Pop Scale UI ===
<syntaxhighlight lang="cpp">
void PopScaleUI()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Set Scale Fill Mode ===
<syntaxhighlight lang="cpp">
void SetScaleFillMode(uiscale::FillMode mode)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Scale Fill Mode ===
<syntaxhighlight lang="cpp">
uiscale::FillMode GetScaleFillMode()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace Texture ===
<syntaxhighlight lang="cpp">
void ReplaceTexture(const char* pvm_name, const char* tex_name, const char* file_path, uint32_t gbix, uint32_t width, uint32_t height)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Mipmap Blacklist GBIX ===
<syntaxhighlight lang="cpp">
void MipmapBlacklistGBIX(Uint32 index)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register English Voice Duration ===
<syntaxhighlight lang="cpp">
void RegisterEnglishVoiceDuration(const uint16_t voiceID, const uint16_t duration)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Japanese Voice Duration ===
<syntaxhighlight lang="cpp">
void RegisterJapaneseVoiceDuration(const uint16_t voiceID, const uint16_t duration)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Character Welds ===
<syntaxhighlight lang="cpp">
void RegisterCharacterWelds(const uint8_t character, const char* iniPath)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Voice ===
<syntaxhighlight lang="cpp">
uint16_t RegisterVoice(const char* fileJP, const char* fileEN, uint16_t durationJP, uint16_t durationEN)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Push Interpolation Fix ===
<syntaxhighlight lang="cpp">
void PushInterpolationFix()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Pop Interpolation Fix ===
<syntaxhighlight lang="cpp">
void PopInterpolationFix()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Permanent Texlist ===
<syntaxhighlight lang="cpp">
void RegisterPermanentTexlist(NJS_TEXLIST* texlist)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Unreplace File ===
<syntaxhighlight lang="cpp">
void UnreplaceFile(const char* file)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Expand PVM List ===
<syntaxhighlight lang="cpp">
TEX_PVMTABLE* ExpandPVMList(TEX_PVMTABLE* sourcepvmlist, const TEX_PVMTABLE &newpvmentry)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

Mod Loaders

2025-10-03T14:27:57Z

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

Mod Loaders

2025-10-03T14:08:48Z

ItsEasyActually:

Mod Loaders

2025-10-03T11:36:50Z

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"

Main Page

2025-10-03T11:24:27Z

ItsEasyActually: Updating links to point to same named pages.

== Introduction ==
<strong>Welcome to SA Docs, the main knowledge base for Sonic Adventure modding!</strong>

This is the latest attempt by the [[X-hax|x-hax community]] to document mod development and tools for SADX/SA2.

We need your help! If you have experience with mods or tools, please register an account and help us transfer pages from the [[Other wikis|older wikis]]. You can also create new pages for the tools that haven't been documented, or write tutorials on modding. To contribute, please register an account and ask on the #sa-docs channel on the [https://discord.gg/gqJCF47 x-hax Discord server] to get editing permissions.

== Categories ==

=== Tutorials ===
[[Installing mods]]

[[Creating mods]]

[[Ripping assets]]
=== Modding software ===
[[SA Tools]]

[https://x-hax.github.io/SonicAdventureBlenderIO/ SAIO Blender add-on]

[[Mod Loaders]]

[[Mod Managers]]

[[Mod Installers]]

[[Game Launchers]]

[[Other tools]]

=== Games ===
[[Sonic Adventure]] and its ports

[[Sonic Adventure 2]] and its ports

Although we focus on SA1/DX and SA2 for the most part, the [[SA Tools]] can be used to view and edit some data in other games. Among such games are:

[[Billy Hatcher|Billy Hatcher and the Giant Egg]]

[[Phantasy Star Online]]

[[Sonic Shuffle]]

[[Skies of Arcadia]]

[[Sonic Heroes]]

[[Shadow the Hedgehog]]

Main Page

2025-10-03T11:19:02Z

ItsEasyActually: Adjusting some titles to use a title formatting (e.g. "Mod Loaders" instead of "Mod loaders."

== Introduction ==
<strong>Welcome to SA Docs, the main knowledge base for Sonic Adventure modding!</strong>

This is the latest attempt by the [[X-hax|x-hax community]] to document mod development and tools for SADX/SA2.

We need your help! If you have experience with mods or tools, please register an account and help us transfer pages from the [[Other wikis|older wikis]]. You can also create new pages for the tools that haven't been documented, or write tutorials on modding. To contribute, please register an account and ask on the #sa-docs channel on the [https://discord.gg/gqJCF47 x-hax Discord server] to get editing permissions.

== Categories ==

=== Tutorials ===
[[Installing mods]]

[[Creating mods]]

[[Ripping assets]]
=== Modding software ===
[[SA Tools]]

[https://x-hax.github.io/SonicAdventureBlenderIO/ SAIO Blender add-on]

[[Mod loaders|Mod Loaders]]

[[Mod managers|Mod Managers]]

[[Mod installers|Mod Installers]]

[[Game launchers|Game Launchers]]

[[Other tools]]

=== Games ===
[[Sonic Adventure]] and its ports

[[Sonic Adventure 2]] and its ports

Although we focus on SA1/DX and SA2 for the most part, the [[SA Tools]] can be used to view and edit some data in other games. Among such games are:

[[Billy Hatcher|Billy Hatcher and the Giant Egg]]

[[Phantasy Star Online]]

[[Sonic Shuffle]]

[[Skies of Arcadia]]

[[Sonic Heroes]]

[[Shadow the Hedgehog]]