optolith-database-schema 0.2.2 → 0.3.0

package/schema/_Spellwork.schema.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/_Spellwork.schema.json",
+  "$defs": {
+    "Traditions": {
+      "description": "The tradition(s) the ritual is available for. It may be *generally*\navailable to all traditions or it may be only familiar in specific\ntraditions.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "General"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Specific"
+            },
+            "specific": {
+              "$ref": "#/$defs/SpecificTraditions"
+            }
+          },
+          "required": [
+            "tag",
+            "specific"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "SpecificTraditions": {
+      "description": "A list of specific traditions.",
+      "type": "array",
+      "items": {
+        "$ref": "./_Identifier.schema.json#/$defs/MagicalTraditionIdentifier"
+      },
+      "minItems": 1
+    }
+  }
+}

package/schema/equipment/EquipmentPackage.schema.json

@@ -1,8 +1,8 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
   "$id": "/equipment/EquipmentPackage.schema.json",
-  "$ref": "#/definitions/EquipmentPackage",
-  "definitions": {
+  "$ref": "#/$defs/EquipmentPackage",
+  "$defs": {
     "EquipmentPackage": {
       "title": "Equipment Package",
       "type": "object",
@@ -16,23 +16,7 @@
           "description": "All items in the package. You have to provide the item (template)\nidentifier and you can optionally provide the number of how often an item\nis included in the package.",
           "type": "array",
           "items": {
-            "type": "object",
-            "properties": {
-              "id": {
-                "description": "The item's identifier.",
-                "type": "integer",
-                "minimum": 1
-              },
-              "number": {
-                "description": "The number of how often the item is included in the package.",
-                "type": "integer",
-                "minimum": 2
-              }
-            },
-            "required": [
-              "id"
-            ],
-            "additionalProperties": false
+            "$ref": "#/$defs/EquipmentPackageItem"
           },
           "minItems": 2
         },
@@ -41,18 +25,7 @@
           "type": "object",
           "patternProperties": {
             "^[a-z]{2}-[A-Z]{2}$": {
-              "type": "object",
-              "properties": {
-                "name": {
-                  "description": "The name of the equipment package.",
-                  "type": "string",
-                  "minLength": 1
-                }
-              },
-              "required": [
-                "name"
-              ],
-              "additionalProperties": false
+              "$ref": "#/$defs/EquipmentPackageTranslation"
             }
           },
           "minProperties": 1,
@@ -65,6 +38,38 @@
         "translations"
       ],
       "additionalProperties": false
+    },
+    "EquipmentPackageItem": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The item's identifier.",
+          "$ref": "../_Identifier.schema.json#/$defs/EquipmentIdentifier"
+        },
+        "number": {
+          "description": "The number of how often the item is included in the package.",
+          "type": "integer",
+          "default": 1,
+          "minimum": 2
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "additionalProperties": false
+    },
+    "EquipmentPackageTranslation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The name of the equipment package.",
+          "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
     }
   }
 }

package/schema/equipment/item/Alchemicum.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/Alchemicum.schema.json",
+  "$ref": "#/$defs/Alchemicum",
+  "$defs": {
+    "Alchemicum": {
+      "$ref": "./_Item.schema.json#/$defs/DefaultItem"
+    }
+  }
+}

package/schema/equipment/item/Ammunition.schema.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/Ammunition.schema.json",
+  "$ref": "#/$defs/Ammunition",
+  "$defs": {
+    "Ammunition": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers.",
+          "$ref": "./_Item.schema.json#/$defs/Cost"
+        },
+        "src": {
+          "$ref": "../../source/_PublicationRef.schema.json#/$defs/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/AmmunitionTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "AmmunitionTranslation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The name of the item.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "secondary_name": {
+          "description": "An auxiliary name or label of the item, if available.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "errata": {
+          "$ref": "../../source/_Erratum.schema.json#/$defs/Errata"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/Animal.schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/Animal.schema.json",
+  "$ref": "#/$defs/Animal",
+  "$defs": {
+    "Animal": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers.",
+          "$ref": "./_Item.schema.json#/$defs/Cost"
+        },
+        "src": {
+          "$ref": "../../source/_PublicationRef.schema.json#/$defs/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "./_Item.schema.json#/$defs/DefaultItemTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/AnimalCare.schema.json

@@ -0,0 +1,124 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/AnimalCare.schema.json",
+  "$ref": "#/$defs/AnimalCare",
+  "$defs": {
+    "AnimalCare": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "description": "Values depending on whether the animal care is feed.",
+          "$ref": "#/$defs/AnimalCareType"
+        },
+        "src": {
+          "$ref": "../../source/_PublicationRef.schema.json#/$defs/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "./_Item.schema.json#/$defs/DefaultItemTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "type",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "AnimalCareType": {
+      "description": "Values depending on whether the animal care is feed.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "General"
+            },
+            "general": {
+              "$ref": "#/$defs/GeneralAnimalCare"
+            }
+          },
+          "required": [
+            "tag",
+            "general"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Feed"
+            },
+            "feed": {
+              "$ref": "#/$defs/AnimalFeed"
+            }
+          },
+          "required": [
+            "tag",
+            "feed"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "GeneralAnimalCare": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers.",
+          "$ref": "./_Item.schema.json#/$defs/Cost"
+        },
+        "weight": {
+          "description": "The weight in kg.",
+          "$ref": "./_Item.schema.json#/$defs/Weight"
+        }
+      },
+      "required": [
+        "cost",
+        "weight"
+      ],
+      "additionalProperties": false
+    },
+    "AnimalFeed": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers.",
+          "$ref": "#/$defs/AnimalFeedCost"
+        }
+      },
+      "required": [
+        "cost"
+      ],
+      "additionalProperties": false
+    },
+    "AnimalFeedCost": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "PerWeek"
+            },
+            "per_week": {
+              "$ref": "./_Item.schema.json#/$defs/FixedCost"
+            }
+          },
+          "required": [
+            "tag",
+            "per_week"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  }
+}

package/schema/equipment/item/Armor.schema.json

@@ -0,0 +1,288 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/Armor.schema.json",
+  "$ref": "#/$defs/Armor",
+  "$defs": {
+    "Armor": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers.",
+          "$ref": "./_Item.schema.json#/$defs/Cost"
+        },
+        "weight": {
+          "description": "The weight in kg.",
+          "$ref": "./_Item.schema.json#/$defs/Weight"
+        },
+        "complexity": {
+          "description": "The complexity of crafting the item.",
+          "$ref": "./_Item.schema.json#/$defs/Complexity"
+        },
+        "protection": {
+          "description": "The PRO value.",
+          "$ref": "#/$defs/Protection"
+        },
+        "encumbrance": {
+          "description": "The ENC value.",
+          "$ref": "#/$defs/Encumbrance"
+        },
+        "has_additional_penalties": {
+          "description": "Does the armor have additional penalties (MOV -1, INI -1)?",
+          "$ref": "#/$defs/HasAdditionalPenalties"
+        },
+        "armor_type": {
+          "description": "The armor type.",
+          "$ref": "#/$defs/ArmorType"
+        },
+        "hit_zone": {
+          "description": "Specify if armor is only available for a specific hit zone.",
+          "$ref": "#/$defs/HitZone"
+        },
+        "src": {
+          "$ref": "../../source/_PublicationRef.schema.json#/$defs/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/ArmorTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "weight",
+        "complexity",
+        "protection",
+        "encumbrance",
+        "has_additional_penalties",
+        "armor_type",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "ArmorTranslation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The name of the item.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "secondary_name": {
+          "description": "An auxiliary name or label of the item, if available.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "note": {
+          "description": "Note text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "rules": {
+          "description": "Special rules text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "advantage": {
+          "description": "The armor advantage text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "disadvantage": {
+          "description": "The armor disadvantage text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "errata": {
+          "$ref": "../../source/_Erratum.schema.json#/$defs/Errata"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "minProperties": 1,
+      "additionalProperties": false
+    },
+    "SecondaryArmor": {
+      "type": "object",
+      "properties": {
+        "protection": {
+          "description": "The PRO value.",
+          "$ref": "#/$defs/Protection"
+        },
+        "encumbrance": {
+          "description": "The ENC value.",
+          "$ref": "#/$defs/Encumbrance"
+        },
+        "has_additional_penalties": {
+          "description": "Does the armor have additional penalties (MOV -1, INI -1)?",
+          "$ref": "#/$defs/HasAdditionalPenalties"
+        },
+        "armor_type": {
+          "description": "The armor type.",
+          "$ref": "#/$defs/ArmorType"
+        },
+        "hit_zone": {
+          "description": "Specify if armor is only available for a specific hit zone.",
+          "$ref": "#/$defs/HitZone"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/SecondaryArmorTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "protection",
+        "encumbrance",
+        "has_additional_penalties",
+        "armor_type"
+      ],
+      "additionalProperties": false
+    },
+    "SecondaryArmorTranslation": {
+      "type": "object",
+      "properties": {
+        "advantage": {
+          "description": "The armor advantage text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "disadvantage": {
+          "description": "The armor disadvantage text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        }
+      },
+      "required": [],
+      "minProperties": 1,
+      "additionalProperties": false
+    },
+    "Protection": {
+      "description": "The PRO value.",
+      "type": "integer",
+      "minimum": 0
+    },
+    "Encumbrance": {
+      "description": "The ENC value.",
+      "type": "integer",
+      "minimum": 0
+    },
+    "HasAdditionalPenalties": {
+      "description": "Does the armor have additional penalties (MOV -1, INI -1)?",
+      "type": "boolean"
+    },
+    "ArmorType": {
+      "title": "Armor Type",
+      "description": "The armor type.",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The armor type's identifier.",
+          "type": "integer",
+          "maximum": 10,
+          "minimum": 1
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "additionalProperties": false
+    },
+    "HitZone": {
+      "title": "Hit Zone",
+      "description": "Specify if armor is only available for a specific hit zone.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Head"
+            },
+            "head": {
+              "$ref": "#/$defs/HeadHitZone"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Torso"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Arms"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Legs"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "HeadHitZone": {
+      "type": "object",
+      "properties": {
+        "combination_possibilities": {
+          "description": "In some cases, multiple armors for the same hit zone can be combined.\nThey're listed at the item that can be combined with others.",
+          "$ref": "#/$defs/HeadHitZoneCombinationPossibilities"
+        }
+      },
+      "required": [],
+      "minProperties": 1,
+      "additionalProperties": false
+    },
+    "HeadHitZoneCombinationPossibilities": {
+      "type": "object",
+      "properties": {
+        "armors": {
+          "description": "A list of armors that can be combined with this armor.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_SimpleReferences.schema.json#/$defs/ArmorReference"
+          },
+          "minItems": 1
+        },
+        "protection": {
+          "description": "The PRO value that is added to the PRO value of the other armor instead\nof adding the normale PRO value.",
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "armors"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/BandageOrRemedy.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/BandageOrRemedy.schema.json",
+  "$ref": "#/$defs/BandageOrRemedy",
+  "$defs": {
+    "BandageOrRemedy": {
+      "$ref": "./_Item.schema.json#/$defs/DefaultItem"
+    }
+  }
+}