Skip to content
A mod loader for Sonic 4
C# Python Shell
Branch: master
Clone or download
Latest commit 8b9eaf0 Sep 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update bug_report.md Oct 15, 2018
Sonic4_ModLoader Mod Manager: added LinkClicked to License Reader Sep 8, 2019
dependencies grammar(?) fix Jun 16, 2019
docs v0.1.4.1 change log Sep 13, 2019
unit-tests Removed the only useful script since AMBPatcher now can do this, Jun 23, 2019
.gitignore Docs update Apr 19, 2019
LICENSE Year update Mar 30, 2019
README.md Fix link Aug 9, 2019
build_pack_test.sh
fix_sh_newline.py Keep file ending of sh to LF Jun 16, 2019

README.md

Sonic 4 Mod Loader

Table of content:

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

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

  2. 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).

  3. 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 integration, 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

  1. Create a mods folder in the root directory of the game if it's not present.
  2. 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
  3. 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

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)
  1. Press "Install"
  2. Agree to replace current version with the downloaded one.

Bug reporting and suggestions

Bugs reports and suggestions should be sent to GitHub's issues page of the Mod Loader: https://github.com/OSA413/Sonic4_ModLoader/issues

For other types of discussions contact my somewhere on the Internet.

Useful documentation for modders

Documentation index

FAQ

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

~OSA413

You can’t perform that action at this time.