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.
In order to run the games you will also need Microsoft Visual C++ 2015 Redistributable and Latest Microsoft Visual C++ Redistributable both x86 and x64 for both packages.
Note for Linux users: v0.1.5.1 is the last version that works with Mono (and probably Wine/Proton) (as for 2023).
Join our Sonic 4 Modding Discord server
FAQ: https://github.com/OSA413/Sonic4_ModLoader/blob/master/docs/FAQ.md
Table of content:
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)
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.
-
Download Mod Loader. Latest stable release is recommended, but you also can try the latest alpha version (if any available).
-
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).
-
Launch
Sonic4ModManager.exeand 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).
- Go to the settings menu in the Mod Manager and select the "Installation" tab.
- If "Uninstall" button is disabled or is named "Install", check "Force uninstall" box
- Choose how Mod Loader should be uninstalled using uninstallation settings below.
- Click "Uninstall" button
- Create a
modsfolder in the root directory of the game if it's not present. - Place/extract your mod folder into that
modsfolder. The path to themod.inifile should be something like/mods/My Cool Mod/mod.ini - Enable the mod in the Mod Manager.
Installation from a local archive/directory:
- Drag and drop a mod archive/directory on
OneClickModInstaller.exe - Press the "Install" button.
- Enable the mod in the Mod Manager.
-
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
-
GTK4 by GTK Team/GNOME under the LGPLv2.1+ license https://gtk.org/
- Launch One-Click Mod Installer
- Go to the Settings tab
- Select "Paths" tab
- Check "Use a local copy of 7-Zip from this computer"
- Specify path to
7z.exein 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.
- 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 INSTALLbutton on a service that supports 1-Click integration (e.g. GameBanana)
- Press "Install"
- Agree to replace current version with the downloaded one.
- How to use AMBPatcher:
AMBPatcher.exe --help - Mod structure
- Description of file extensions
- Modding as for its current state
- How to compile Mod Loader
- darealshinji's rewritten launcher for Episode 1 so you don't have to install Java to run it.
~OSA413