Fighting Game · Guides & deep dives

Getting Started With .mayamod

Create a local project, inspect its manifest, and run a small Lua bootstrap that reads public state and listens for a public mod event.

3sections1 minread
Markdown source
On this page

Use this tutorial with community.examples.hello-world.

Goal#

Create a local project, inspect its manifest, and run a small Lua bootstrap that reads public state and listens for a public mod event.

Steps#

  1. Read V2/docs/modding/mayamod-file-format.md.
  2. Create a project with V2/ue/Tools/create-v2-mayamod-project.py.
  3. Compare the generated manifest to V2/ue/Content/V2/Modding/Examples/HelloWorld.mayamod/manifest.json.
  4. Open scripts/bootstrap.lua and find the ReadPublicGameState and RegisterEventListener examples.
  5. Cross-check those calls in V2/docs/modding/generated/mod-api-reference.md.

Expected Result#

The mod remains offline-safe, uses only sandboxed API calls, and can be packaged with V2/ue/Tools/build-v2-mayamod.py.