Control: Add descriptions to board sizes

AbstractPlay · Feb 10, 2025 · 312d7a4 · 312d7a4
1 parent a96a98c
commit 312d7a4
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/locales/en/apgames.json b/locales/en/apgames.json
@@ -667,7 +667,8 @@
         },
         "control": {
             "size-5": {
-                "name": "Small board (Size 5)"
+                "name": "Small board (Size 5)",
+                "description": "Ideal for learning the rules"
             },
             "size-9": {
                 "name": "Large board (Size 9)"
@@ -1979,7 +1980,8 @@
         },
         "control": {
             "board": {
-                "name": "board (Size 7)"
+                "name": "board (Size 7)",
+                "description": "Ideal for experienced players"
             }
         },
         "courtesan": {

diff --git a/src/schemas/gameinfo.d.ts b/src/schemas/gameinfo.d.ts
@@ -47,6 +47,10 @@ export interface APGamesInformation {
    * The people and organizations involved in the game's creation
    */
   people?: Person[];
+  /**
+   * A succinct, plain text description of the ruleset of the base, "no variants provided" game. Often most useful when there are many variant choices.
+   */
+  defaults?: string;
   /**
    * A list of supported variants
    */

diff --git a/src/schemas/gameinfo.json b/src/schemas/gameinfo.json
@@ -118,6 +118,10 @@
                 "$ref": "#/definitions/person"
             }
         },
+        "defaults": {
+            "description": "A succinct, plain text description of the ruleset of the base, \"no variants provided\" game. Often most useful when there are many variant choices.",
+            "type": "string"
+        },
         "variants": {
             "description": "A list of supported variants",
             "type": "array",