optolith-database-schema 0.2.2 → 0.3.0

package/schema/equipment/item/Weapon.schema.json

@@ -0,0 +1,265 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/Weapon.schema.json",
+  "$ref": "#/$defs/Weapon",
+  "$defs": {
+    "Weapon": {
+      "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"
+        },
+        "uses": {
+          "description": "A list of stat blocks for each combat technique this weapon can be used\nwith.",
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/WeaponUse"
+          },
+          "minItems": 1
+        },
+        "sanctified_by": {
+          "description": "If the weapon is sanctified by a god and thus restricted to it's Blessed\nOnes.",
+          "$ref": "#/$defs/SanctifiedBy"
+        },
+        "restricted_to_cultures": {
+          "description": "Define if during character creation this weapon can only be bought by\ncharacters of a specific race or culture.",
+          "$ref": "#/$defs/RestrictedToCultures"
+        },
+        "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/WeaponTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "weight",
+        "complexity",
+        "uses",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "WeaponTranslation": {
+      "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 weapon advantage text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "disadvantage": {
+          "description": "The weapon disadvantage text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "errata": {
+          "$ref": "../../source/_Erratum.schema.json#/$defs/Errata"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "ImprovisedWeapon": {
+      "type": "object",
+      "properties": {
+        "uses": {
+          "description": "A list of stat blocks for each combat technique this weapon can be used\nwith.",
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/WeaponUse"
+          },
+          "minItems": 1
+        },
+        "sanctified_by": {
+          "description": "If the weapon is sanctified by a god and thus restricted to it's Blessed\nOnes.",
+          "$ref": "#/$defs/SanctifiedBy"
+        },
+        "restricted_to_cultures": {
+          "description": "Define if during character creation this weapon can only be bought by\ncharacters of a specific race or culture.",
+          "$ref": "#/$defs/RestrictedToCultures"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/ImprovisedWeaponTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "uses"
+      ],
+      "additionalProperties": false
+    },
+    "ImprovisedWeaponTranslation": {
+      "type": "object",
+      "properties": {
+        "advantage": {
+          "description": "The weapon advantage text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "disadvantage": {
+          "description": "The weapon disadvantage text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        }
+      },
+      "required": [],
+      "minProperties": 1,
+      "additionalProperties": false
+    },
+    "WeaponUse": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "An increasing integer for use identification.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "values": {
+          "$ref": "#/$defs/WeaponUseValues"
+        }
+      },
+      "required": [
+        "id",
+        "values"
+      ],
+      "additionalProperties": false
+    },
+    "WeaponUseValues": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Melee"
+            },
+            "melee": {
+              "$ref": "./_MeleeWeapon.schema.json#/$defs/MeleeWeapon"
+            }
+          },
+          "required": [
+            "tag",
+            "melee"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Ranged"
+            },
+            "ranged": {
+              "$ref": "./_RangedWeapon.schema.json#/$defs/RangedWeapon"
+            }
+          },
+          "required": [
+            "tag",
+            "ranged"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "SanctifiedBy": {
+      "description": "If the weapon is sanctified by a god and thus restricted to it's Blessed\nOnes.",
+      "$ref": "../../_SimpleReferences.schema.json#/$defs/BlessedTraditionReference"
+    },
+    "RestrictedToCultures": {
+      "description": "Define if during character creation this weapon can only be bought by\ncharacters of a specific race or culture.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "CulturesOfRace"
+            },
+            "cultures_of_race": {
+              "$ref": "../../_SimpleReferences.schema.json#/$defs/RaceReference"
+            }
+          },
+          "required": [
+            "tag",
+            "cultures_of_race"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Cultures"
+            },
+            "cultures": {
+              "$ref": "#/$defs/RestrictedToSpecificCultures"
+            }
+          },
+          "required": [
+            "tag",
+            "cultures"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "RestrictedToSpecificCultures": {
+      "type": "object",
+      "properties": {
+        "list": {
+          "type": "array",
+          "items": {
+            "$ref": "../../_SimpleReferences.schema.json#/$defs/CultureReference"
+          }
+        }
+      },
+      "required": [
+        "list"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/WeaponAccessory.schema.json

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

package/schema/equipment/item/_Item.schema.json

@@ -0,0 +1,361 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/_Item.schema.json",
+  "$defs": {
+    "DefaultItem": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers.",
+          "$ref": "#/$defs/Cost"
+        },
+        "weight": {
+          "description": "The weight in kg.",
+          "$ref": "#/$defs/Weight"
+        },
+        "complexity": {
+          "description": "The complexity of crafting the item.",
+          "$ref": "#/$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": "#/$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": "#/$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": "#/$defs/DefaultItemTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "weight",
+        "structure_points",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "CombatUse": {
+      "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.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ImprovisedWeapon"
+            },
+            "improvised_weapon": {
+              "$ref": "./Weapon.schema.json#/$defs/ImprovisedWeapon"
+            }
+          },
+          "required": [
+            "tag",
+            "improvised_weapon"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Armor"
+            },
+            "armor": {
+              "$ref": "./Armor.schema.json#/$defs/SecondaryArmor"
+            }
+          },
+          "required": [
+            "tag",
+            "armor"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "DefaultItemTranslation": {
+      "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"
+        },
+        "errata": {
+          "$ref": "../../source/_Erratum.schema.json#/$defs/Errata"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "StructurePoints": {
+      "title": "Structure Points",
+      "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.",
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/StructurePointsComponent"
+      },
+      "minItems": 1
+    },
+    "StructurePointsComponent": {
+      "type": "object",
+      "properties": {
+        "points": {
+          "description": "The structure points.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "points"
+      ],
+      "additionalProperties": false
+    },
+    "Cost": {
+      "description": "The cost in silverthalers.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Free"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Various"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": ""
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": ""
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Fixed"
+            },
+            "fixed": {
+              "$ref": "#/$defs/FixedCost"
+            }
+          },
+          "required": [
+            "tag",
+            "fixed"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Range"
+            },
+            "range": {
+              "$ref": "#/$defs/CostRange"
+            }
+          },
+          "required": [
+            "tag",
+            "range"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "FixedCost": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "The cost in silverthalers.",
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/CostTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false
+    },
+    "CostRange": {
+      "type": "object",
+      "properties": {
+        "from": {
+          "description": "The lower bound of the cost in silverthalers.",
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "to": {
+          "description": "The upper bound of the cost in silverthalers.",
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/CostTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "from",
+        "to"
+      ],
+      "additionalProperties": false
+    },
+    "CostTranslation": {
+      "type": "object",
+      "properties": {
+        "wrap_in_text": {
+          "description": "The cost get wrapped by this text using a placeholder in the text.",
+          "type": "string",
+          "minLength": 1,
+          "pattern": "\\\\{0\\\\}"
+        }
+      },
+      "required": [
+        "wrap_in_text"
+      ],
+      "additionalProperties": false
+    },
+    "Weight": {
+      "description": "The weight in kg.",
+      "type": "number",
+      "exclusiveMinimum": 0
+    },
+    "Complexity": {
+      "description": "The complexity of crafting the item.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Primitive"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Simple"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Complex"
+            },
+            "complex": {
+              "$ref": "#/$defs/ComplexComplexity"
+            }
+          },
+          "required": [
+            "tag",
+            "complex"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "ComplexComplexity": {
+      "type": "object",
+      "properties": {
+        "ap_value": {
+          "description": "The AP value for the trade secret.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "ap_value"
+      ],
+      "additionalProperties": false
+    }
+  }
+}