ebitgeek / MelonLoader

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

---

---

GENERAL INFORMATION:

• Debug Mode is for Development Purposes. Use it to help Develop and Debug MelonLoader, Plugins, and Mods.
• All Logs are made in the created MelonLoader/Logs folder in your Game's Installation Folder.
• All Plugins get placed in the created Plugins folder in your Game's Installation Folder.
• All Mods get placed in the created Mods folder in your Game's Installation Folder.
  
  
• The Official Wiki
• Proxies
• Launch Options
• dnSpy Debugger Usage
• Wine / Steam Proton Usage
• Android & Oculus Quest Support (WIP)

Usage Guides:
INSTALLER
MANUAL USE

Example Projects:
TestPlugin
TestMod

Nightly Builds:
master
alpha-development
v0.6.0-rewrite

---

REQUIREMENTS:

• .NET Framework 3.5 Runtime
• .NET Framework 4.7.2 Runtime
• .NET Framework 4.8 Runtime
• Microsoft Visual C++ 2015-2019 Re-distributable [x86] [x64]

---

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 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 file 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.

4. Remove the Plugins folder from the Game's Installation Folder.
5. Remove the Mods folder from the Game's Installation Folder.
6. Remove the UserData folder from the Game's Installation Folder.

---

WINE / STEAM PROTON USAGE:

• GUIDE COMING SOON

---

DNSPY DEBUGGER USAGE:

1. Go into dnSpy, then in the top, select Debug -> Start Debugging and select Unity as the debug engine.
2. Then, for the executable, select your game's executable
3. And in the Arguments box, add --melonloader.debug and any other arguments you want
4. Finally, to add breakpoints, simply drag and drop the mod you want to debug into dnSpy's Assembly Explorer, then add breakpoints regularly.

You can read more about attaching the dnSpy debugger in the MelonLoader wiki.

---

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.agfoffline	Forces Assembly Generator to Run without Contacting the Remote API
--melonloader.agfregenerate	Forces Regeneration of Assembly
--melonloader.agfvunity	Forces Assembly Generator to use a Specified Version of Unity Dependencies
--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.agfregex	Forces Assembly Generator to use a Specified Regex
--melonloader.basedir	Changes the Proxy's Load Directory for the Bootstrap
--melonloader.disablestartscreen	Disable the Start Screen
--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 Unity Games the Default File Name should work perfectly fine.
• Some Unity Games may have you use a different Proxy File Name depending on the Architecture, Operating System, version of the Unity Engine used by the Game, etc.

File Names:
psapi.dll
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:

• Research Detours Package is licensed under the MIT License. See LICENSE for the full License.
• Mono is licensed under multiple licenses. See LICENSE for full details.
• HarmonyX is licensed under the MIT License. See LICENSE for the full License.
• MonoMod is licensed under the MIT License. See LICENSE for the full License.
• Mono.Cecil is licensed under the MIT License. See LICENSE for the full License.
• Newtonsoft.Json is licensed under the MIT License. See LICENSE for the full License.
• TinyJSON is licensed under the MIT License. See LICENSE for the full License.
• Tomlet is licensed under the MIT License. See LICENSE for the full License.
• SharpZipLib is licensed under the MIT License. See LICENSE for the full License.
• Semver is licensed under the MIT License. See LICENSE for the full License.
• UnityEngine.Il2CppAssetBundleManager is licensed under the Apache License, Version 2.0. See LICENSE for the full License.
• UnityEngine.Il2CppImageConversionManager is licensed under the Apache License, Version 2.0. See LICENSE for the full License.
• Illusion Plugin Architecture is licensed under the MIT License. See LICENSE for the full License.
• MuseDashModLoader is licensed under the MIT License. See LICENSE for the full License.
• mgGif is licensed under the MIT License. See LICENSE for the full License.
• AssetsTools.NET is licensed under the MIT License. See LICENSE for the full License.
• AssetRipper.VersionUtilities is licensed under the MIT License. See LICENSE for the full License.
• bHaptics Haptic Library is licensed under All rights reserved Copyright (c) 2016-2021 bHaptics Inc.
  See Terms and Conditions for the full License. We have Express Permission from bHaptics.

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

• Cpp2IL is licensed under the MIT License. See LICENSE for the full License.
• Il2CppDumper is licensed under the MIT License. See LICENSE for the full License.
• Il2CppAssemblyUnhollower is licensed under the GNU Lesser General Public License v3.0. See LICENSE for the full License.
• Unity Runtime Libraries from Unity-Runtime-Libraries are part of Unity Software.
  Their usage is subject to Unity Terms of Service, including Unity Software Additional Terms.

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.