Validate scenarios against json schema

.github/workflows/scenario-schema.yml

@@ -0,0 +1,28 @@
+name: Validate scenarios against schema
+on:
+  push:
+    paths:
+      - 'data/scenarios/**.yaml'
+    branches:
+      - main
+  pull_request:
+    paths:
+      - 'data/scenarios/**.yaml'
+    branches:
+      - main
+jobs:
+  validate-scenario-schema:
+    name: Validate scenarios schema
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install check-jsonschema
+      - run: |
+          find data/scenarios -name "*.yaml" -type f -print0 | xargs -0 check-jsonschema --base-uri $(git rev-parse --show-toplevel)/data/schema/scenario.json --schemafile data/schema/scenario.json

data/scenarios/Challenges/Ranching/gated-paddock.yaml

@@ -356,8 +356,8 @@ robots:
       - [0, gate]
       - [10, hinge]
   - name: sheep
-    description:
-      - meandering livestock
+    description: |
+      meandering livestock
     display:
       invisible: false
       char: '@'

data/scenarios/Testing/_Validation/1221-duplicate-entities.yaml

@@ -14,6 +14,7 @@ entities:
       char: 'Y'
     description:
       - Your scooter
+robots: []
 world:
   palette:
     'x': [grass, null, base]

data/schema/combustion.json

@@ -26,7 +26,7 @@
         },
         "product": {
             "default": "ash",
-            "type": "string",
+            "type": ["string", "null"],
             "description": "What entity, if any, is left over after combustion"
         }
     }

data/schema/cosmicloc.json

@@ -0,0 +1,14 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/cosmicloc.json",
+    "title": "Cosmic location",
+    "description": "Planar location plus subworld",
+    "type": "object",
+    "properties": {
+        "subworld": {
+            "type": "string",
+            "description": "Name of subworld"
+        },
+        "loc": {"$ref": "./planarloc.json"}
+    }
+}

data/schema/entities.json

@@ -14,7 +14,7 @@
             },
             "display": {
                 "type": "object",
-                "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/display.json",
+                "$ref": "./display.json",
                 "description": "Display information for the entity."
             },
             "plural": {
@@ -63,7 +63,7 @@
             },
             "combustion": {
                 "type": "object",
-                "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/combustion.json",
+                "$ref": "./combustion.json",
                 "description": "Properties of combustion."
             },
             "yields": {

data/schema/planarloc.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/planarloc.json",
+    "title": "Cosmic location",
+    "description": "Planar location",
+    "type": "array",
+    "items": [
+        {
+            "name": "X coordinate",
+            "type": "number"
+        },
+        {
+            "name": "Y coordinate",
+            "type": "number"
+        }
+    ]
+}

data/schema/recipes.json

@@ -26,16 +26,16 @@
         ],
         "properties": {
             "in": {
-                "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/inventory.json",
+                "$ref": "./inventory.json",
                 "description": "A list of ingredients consumed by the recipe. Each ingredient is a tuple consisting of an integer and an entity name, indicating the number of copies of the given entity that are needed."
             },
             "out": {
-                "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/inventory.json",
+                "$ref": "./inventory.json",
                 "description": "A list of outputs produced by the recipe. It is a list of [count, entity name] tuples just like in."
             },
             "required": {
                 "default": [],
-                "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/inventory.json",
+                "$ref": "./inventory.json",
                 "description": "A list of catalysts required by the recipe. They are neither consumed nor produced, but must be present in order for the recipe to be carried out. It is a list of [count, entity name] tuples just like in and out."
             },
             "time": {

data/schema/robot.json

@@ -15,19 +15,11 @@
             "description": "A description of the robot, given as a list of paragraphs. This is currently not used for much (perhaps not at all?)."
         },
         "loc": {
-            "default": null,
-            "type": "array",
-            "items": [
-                {
-                    "name": "X coordinate",
-                    "type": "number"
-                },
-                {
-                    "name": "Y coordinate",
-                    "type": "number"
-                }
-            ],
-            "description": "An optional (x,y) starting location for the robot. If the loc field is specified, then a concrete robot will be created at the given location. If this field is omitted, then this robot record exists only as a template which can be referenced from a cell in the world palette. Concrete robots will then be created wherever the corresponding palette character is used in the world map."
+            "description": "An optional (x,y) starting location for the robot. If the loc field is specified, then a concrete robot will be created at the given location. If this field is omitted, then this robot record exists only as a template which can be referenced from a cell in the world palette. Concrete robots will then be created wherever the corresponding palette character is used in the world map.",
+            "oneOf": [
+                {"$ref": "./cosmicloc.json"},
+                {"$ref": "./planarloc.json"}
+            ]
         },
         "dir": {
             "type": "array",
@@ -46,7 +38,7 @@
         },
         "display": {
             "default": "default",
-            "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/display.json",
+            "$ref": "./display.json",
             "description": "Display information for the robot. If this field is omitted, the default robot display will be used."
         },
         "program": {
@@ -64,7 +56,7 @@
         },
         "inventory": {
             "default": [],
-            "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/inventory.json",
+            "$ref": "./inventory.json",
             "description": "A list of [count, entity name] pairs, specifying the entities in the robot's starting inventory, and the number of each."
         },
         "system": {

data/schema/samples/combustion.yaml

@@ -0,0 +1,3 @@
+ignition: 1
+duration: [8, 8]
+product: null

data/schema/scenario.json

@@ -34,12 +34,12 @@
         "entities": {
             "description": "An optional list of custom entities, to be used in addition to the built-in entities. See description of Entities.",
             "default": [],
-            "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/entities.json"
+            "$ref": "./entities.json"
         },
         "recipes": {
             "description": "An optional list of custom recipes, to be used in addition to the built-in recipes. They can refer to built-in entities as well as custom entities. See description of Recipes.",
             "default": [],
-            "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/recipes.json"
+            "$ref": "./recipes.json"
         },
         "known": {
             "description": "A list of names of standard or custom entities which should have the Known property added to them; that is, robots should know what they are without having to scan them.",
@@ -52,13 +52,13 @@
             ]
         },
         "world": {
-            "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/world.json"
+            "$ref": "./world.json"
         },
         "robots": {
             "description": "A list of robots that will inhabit the world. See the description of Robots.",
             "type": "array",
             "items": {
-                "$ref": "https://raw.githubusercontent.com/swarm-game/swarm/main/data/schema/robot.json"
+                "$ref": "./robot.json"
             }
         },
         "objectives": {