Skip to content

Create Mod

Stable

Creating a mod registers a new entry in the registry under the authenticated maintainer's account. The mod is created as PRIVATE and contains no releases; the maintainer configures it and publishes it when ready.

PropertyValue
Applies toWebapp
TriggerAn authenticated user submits the create mod form
PreconditionsThe user is authenticated

Inputs

name : String, required. The display name of the mod.

category : Enum, required. The category the mod belongs to. One of CAMPAIGN, DEVICE_PROFILES, MOD, MISSION, SKIN, SOUND, TERRAIN, UTILITY, or OTHER.

description : String, required. A short description of the mod shown in the catalogue.

Assertions

AssertionStatus
The user must be authenticatedImplemented

Outputs

ModData : The created mod record. The operation always succeeds for authenticated users.

Effects

EffectStatus
A new mod record is created in the registryImplemented
The mod's initial visibility is set to PRIVATEImplemented
The authenticated user is set as the sole maintainerImplemented
A unique identifier is generated and assigned to the modImplemented

Behavior

mermaid
flowchart TD
    Start([createMod user data]) --> Authenticated{User authenticated?}

    Authenticated -- No --> Reject([Reject: 401 Unauthorized])
    Authenticated -- Yes --> Create[Create mod record with<br/>PRIVATE visibility,<br/>user as sole maintainer]

    Create --> Done([Mod created in PRIVATE state])

    style Reject fill:#f87171,color:#fff
    style Done fill:#4ade80,color:#000

See Also

  • Update mod — Spec page for editing a mod's details and changing its visibility.
  • Delete mod — Spec page for removing a mod from the registry.
  • Create release — Spec page for adding a release to a mod.
  • How the Webapp works — Guide covering mod structure, visibility, and the maintainer model.