MelonLoader

---

<img src="https://img.shields.io/github/v/release/LavaGang/MelonLoader?label=latest&style=for-the-badge"> <img src="https://img.shields.io/discord/663449315876012052?label=discord&style=for-the-badge&color=blueviolet">

<img src="https://img.shields.io/github/downloads/LavaGang/MelonLoader.Installer/latest/MelonLoader.Installer.exe?style=for-the-badge&label=Windows%20Installer">

<img src="https://img.shields.io/github/downloads/LavaGang/MelonLoader.Installer/latest/MelonLoader.Installer.Linux?style=for-the-badge&label=Linux%20Installer">

<img src="https://img.shields.io/github/downloads/LavaGang/MelonLoader.Installer/latest/MelonLoader.Installer.MacOS.dmg?style=for-the-badge&label=MacOS%20Installer">

---

GENERAL INFORMATION:

• Debug Mode is for Development Purposes.

Use it to help Develop and Debug MelonLoader, Plugins, and Mods.
</br>

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

</br>

• The Official Wiki

</br>

• Proxies
• Launch Options
• Debugging

</br>

• Linux Support (__WINE / STEAM PROTON / NATIVE__)
• Android & Oculus Quest Support (__WIP__)

</br>

| 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:

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 Archive from Releases
4. Extract the MelonLoader folder from the MelonLoader Archive to the Game's Installation Folder.
5. Extract version.dll & dobby.dll from the MelonLoader 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