Skip to content

SirCoolness/MelonLoader

 
 

Repository files navigation


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
Usage Guides:
INSTALLER
MANUAL USE
Example Projects:
TestPlugin
TestMod

REQUIREMENTS:


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.

  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.

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:
version.dll
winmm.dll
winhttp.dll

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

WINE / STEAM PROTON USAGE:

  • COMING SOON

DNSPY DEBUGGER USAGE:

  • COMING SOON

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 Launch game without loading any Plugins Mods
--quitfix Fixes the Hanging Process Issue with some Games
--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.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.agfregenerate Forces Regeneration of Assembly
--melonloader.agfvunity Forces use a Specified Version of Unity Dependencies
--melonloader.agfvdumper Forces use a Specified Version of Dumper
--melonloader.agfvunhollower Forces use a Specified Version of Il2CppAssemblyUnhollower

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:

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

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.

Languages

  • C++ 45.5%
  • C# 39.5%
  • ASP.NET 10.6%
  • Java 1.6%
  • Assembly 1.5%
  • C 0.6%
  • Other 0.7%