Fighting Game · Guides & deep dives

Safe UI Overlay

Create a mod-owned UI panel without replacing core HUD, ranked, commerce, or account surfaces.

3sections1 minread
Markdown source
On this page

Use this tutorial with community.examples.mod-panel-overlay.

Goal#

Create a mod-owned UI panel without replacing core HUD, ranked, commerce, or account surfaces.

Steps#

  1. Review CreateUIScreen and ModifyCosmeticComponent in the generated API reference at V2/docs/modding/generated/mod-api-reference.md.
  2. Open V2/ue/Content/V2/Modding/Examples/ModPanelOverlay.mayamod/scripts/ui_overlay.lua.
  3. Confirm the screen id starts with Menu.ModPanel.
  4. Confirm cosmetic component edits target mod-owned presentation state only.
  5. Use serve-v2-mayamod.py --self-test before loading the example locally.

Expected Result#

The mod creates only an approved UI surface and never mutates gameplay state.