gameplane / docs
DOCUMENTATION

Module Authoring

Package game server templates as signed, versioned OCI artifacts with metadata, config schema, and capabilities.

Source layout

A module directory holds template.yaml, module.yaml, an optional README, and an optional icon.

Module metadata

module.yaml declares name, version, game family, and summary — version must match the OCI tag.

PUSHING A BUNDLE 
oras push \
    --artifact-type application/vnd.gameplane.module.v1+json \
    ghcr.io/valgulnecron/gameplane-modules/minecraft-java:1.0.0 \
    module.yaml template.yaml

Bundle format

An OCI artifact with named layers, tagged application/vnd.gameplane.module.v1+json.

The full format spec — template.yaml schema, config surfaces, capabilities, and cosign signing — is in the module authoring guide on GitHub.

PreviousConsole protocolsNextExtension services