Sonic 4 Mod Loader

Looking for midday builds? Get it from GitHub Actions!

In order to run it, you need .Net 6 Desktop Runtime and .Net Framework 4.5.2 Runtime installed.

Note for Linux users: v0.1.5.1 is the last version that works with Mono (and probably Wine/Proton).

For x86 builds, see GitHub Actions. Note that x64 is the main supported platform.

Join our Sonic 4 Modding Discord server

FAQ: https://github.com/OSA413/Sonic4_ModLoader/blob/master/docs/FAQ.md

Table of content:

• What is this?
• How to install the Mod Loader
• How to uninstall the Mod Loader
• How to install mods
• Third party works
• How to use a copy of 7-Zip from your system
• How to automatically update Mod Loader
• Bug reporting and suggestions
• Useful documentation for modders and contributors
• See also

What is this?

This program is a mod loader for Sonic 4 (both episodes supported).

The Mod Loader includes:

• Mod Manager to manage your mods (enabling/disabling and changing mod priority)
• One-Click Mod Installer for an easier mod installation through the web and local archives
• AMBPatcher for editing .AMB files
• CsbEditor for editing .CSB files
• 7-Zip as a dependency for One-Click Mod Installer (you can use a copy from your system)

How to install the Mod Loader

TL;DR - a quick installation video guide is here: https://www.youtube.com/watch?v=CbeBXJief7w

Note: you need to install the Mod Loader separately for each Episode.

0. Download Mod Loader. Latest stable release is recommended, but you also can try the latest alpha version (if any available).

1. Extract all files from the archive to the root directory of the game (if you don't know what root directory is/where to find it, check the quick installation video guide above).

2. Launch Sonic4ModManager.exe and press "Yes" button on the First Launch Dialogue. You can also install it in the settings menu.

If you want to enable 1-Click installation, launch OneClickModInstaller.exe and press "Install" button (requires administrator privileges).

How to uninstall the Mod Loader

1. Go to the settings menu in the Mod Manager and select the "Installation" tab.
2. If "Uninstall" button is disabled or is named "Install", check "Force uninstall" box
3. Choose how Mod Loader should be uninstalled using uninstallation settings below.
4. Click "Uninstall" button

How to install mods

Manually

0. Create a mods folder in the root directory of the game if it's not present.
1. Place/extract your mod folder into that mods folder. The path to the mod.ini file should be something like /mods/My Cool Mod/mod.ini
2. Enable the mod in the Mod Manager.

Automatically

Installation from a local archive/directory:

1. Drag and drop a mod archive/directory on OneClickModInstaller.exe
2. Press the "Install" button.
3. Enable the mod in the Mod Manager.

Third party works

• Alice Mod Loader by RadiantDerg under the MIT License. https://github.com/RadiantDerg/AliceModLoader

• CsbEditor (from SonicAudioTools) by Skyth under the MIT License. https://github.com/blueskythlikesclouds/SonicAudioTools

• 7-Zip Copyright (C) Igor Pavlov. (License) https://7-zip.org

How to use copy of 7-Zip from your system

1. Launch One-Click Mod Installer
2. Go to the Settings tab
3. Select "Paths" tab
4. Check "Use a local copy of 7-Zip from this computer"
5. Specify path to 7z.exe in the text field below the checkbox

Note: if OCMI fails to find 7z.exe in your path, it will try to use a copy that comes with Mod Loader.

How to automatically update Mod Loader

1. Do one of the following things:

• Drag and drop archive/directory with Mod Loader on One-Click Mod Installer
• Copy-past the direct link to the Mod Loader archive (e.g. from GitHub) into the OCMI's url mod field in "Install mod" tab.
• Click 1-CLICK INSTALL button on a service that supports 1-Click integration (e.g. GameBanana)

2. Press "Install"
3. Agree to replace current version with the downloaded one.

Useful documentation for modders and contributors

• How to use AMBPatcher: AMBPatcher.exe --help
• Mod structure
• Description of file extensions
• Modding as for its current state
• How to compile Mod Loader

See also

• darealshinji's rewritten launcher for Episode 1 so you don't have to install Java to run it.

~OSA413