# Mod Development Tutorials And Examples

This document covers `TODOS.phase-72.72.14.1.15`: the tutorial path and example
mods for V2 `.mayamod` development.

## Learning Path

The tutorial index is `V2/docs/modding/tutorials/README.md`.

- `getting-started.md` introduces project creation and the hello-world example.
- `scripting-events.md` covers public event listeners and mod-scoped storage.
- `ui-overlay.md` covers safe UI roots and cosmetic component edits.
- `packaging-local-testing.md` covers deterministic packages and the local
  testing server.

## Example Mods

Example `.mayamod` directories live under `V2/ue/Content/V2/Modding/Examples`:

- `HelloWorld.mayamod` demonstrates `ReadPublicGameState` and
  `RegisterEventListener`.
- `PublicEventLogger.mayamod` demonstrates `RegisterEventListener`,
  `ReadModStorage`, and `WriteModStorage`.
- `ModPanelOverlay.mayamod` demonstrates `CreateUIScreen` and
  `ModifyCosmeticComponent`.

Each example includes a manifest, Lua script, and preview thumbnail. The
examples are offline-safe, keep network access denied, and reference the
generated API reference at `V2/docs/modding/generated/mod-api-reference.md`.

## Runtime Catalog

`BuildDefaultModDevelopmentTutorialCatalog` exposes the tutorial lessons and
example mods to editor tooling. `ValidateModDevelopmentTutorialCatalog` checks
that the learning path covers project creation, API examples, packaging, and
local testing, and that every lesson points at a registered example mod.

## Verification

```bash
python3 V2/ue/Tools/check-v2-mod-development-tutorials.py
python3 V2/ue/Tools/check-v2-mod-documentation-generator.py
python3 V2/ue/Tools/check-v2-mod-creation-toolkit.py
python3 V2/ue/Tools/check-v2-mod-loading-system.py
python3 V2/ue/Tools/check-v2-ci-workflow.py
python3 V2/tools/validate-v2-docs.py
python3 -m py_compile V2/ue/Tools/check-v2-mod-development-tutorials.py
python3 -m json.tool V2/ue/Content/V2/Modding/ModDevelopmentTutorials_V2_Contract.json
```