MelonLoaderNightly
The World's First Universal Mod Loader for Unity Games compatible with both Il2Cpp and Mono
About this mod Author’s original text
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
- Debugging
- Linux Support (__WINE / STEAM PROTON / NATIVE__)
- Android & Oculus Quest Support (__WIP__)
| Usage Guides: |
| - |
| INSTALLER |
| MANUAL USE |
| Example Projects: |
| - |
| TestPlugin |
| TestMod |
| Nightly Builds: |
| - |
| master |
| alpha-development |
| universality |
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:
- 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:
- Follow the Steps to UN-INSTALL
- Follow the Steps to INSTALL
INSTALL:
- Make sure the Game is Closed and Not Running before attempting to Install.
- Make sure you have all the Requirements Installed before attempting to Install.
- Download MelonLoader Archive from Releases
- Extract the MelonLoader folder from the MelonLoader Archive to the Game's Installation Folder.
- Extract version.dll & dobby.dll from the MelonLoader Archive to the Game's Installation Folder.
UN-INSTALL:
- Make sure the Game is Closed and Not Running before attempting to UN-INSTALL.
- Remove the version.dll file from the Game's Installation Folder.
- 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.
- Remove the Plugins folder from the Game's Installation Folder.
- Remove the Mods folder from the Game's Installation Folder.
- 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_
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.