MelonLoader

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
• All Plugins get placed in the created Plugins
• All Mods get placed in the created Mods folder in your Game's Installation Folder.
  
  
• The Official Wiki
  
  
• Proxies
• Launch Options
• Debugging
  
  
• Linux Support (WINE / STEAM PROTON / NATIVE)
• Android & Oculus Quest Support (WIP)
  
  

❤️ SPECIAL THANKS TO OUR WONDERFUL PATRONS ❤️

• Givo
• Florian Fahrenberger
• Python
• SirCoolness
• SlidyDev

REQUIREMENTS:

Il2Cpp Games:

• .NET 6.0 Desktop Runtime

On Windows, the .NET 6.0 Desktop Runtime will be installed automatically

HOW TO USE THE INSTALLER:

1. Follow the Instructions in one of the Guides linked below.

HOW TO MANUALLY USE MELONLOADER:

UPDATE / RE-INSTALL:

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

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.

CONFIG:

MelonLoader has its own config file at ./UserData/Loader.cfg (you need to run MelonLoader at least once for it to appear).

Here is a list of the current config options (and their default values):

[loader] # Disables MelonLoader. Equivalent to the '--no-mods' launch option disable = false # Equivalent to the '--melonloader.debug' launch option debug_mode = true # Capture all Unity player logs into MelonLoader's logs even if the game disabled them. NOTE: Depending on the game or Unity version, these logs can be overly verbose. Equivalent to the '--melonloader.captureplayerlogs' launch option capture_player_logs = true # The maximum Harmony log verbosity to capture into MelonLoader's logs. Possible values in verbosity order are: "None", "Error", "Warn", "Info", "Debug", or "IL". Equivalent to the '--melonloader.harmonyloglevel' launch option harmony_log_level = "Warn" # Only use this if the game freezes when trying to quit. Equivalent to the '--quitfix' launch option force_quit = false # Disables the start screen. Equivalent to the '--melonloader.disablestartscreen' launch option disable_start_screen = false # Starts the dotnet debugger on Windows and wait it is attached or just wait until one is attached without launch on other OSes (only for Il2Cpp games). Equivalent to the '--melonloader.launchdebugger' launch option launch_debugger = false # Sets the loader theme. Currently, the only available themes are "Normal" and "Lemon". Equivalent to the '--melonloader.consolemode' launch option (0 for Normal, 4 for Lemon) theme = "Normal" [console] # Hides warnings from displaying. Equivalent to the '--melonloader.hidewarnings' launch option hide_warnings = false # Hides the console. Equivalent to the '--melonloader.hideconsole' launch option hide_console = false # Forces the console to always stay on-top of all other applications. Equivalent to the '--melonloader.consoleontop' launch option console_on_top = false # Keeps the console title as original. Equivalent to the '--melonloader.consoledst' launch option dont_set_title = false [logs] # Sets the maximum amount of log files in the Logs folder (Default: 10). Equivalent to the '--melonloader.maxlogs' launch option max_logs = 10 [mono_debug_server] # Let the Mono debug server wait until a debugger is attached when debug_mode is true (only for Mono games). Equivalent to the '--melonloader.debugsuspend' launch option debug_suspend = false # The IP address the Mono debug server will listen to when debug_mode is true (only for Mono games). Equivalent to the '--melonloader.debugipaddress' launch option debug_ip_address = "127.0.0.1" # The port the Mono debug server will listen to when debug_mode is true (only for Mono games). Equivalent to the '--melonloader.debugport' launch option debug_port = 55555 [unityengine] # Overrides the detected UnityEngine version. Equivalent to the '--melonloader.unityversion' launch option version_override = "" # Disables the console log cleaner (only applies to Il2Cpp games). Equivalent to the '--melonloader.disableunityclc' launch option disable_console_log_cleaner = false # Forces the Il2Cpp Assembly Generator to run without contacting the remote API. Equivalent to the '--melonloader.agfoffline' launch option force_offline_generation = false # Forces the Il2Cpp Assembly Generator to use the specified regex. Equivalent to the '--melonloader.agfregex' launch option force_generator_regex = "" # Forces the Il2Cpp Assembly Generator to use the specified Il2Cpp dumper version. Equivalent to the '--melonloader.agfvdumper' launch option force_il2cpp_dumper_version = "" # Forces the Il2Cpp Assembly Generator to always regenerate assemblies. Equivalent to the '--melonloader.agfregenerate' launch option force_regeneration = false # Enables the CallAnalyzer processor for Cpp2IL. Equivalent to the '--cpp2il.callanalyzer' launch option enable_cpp2il_call_analyzer = false # Enables the NativeMethodDetector processor for Cpp2IL. Equivalent to the '--cpp2il.nativemethoddetector' launch option enable_cpp2il_native_method_detector = false

LAUNCH OPTIONS:

• These are additional Launch Options that MelonLoader adds to the Game.
• These can be used to manipulate how MelonLoader works.

• These ones below are Unity Engine specific Launch Options.

• These ones below are Cpp2IL specific Launch Options.

PROXIES:

MelonLoader uses a proxy DLL to trick the game into loading itself on startup. This only applies for Windows.

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

LICENSING & CREDITS:

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

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

• Dobby is licensed under the Apache License, Version 2.0. See for the full License.
• plthook is licensed under the 2-Clause BSD License. See LICENSE text at the top of the file for the full License.
• Mono is licensed under multiple licenses. See for full details.
• HarmonyX
• MonoMod
• Mono.Cecil is licensed under the MIT License. See LICENSE for the full License.
• Newtonsoft.Json
• TinyJSON
• Tomlet
• AsmResolver is licensed under the MIT License. See LICENSE for the full License.
• SharpZipLib
• Semver
• Illusion Plugin Architecture
• MuseDashModLoader is licensed under the MIT License. See LICENSE for the full License.
• mgGif
• AssetsTools.NET
• AssetRipper.VersionUtilities is licensed under the MIT License. See LICENSE for the full License.
• Steam Library, VDF, and ACF Parsing from SteamFinder.cs by Umbranoxio and Dalet.
• bHapticsLib
• IndexRange
• ValueTupleBridge LICENSE for the full License.
• WebSocketDotNet is licensed under the MIT License. See
• Cake
• Il2CppInterop is licensed under the LGPLv3 License. See

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

• CPPP2IL is licensed under the MIT License. See LICENSE for the full License.
• Unity Runtime Libraries from MelonLoader.UnityDependencies are part of Unity Software.
  Their usage is subject to Unity Terms of Service, including Unity Software Additional Terms.
• .NET Runtime is licensed under the MIT License. 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.