Skip to content

Latest commit

 

History

History
122 lines (80 loc) · 3.52 KB

README.md

File metadata and controls

122 lines (80 loc) · 3.52 KB
Raw

MuseDashModLoader

A Mod Loader built for Muse Dash

Build status

中文Readme

Mods available here

  • Patch: Fix game borderless implementation. Fix Discord API error.
  • RedirectUnityLog: Redirect and trace the output of methods like Debug.Log() to Modlogger.Helpful for development.

Other mods

You can find other non-development mods, including Custom Songs, in our Discord community.

How is it different from modifying game files or third-party launchers?

To install MuseDashModLoader, you only need to copy a few files to the game root directory.

No files are overwritten.

No need to re-install after game update.

No third-party launcher required.

Install

You can download the latest stable version in Github releases

  • Dist Release: For users, does not contain program symbols.

  • Debug Release: For developers, contains program symbols.

Or download the latest development version in Appveyor artifacts

Extract files into the root directory of Muse Dash.

Congratulations, MuseDashModLoader has been installed!

MuseDashModLoader will launch automatically when you start the game.

Installing mods

Put the mod file (.dll extension) into the Mods folder.

Mods folder will be created automatically after you run the game once.

Uninstalling mods

Delete the mod from the Mods folder.

ModLoader.ini Configuration

Some initial behavior of MuseDashModLoader can be set in ModConfig.ini

[UnityDoorstop]
# Specify whether to enable Modloader
enabled=true
# Specify the dll to be injected
targetAssembly=ModLoader.dll
# Specifies whether Unity's output log should be redirected to <current folder>\output_log.txt
redirectOutputLog=true
# Specifies whether to display the debug window. Using ModLogger.Debug() method
showConsoleWindow=true

Develop new mods

Development tools: Visual Studio 2019

  1. Create a new project.
  2. Select Class Library (.NET Framework) template.
  3. Select Framework version: .NET Framework 3.5.
  4. Complete project creation.
  5. Add ModHelper project to your Solution.
  6. Add ModHelper reference to your project.
  7. In ModHelper Reference Properties, set Copy Local to False.
    If you use Harmony Library in your project, you also need to set Copy Local to False.
    ModLoader already contains the library.
  8. Create a new class. Example:
using HarmonyLib;
using ModHelper;

namespace MyAwesomeProject
{
    class MyAwesomeMod : IMod
    {
        public string Name => "A awesome mod";

        public string Description => "An example of mod";

        public string Author => "Mo10";

        public string HomePage => "https://github.com/mo10/MuseDashModLoader";

        public void DoPatching()
        {
            var harmony = new Harmony("com.github.mo10.myawesomemod");
            // Do somthing...

            // When you want to print to the log:
            // ModHelper.ModLogger.Debug("My log output");
        }
    }
}
  1. When the MuseDashModLoader runs, the DoPatching() method will be executed.

Catch exception

If your mod throws an exception in DoPatching(), you can find the exception message in Modlogger.log.

Thanks

MuseDashModLoader uses the following projects:

Proxy: https://github.com/NeighTools/UnityDoorstop
Harmony: https://github.com/pardeike/Harmony