Fighting Game · Guides & deep dives

Packaging And Local Testing

Build a deterministic .mayamod archive and expose it through the local testing server.

3sections1 minread
Markdown source
On this page

Use this tutorial with any example mod in V2/ue/Content/V2/Modding/Examples.

Goal#

Build a deterministic .mayamod archive and expose it through the local testing server.

Steps#

  1. Run python3 V2/ue/Tools/build-v2-mayamod.py --project-root <example>.
  2. Run python3 V2/ue/Tools/package-v2-mayamod.py --project-root <example> --output /tmp/example.mayamod.
  3. Run python3 V2/ue/Tools/serve-v2-mayamod.py --project-root <example> --self-test.
  4. Inspect /catalog.json and /manifest.json.
  5. Confirm any API calls used by the example are documented in V2/docs/modding/generated/mod-api-reference.md.
  6. Run python3 V2/ue/Tools/check-v2-mod-development-tutorials.py.

Expected Result#

The package has deterministic ZIP metadata, refreshed script and preview hashes, and a local server catalog that points at the same manifest used by the loader.