optolith-database-schema 0.2.4 → 0.4.1

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

@@ -0,0 +1,309 @@
+{
+  "$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",
+            "head"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Torso"
+            },
+            "torso": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "torso"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Arms"
+            },
+            "arms": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "arms"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Legs"
+            },
+            "legs": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "legs"
+          ],
+          "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": [],
+      "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,53 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/BandageOrRemedy.schema.json",
+  "$ref": "#/$defs/BandageOrRemedy",
+  "$defs": {
+    "BandageOrRemedy": {
+      "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"
+        },
+        "structure_points": {
+          "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.",
+          "$ref": "./_Item.schema.json#/$defs/StructurePoints"
+        },
+        "combat_use": {
+          "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.",
+          "$ref": "./_Item.schema.json#/$defs/CombatUse"
+        },
+        "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",
+        "weight",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/Book.schema.json

@@ -0,0 +1,89 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/Book.schema.json",
+  "$ref": "#/$defs/Book",
+  "$defs": {
+    "Book": {
+      "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"
+        },
+        "structure_points": {
+          "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.",
+          "$ref": "./_Item.schema.json#/$defs/StructurePoints"
+        },
+        "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/BookTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "weight",
+        "complexity",
+        "structure_points",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "BookTranslation": {
+      "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"
+        },
+        "language": {
+          "description": "The language the book is written in.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "script": {
+          "description": "The script that was used for the book.",
+          "$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"
+        },
+        "errata": {
+          "$ref": "../../source/_Erratum.schema.json#/$defs/Errata"
+        }
+      },
+      "required": [
+        "name",
+        "language",
+        "script"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/CeremonialItem.schema.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/CeremonialItem.schema.json",
+  "$ref": "#/$defs/CeremonialItem",
+  "$defs": {
+    "CeremonialItem": {
+      "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"
+        },
+        "structure_points": {
+          "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.",
+          "$ref": "./_Item.schema.json#/$defs/StructurePoints"
+        },
+        "associated_tradition": {
+          "description": "The deity associated with the equipment item.",
+          "$ref": "../../_SimpleReferences.schema.json#/$defs/BlessedTraditionReference"
+        },
+        "combat_use": {
+          "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.",
+          "$ref": "./_Item.schema.json#/$defs/CombatUse"
+        },
+        "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",
+        "weight",
+        "structure_points",
+        "associated_tradition",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/Clothes.schema.json

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

package/schema/equipment/item/Container.schema.json

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

package/schema/equipment/item/EquipmentOfBlessedOnes.schema.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/EquipmentOfBlessedOnes.schema.json",
+  "$ref": "#/$defs/EquipmentOfBlessedOnes",
+  "$defs": {
+    "EquipmentOfBlessedOnes": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers.",
+          "$ref": "./_Item.schema.json#/$defs/Cost"
+        },
+        "structure_points": {
+          "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.",
+          "$ref": "./_Item.schema.json#/$defs/StructurePoints"
+        },
+        "associated_tradition": {
+          "description": "The deity associated with the equipment item.",
+          "$ref": "../../_SimpleReferences.schema.json#/$defs/BlessedTraditionReference"
+        },
+        "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",
+        "structure_points",
+        "associated_tradition",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/GemOrPreciousStone.schema.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/GemOrPreciousStone.schema.json",
+  "$ref": "#/$defs/GemOrPreciousStone",
+  "$defs": {
+    "GemOrPreciousStone": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers per 10 karat.",
+          "$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/GemOrPreciousStoneTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "GemOrPreciousStoneTranslation": {
+      "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"
+        },
+        "color": {
+          "description": "The color of the gem or stone.",
+          "$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"
+        },
+        "errata": {
+          "$ref": "../../source/_Erratum.schema.json#/$defs/Errata"
+        }
+      },
+      "required": [
+        "name",
+        "color"
+      ],
+      "additionalProperties": false
+    }
+  }
+}