/MelonLoader

The World's First Universal Mod Loader for Unity Games compatible with both Il2Cpp and Mono

Primary LanguageC#Apache License 2.0Apache-2.0

GENERAL INFORMATION:

Usage Guides:
INSTALLER
MANUAL USE
Example Projects:
TestPlugin
TestMod
Nightly Builds:
master
alpha-development
universality

❤️ SPECIAL THANKS TO OUR WONDERFUL PATRONS ❤️

  • Givo
  • Florian Fahrenberger
  • Python
  • SirCoolness
  • SlidyDev

REQUIREMENTS:

HOW TO USE THE INSTALLER:

  1. Follow the Instructions in one of the Guides linked below.
Installer Guides:
INSTALL
UPDATE
RE-INSTALL
UN-INSTALL

HOW TO MANUALLY USE MELONLOADER:

UPDATE / RE-INSTALL:

  1. Follow the Steps to UN-INSTALL
  2. Follow the Steps to INSTALL

INSTALL:

  1. Make sure the Game is Closed and Not Running before attempting to Install.
  2. Make sure you have all the Requirements Installed before attempting to Install.
  3. Download MelonLoader [x86] [x64]
  4. Extract the MelonLoader folder from the MelonLoader Zip Archive to the Game's Installation Folder.
  5. Extract version.dll & dobby.dll from the MelonLoader Zip Archive to the Game's Installation Folder.

UN-INSTALL:

  1. Make sure the Game is Closed and Not Running before attempting to UN-INSTALL.
  2. Remove the version.dll & dobby.dll files from the Game's Installation Folder.
  3. Remove the MelonLoader folder from the Game's Installation Folder.

These additional steps below are OPTIONAL if you want to do a FULL UN-INSTALL.

  1. Remove the Plugins folder from the Game's Installation Folder.
  2. Remove the Mods folder from the Game's Installation Folder.
  3. Remove the UserData folder from the Game's Installation Folder.

START SCREEN CUSTOMIZATION:

  • After Initial Launch the Start Screen will create a folder under UserData/MelonStartScreen

  • Inside this folder it will create a Themes folder and a Config.cfg file for Customization Settings.

  • You can also place Custom Themes in the created Themes folder.

  • Inside Config.cfg you can set what Theme folder you would like to use.

  • If you set your Theme folder to Random it will randomly pick and load from existing Themes.

  • For Custom Themes you can place Custom Images in their Theme folder to further customize it.

  • Listed below are the Compatible File Names and Extensions for the Custom Images.

Compatible File Names
Background
Loading
Logo
Compatible Extensions
.gif
.png
.jpg
.jpeg

LAUNCH OPTIONS:

  • These are additional Launch Options that MelonLoader adds to the Game.
  • These can be used to manipulate how MelonLoader works.
Argument Description
--no-mods Launches the Game without loading any Plugins or Mods
--quitfix Fixes the Hanging Process Issue with some Games
--melonloader.consolemode Changes the Theme Display Mode of the Console [ Default = 0 ]
--melonloader.consoleontop Forces the Console to always stay on-top of all other Applications
--melonloader.consoledst Keeps the Console Title as Original
--melonloader.hideconsole Hides the Console
--melonloader.hidewarnings Hides Warnings from Displaying
--melonloader.debug Debug Mode
--melonloader.dab Debug Analytics Blocker
--melonloader.maxlogs Max Log Files [ Default: 10 ] [ NoCap: 0 ]
--melonloader.maxwarnings Max Warnings per Log File [ Default: 100 ] [ NoCap: 0 ] [ Disabled: -1 ]
--melonloader.maxerrors Max Errors per Log File [ Default: 100 ] [ NoCap: 0 ] [ Disabled: -1 ]
--melonloader.loadmodeplugins Load Mode for Plugins [ Default: 0 ]
--melonloader.loadmodemods Load Mode for Mods [ Default: 0 ]
--melonloader.basedir Changes the Proxy's Load Directory for the Bootstrap
--melonloader.disablestartscreen Disable the Start Screen
  • These ones below are Unity Engine specific Launch Options.
Argument Description
--melonloader.unityversion Allows you to Specify the Version of Unity Engine
--melonloader.agfoffline Forces Assembly Generator to Run without Contacting the Remote API
--melonloader.agfregenerate Forces Regeneration of Assembly
--melonloader.agfregex Forces Assembly Generator to use a Specified Regex
--melonloader.agfvdumper Forces Assembly Generator to use a Specified Version of Dumper
--melonloader.agfvunhollower Forces Assembly Generator to use a Specified Version of Il2CppAssemblyUnhollower
--melonloader.disableunityclc Disable Unity Console Log Cleaner

LOAD MODES:

  • Load Mode Launch Options are a way to dictate how you want Mods or Plugins to Load.
  • Below is the Compatible Values and what each of them do.
Value Action
0 Load Only if the File doesn't have the ".dev.dll" Extension
1 Load Only if the File has the ".dev.dll" Extension
2 Load All

CONSOLE DISPLAY MODES:

  • Console Display Modes are built in Themes for the Console
  • Below is the Compatible Values and what each of them do.
Value Mode
0 Normal
1 Magenta
2 Rainbow
3 Random Rainbow

PROXIES:

  • The Proxy DLL is able to be Renamed to the Compatible File Names below.
  • By Default the Proxy is named as "version.dll".
  • For most Games the Default File Name should work perfectly fine.
  • Some Games may have you use a different Proxy File Name depending on the Architecture, Operating System, version of the Engine used by the Game, etc.
File Names:
version.dll
winhttp.dll
winmm.dll

LICENSING & CREDITS:

MelonLoader is licensed under the Apache License, Version 2.0. See LICENSE for the full License.

Third-party Libraries used as Source Code and/or bundled in Binary Form:

External Libraries and Tools that are downloaded and used at Runtime:

See MelonLoader Wiki for the full Credits.

MelonLoader is not sponsored by, affiliated with or endorsed by Unity Technologies or its affiliates.
"Unity" is a trademark or a registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.