Skip to content

MuseDashMirror

MuseDashMirror is a library for Muse Dash mods built with MelonLoader. It provides scene and game callbacks, commonly used game data, UI helpers, Unity extensions, and source generators that wire attributed members without runtime reflection.

Start here

  • Getting started covers project setup and a first scene callback.
  • Events and scenes lists the available lifecycle and game patch hooks.
  • Source generators explains generated loggers, callbacks, and option-menu toggles.
  • Game data describes PlayerData and BattleComponent and when their values are available.
  • UI components covers canvases, text, toggles, fonts, layout, and positioning.
  • Utilities and extensions covers GameObject lookup and the general extension methods.
  • Troubleshooting collects common build, source-generation, lifecycle, and data-availability problems.

Installation

The recommended starting point is MuseDash.Mod.Template, with MuseDashMirror selected as a useful library. For an existing MelonLoader mod project, install the NuGet package:

dotnet add package MuseDashMirror

Note

MuseDashMirror does not replace MelonLoader or the Muse Dash IL2CPP reference assemblies required by a mod project. The template is the easiest way to configure those references.