MelonLoader

MelonLoader is a universal mod loader for all Unity games.

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)
• Android & Oculus Quest Support (WIP)

Example Projects:

• TestPlugin
• TestMod

DNSPY DEBUGGER USAGE:

1. Go into dnSpy, then in the top, select Debug -> Start Debugging and select Unity as the debug engine.
2. Then, for the executable, select your game's executable
3. And in the Arguments box, add --melonloader.debug and any other arguments you want
4. Finally, to add breakpoints, simply drag and drop the mod you want to debug into dnSpy's Assembly Explorer, then add breakpoints regularly.

You can read more about attaching the dnSpy debugger in the MelonLoader wiki.

START SCREEN CUSTOMIZATION:

• After Initial Launch the Start Screen will create a folder under UserData/MelonStartScreen
• Inside this folder it will create a Config.cfg file for Customization Settings.
• You can also place Custom Images in this folder to further customize the Start Screen.
• Listed below are the Compatible File Names and Extensions for the Custom Images.

Compatible File Names:

• Background
• Loading
• Logo

Compatible Extensions:

• .gif
• .png
• .jpg
• .jpeg

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:

• 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.
• HarmonyX is licensed under the MIT License. See LICENSE for the full License.
• MonoMod is licensed under the MIT License. See LICENSE for the full License.
• Mono.Cecil is licensed under the MIT License. See LICENSE for the full License.
• Newtonsoft.Json 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.
• Tomlet 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.
• Semver is licensed under the MIT License. See LICENSE for the full License.
• UnityEngine.Il2CppAssetBundleManager is licensed under the Apache License, Version 2.0. See LICENSE for the full License.
• UnityEngine.Il2CppImageConversionManager is licensed under the Apache License, Version 2.0. See LICENSE for the full License.
• Illusion Plugin Architecture is licensed under the MIT License. See LICENSE for the full License.
• MuseDashModLoader is licensed under the MIT License. See LICENSE for the full License.
• mgGif is licensed under the MIT License. See LICENSE for the full License.
• AssetsTools.NET is licensed under the MIT License. See LICENSE for the full License.
• 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 is licensed under the MIT License. See LICENSE for the full License.
• IndexRange is licensed under the MIT License. See LICENSE for the full License.
• ValueTupleBridge is licensed under the MIT License. See LICENSE for the full License.
• WebSocketDotNet is licensed under the MIT License. See LICENSE for the full License.

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

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

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.