Getting started

From an empty project to a working cheat panel - on device, on desktop and inside the editor - in a few minutes.

Requirements

  • Unity 2022.3 LTS or newer (including Unity 6).
  • Works identically on Built-in, URP and HDRP - there is no per-pipeline setup.
  • Both the legacy Input Manager and the new Input System are supported and detected automatically.
  • No other packages required. The UI is UI Toolkit; TextMeshPro is not used.

Import the package

Import Debug MD from the Asset Store as usual. Everything lands under Assets/DebugMD/ with full source. That folder is also a valid embedded package, so you can relocate it under Packages/ later if your project prefers UPM layout - nothing in Debug MD cares where it lives.

There is no installation step beyond the import: no prefab to place, no scene to edit, no bootstrap object. The panel creates itself on startup through Unity's initialize-on-load hook. If you want to opt out of that, turn off the Auto Load setting and call DMD.Init() wherever your game sets up its debug tooling - see Starting it yourself.

Register your first options

Registration is one call per option, from anywhere in your game code. DMD lives in the global namespace, so no using directive is needed:

PlayerCheats.cs
using UnityEngine;

public class PlayerCheats : MonoBehaviour
{
    private bool _god;

    private void Start()
    {
        DMD.Options.AddToggle("God Mode", () => _god, v => _god = v);

        DMD.Options.AddFloat("Time Scale",
                () => Time.timeScale, v => Time.timeScale = v)
            .WithRange(0f, 3f).WithStep(0.25f);

        DMD.Options.AddButton("Log Position",
            () => Debug.Log(transform.position));
    }
}

Three things worth noticing:

  • Options read and write through the delegates you pass in. There is no reflection, no attribute scanning at runtime, and nothing for IL2CPP stripping to break.
  • The float gained a range bar you can drag just by declaring WithRange. Type-specific modifiers like this go before placement modifiers such as InTab - the typed part of the chain must come first.
  • Values shown in the panel stay live: widgets re-read your getters while visible, so a value changed elsewhere in code updates on screen by itself.

Open the panel

Enter play mode (or make a development build) and open the panel any of these ways:

WhereHow
On device Triple-tap or press and hold the top-left corner (the default gesture; others are available, including a three-finger tap).
On desktop Press F1 (configurable in settings).
In the editor Window › Debug MD › Panel - a dockable window hosting the same UI, usable during play mode without covering the Game view.
From code DMD.ShowPanel(), DMD.TogglePanel() - wire it to your own gesture or debug key.
Screenshot pending - the Debug MD panel docked as an editor window next to the Game view, showing the options registered above
The dockable editor window renders the same visual tree as the on-device overlay.

Tune the defaults (optional)

Everything works without a settings asset. When you want to change the trigger gesture, keyboard shortcut, PIN gate or polling rate, open Window › Debug MD › Settings - it creates the single settings asset on demand and edits it in place. Every setting is described in Opening & configuring.

Where next

  • Option types - everything you can put in the panel, and the two registration styles.
  • Pickers - the searchable list for "pick one of N" cheats, comfortable at 10,000+ items.
  • Tabs, rows & layout - keep a growing panel organized.
  • Stripping from builds - what happens to your DMD calls in release.