ValgulNecron · Jul 17, 2026 · Jul 17, 2026
diff --git a/.schema/README.md b/.schema/README.md
@@ -0,0 +1,35 @@
+# Editor schemas for module YAML
+
+JSON Schemas that give editors (VS Code's `redhat.vscode-yaml`, and any
+`yaml-language-server` client) validation and autocomplete for the two YAML
+files in every module — and stop the extension from guessing an unrelated
+schema from its schema store (it used to mis-match `template.yaml` against the
+AWS SAM schema and flag valid fields).
+
+Each module file opts in with a first-line modeline:
+
+```yaml
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json   # template.yaml
+# yaml-language-server: $schema=../.schema/module.schema.json         # module.yaml
+```
+
+The relative path resolves whether this repo is opened on its own or as the
+`modules/` submodule of the Gameplane repo.
+
+| File | Schema | Source |
+| --- | --- | --- |
+| `template.yaml` | `gametemplate.schema.json` | **Generated** from the GameTemplate CRD in the Gameplane repo. Do not hand-edit. |
+| `module.yaml` | `module.schema.json` | Hand-maintained; mirrors `docs/module-authoring.md`. |
+
+## Regenerating `gametemplate.schema.json`
+
+`template.yaml` is a `GameTemplate` custom resource, so its schema is the CRD's
+`openAPIV3Schema`. When the CRD changes (new spec fields), regenerate from the
+**Gameplane** repo — the submodule doesn't carry the CRD:
+
+```sh
+make module-schema      # runs hack/gen-module-schema.py, writes modules/.schema/gametemplate.schema.json
+```
+
+Then commit the updated file here (and bump the submodule pointer in the
+Gameplane repo).
diff --git a/.schema/gametemplate.schema.json b/.schema/gametemplate.schema.json
diff --git a/.schema/module.schema.json b/.schema/module.schema.json
@@ -0,0 +1,62 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Gameplane module manifest (module.yaml)",
+  "description": "The bundle metadata layer of a Gameplane module. See docs/module-authoring.md in the Gameplane repo for the authoritative format.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["apiVersion", "name", "displayName", "version", "game", "summary"],
+  "properties": {
+    "apiVersion": {
+      "const": "gameplane.local/module/v1"
+    },
+    "name": {
+      "type": "string",
+      "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$",
+      "maxLength": 63,
+      "description": "DNS-1123 label; must match the module directory name."
+    },
+    "displayName": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Human-readable name shown on the catalog card."
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(?:-[0-9A-Za-z.-]+)?(?:\\+[0-9A-Za-z.-]+)?$",
+      "description": "Semver; must match the OCI tag the bundle is pushed under."
+    },
+    "game": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Free-form game family identifier (e.g. minecraft-java)."
+    },
+    "categories": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Catalog groupings; a module may belong to several."
+    },
+    "summary": {
+      "type": "string",
+      "minLength": 1,
+      "description": "One-line description for the catalog card."
+    },
+    "homepage": {
+      "type": "string",
+      "format": "uri",
+      "description": "Optional project/game homepage URL."
+    },
+    "license": {
+      "type": "string",
+      "description": "Optional SPDX license identifier."
+    },
+    "gameplaneMinVersion": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(?:-[0-9A-Za-z.-]+)?$",
+      "description": "Optional minimum operator version; install is refused on older operators."
+    },
+    "icon": {
+      "type": "string",
+      "description": "Optional filename of the icon layer (e.g. icon.png)."
+    }
+  }
+}
diff --git a/7-days-to-die/module.yaml b/7-days-to-die/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: 7-days-to-die
 displayName: 7 Days to Die

diff --git a/7-days-to-die/template.yaml b/7-days-to-die/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for 7 Days to Die (dedicated server).
 #
 # Backed by vinanrra/7dtd-server (https://github.com/vinanrra/Docker-7DaysToDie),

diff --git a/ark-survival-ascended/module.yaml b/ark-survival-ascended/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: ark-survival-ascended
 displayName: "ARK: Survival Ascended"

diff --git a/ark-survival-ascended/template.yaml b/ark-survival-ascended/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for ARK: Survival Ascended (dedicated server).
 #
 # Backed by mschnitzer/asa-linux-server

diff --git a/cs2/module.yaml b/cs2/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: cs2
 displayName: Counter-Strike 2

diff --git a/cs2/template.yaml b/cs2/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Counter-Strike 2 (dedicated server).
 #
 # Backed by joedwards32/CS2 (cm2network/cs2 is a downstream mirror of the

diff --git a/dayz/module.yaml b/dayz/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: dayz
 displayName: DayZ

diff --git a/dayz/template.yaml b/dayz/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for DayZ (dedicated server).
 #
 # Backed by GodBleak/ServerZ (https://github.com/GodBleak/ServerZ), pulled

diff --git a/dont-starve-together/module.yaml b/dont-starve-together/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: dont-starve-together
 displayName: Don't Starve Together

diff --git a/dont-starve-together/template.yaml b/dont-starve-together/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 apiVersion: gameplane.local/v1alpha1
 kind: GameTemplate
 metadata:

diff --git a/enshrouded/module.yaml b/enshrouded/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: enshrouded
 displayName: Enshrouded

diff --git a/enshrouded/template.yaml b/enshrouded/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 apiVersion: gameplane.local/v1alpha1
 kind: GameTemplate
 metadata:

diff --git a/factorio/module.yaml b/factorio/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: factorio
 displayName: Factorio (Headless)

diff --git a/factorio/template.yaml b/factorio/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Factorio (headless server).
 #
 # Backed by the official-community factoriotools/factorio image. The game

diff --git a/garrys-mod/module.yaml b/garrys-mod/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: garrys-mod
 displayName: Garry's Mod

diff --git a/garrys-mod/template.yaml b/garrys-mod/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Garry's Mod (dedicated server).
 #
 # Backed by ceifa/garrysmod (https://github.com/ceifa/garrysmod-docker). The

diff --git a/minecraft-java/module.yaml b/minecraft-java/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: minecraft-java
 displayName: Minecraft (Java Edition)

diff --git a/minecraft-java/template.yaml b/minecraft-java/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Minecraft: Java Edition.
 #
 # Backed by the community itzg/minecraft-server image, which downloads the

diff --git a/palworld/module.yaml b/palworld/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: palworld
 displayName: Palworld (Dedicated)

diff --git a/palworld/template.yaml b/palworld/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Palworld (dedicated server).
 #
 # Backed by the community thijsvanloef/palworld-server-docker image. The

diff --git a/project-zomboid/module.yaml b/project-zomboid/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: project-zomboid
 displayName: Project Zomboid

diff --git a/project-zomboid/template.yaml b/project-zomboid/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Project Zomboid (dedicated server).
 #
 # Backed by sknnr/zomboid-dedicated-server (https://github.com/jsknnr/project-

diff --git a/rust/module.yaml b/rust/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: rust
 displayName: Rust

diff --git a/rust/template.yaml b/rust/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Rust (dedicated server).
 #
 # Backed by didstopia/rust-server. Rust's RCON is WebSocket-only — Facepunch's

diff --git a/satisfactory/module.yaml b/satisfactory/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: satisfactory
 displayName: Satisfactory (Dedicated)

diff --git a/satisfactory/template.yaml b/satisfactory/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Satisfactory (dedicated server).
 #
 # Backed by the community wolveix/satisfactory-server image, which installs

diff --git a/terraria/module.yaml b/terraria/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: terraria
 displayName: Terraria

diff --git a/terraria/template.yaml b/terraria/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Terraria (vanilla + tModLoader).
 #
 # Backed by passivelemon/terraria-docker. Vanilla vs tModLoader (and the

diff --git a/v-rising/module.yaml b/v-rising/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: v-rising
 displayName: V Rising

diff --git a/v-rising/template.yaml b/v-rising/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for V Rising (dedicated server).
 #
 # Backed by trueosiris/vrising (Ubuntu + Wine). The image documents two

diff --git a/valheim/module.yaml b/valheim/module.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/module.schema.json
 apiVersion: gameplane.local/module/v1
 name: valheim
 displayName: Valheim (Dedicated)

diff --git a/valheim/template.yaml b/valheim/template.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=../.schema/gametemplate.schema.json
 # Gameplane GameTemplate for Valheim (dedicated server).
 #
 # Backed by lloesche/valheim-server, which installs the game via SteamCMD on