stephenc87 / melonloader

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

GENERAL INFORMATION:

• Normal Console is for Debugging and Displaying the Output of Plugins and Mods.
• Debug Mode/Console is for Debugging MelonLoader Internals.
• All Plugins get placed in the created Plugins folder inside the Game's Install Folder.
• All Mods get placed in the created Mods folder inside the Game's Install Folder.
• All Logs are made in the created Logs folder inside the Game's Install Folder.
• In order to properly use dnSpy's Debugger run the game with the Debug Mode/Console launch option.

---

REQUIREMENTS:

• .NET Framework 4.8 Runtime
• Microsoft Visual C++ 2015-2019 Re-distributable

---

AUTOMATED INSTALLATION:

1. Make sure the Game you are installing to is Closed and Not Running.
2. Download MelonLoader.Installer.exe.
3. Run MelonLoader.Installer.exe.
4. Click the SELECT button.
5. Select and Open the Game's EXE in your Game's Installation Folder.
6. Select which Version of MelonLoader to install using the Drop-Down List. (Or leave it as-is for the Latest Version.)
7. Click the INSTALL or RE-INSTALL or UPDATE button.

---

MANUAL INSTALLATION:

1. Make sure the Game you are installing MelonLoader to is Closed and Not Running.
2. Download MelonLoader.zip.
3. Extract the MelonLoader folder from MelonLoader.zip to the Game's Installation Folder.
4. Extract version.dll from MelonLoader.zip to the Game's Installation Folder.

---

AUTOMATED UNINSTALL:

1. Make sure the Game you are uninstalling from is Closed and Not Running.
2. Download MelonLoader.Installer.exe.
3. Run MelonLoader.Installer.exe.
4. Click the SELECT button.
5. Select and Open the Game's EXE in your Game's Installation Folder.
6. Click the UN-INSTALL button.

---

MANUAL UNINSTALL:

1. Make sure the Game you are installing MelonLoader to is Closed and Not Running.
2. Remove the version.dll file from the Game's Installation Folder.
3. Remove the MelonLoader folder from the Game's Installation Folder.
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 Logs folder from the Game's Installation Folder.

---

LAUNCH OPTIONS:

Argument	Description
--no-mods	Launch game without loading Mods
--quitfix	Fixes the Hanging Process Issue with some Games
--melonloader.hideconsole	Hides the Normal Console
--melonloader.hidewarnings	Hides Warnings from Displaying
--melonloader.debug	Debug Mode/Console
--melonloader.magenta	Magenta Console Color
--melonloader.rainbow	Rainbow Console Color
--melonloader.randomrainbow	Random Rainbow Console Color
--melonloader.maxlogs	Max Log Files [ Default: 10 ] [ Disable: 0 ]
--melonloader.maxwarnings	Max Warnings per Log File [ Default: 100 ] [ Disable: 0 ]
--melonloader.maxerrors	Max Errors per Log File [ Default: 100 ] [ Disable: 0 ]
--melonloader.loadmodeplugins	Load Mode for Plugins [ Default: 0 ]
--melonloader.loadmodemods	Load Mode for Mods [ Default: 0 ]
--melonloader.agregenerate	Forces Assembly to be Regenerated on Il2Cpp Games
--melonloader.agfvunhollower	Forces use a Specified Version of Il2CppAssemblyUnhollower
--melonloader.consoleontop	Forces the Console over all other Applications

---

LOAD MODES:

• Load Mode launch options are a way to dictate how you want Mods or Plugins to Load.

Value	Action
0	NORMAL - Load them only if they don't have the "-dev" Name Extension
1	DEV - Load them only if they have the "-dev" Name Extension
2	BOTH - Load All

---

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 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.
• Harmony 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.
• LightJson is licensed under the MIT License. See LICENSE for the full License.
• Tomlyn 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.
• AtiRoNya is licensed under the MIT License. See LICENSE for the full License.
• Unity Runtime libraries (found in Unity Dependencies) are part of Unity Software.
  Their usage is subject to Unity Terms of Service, including Unity Software Additional Terms.

External tools downloaded and used at runtime:

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

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.