document VS Code usage

swarm-game · Aug 28, 2023 · 815d4ba · 815d4ba
1 parent 25c7eb2
commit 815d4ba
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,13 @@
+{
+    "yaml.schemas": {
+        "https://raw.githubusercontent.com/swarm-game/swarm/feature/json-schema-fixes/data/schema/scenario.json": [
+            "data/scenarios/**/*.yaml"
+        ],
+        "https://raw.githubusercontent.com/swarm-game/swarm/feature/json-schema-fixes/data/schema/entities.json": [
+            "data/entities.yaml"
+        ],
+        "https://raw.githubusercontent.com/swarm-game/swarm/feature/json-schema-fixes/data/schema/recipes.json": [
+            "data/recipes.yaml"
+        ],
+    }
+}
diff --git a/editors/README.md b/editors/README.md
@@ -29,6 +29,26 @@ You can get it by:
 - **TBD** get the VSIX from GitHub releases
 - **TBD** installing from the VS codium free marketplace
 
+### YAML schema validation
+
+To configure JSON editor windows for schema validation, install the [YAML plugin](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) and add the following to `.vscode/settings.json` under the workspace root:
+
+```json
+{
+    "yaml.schemas": {
+        "https://raw.githubusercontent.com/swarm-game/swarm/feature/json-schema-fixes/data/schema/scenario.json": [
+            "data/scenarios/**/*.yaml"
+        ],
+        "https://raw.githubusercontent.com/swarm-game/swarm/feature/json-schema-fixes/data/schema/entities.json": [
+            "data/entities.yaml"
+        ],
+        "https://raw.githubusercontent.com/swarm-game/swarm/feature/json-schema-fixes/data/schema/recipes.json": [
+            "data/recipes.yaml"
+        ],
+    }
+}
+```
+
 ## Vim and Neovim
 
 Currently there is neither highlighting nor LSP support for Vim,