optolith-database-schema 0.2.2 → 0.3.0

package/schema/equipment/item/_MeleeWeapon.schema.json

@@ -0,0 +1,166 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/_MeleeWeapon.schema.json",
+  "$defs": {
+    "AttackModifier": {
+      "description": "The AT modifier.",
+      "type": "integer"
+    },
+    "ParryModifier": {
+      "description": "The PA modifier.",
+      "type": "integer"
+    },
+    "Reach": {
+      "description": "The reach of the weapon.",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The identifier of the weapon's reach.",
+          "type": "integer",
+          "maximum": 4,
+          "minimum": 1
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "additionalProperties": false
+    },
+    "MeleeDamage": {
+      "description": "The damage of a weapon consists of a random part using dice and an optional\nflat part.",
+      "type": "object",
+      "properties": {
+        "dice": {
+          "description": "How many dice of which type are rolled to get the damage.",
+          "$ref": "../../_Dice.schema.json#/$defs/Dice"
+        },
+        "flat": {
+          "description": "Flat damage, if any. It gets added to the result of the dice rolls.",
+          "type": "integer",
+          "default": 0
+        }
+      },
+      "required": [
+        "dice"
+      ],
+      "additionalProperties": false
+    },
+    "ShieldSize": {
+      "description": "The shield size and potential size-depending values.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Small"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Medium"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Large"
+            },
+            "large": {
+              "$ref": "#/$defs/LargeShieldSize"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "LargeShieldSize": {
+      "type": "object",
+      "properties": {
+        "attack_penalty": {
+          "description": "The attack penalty from the shield.",
+          "type": "integer",
+          "default": 1
+        }
+      },
+      "required": [
+        "attack_penalty"
+      ],
+      "additionalProperties": false
+    },
+    "MeleeWeapon": {
+      "title": "Melee Weapon",
+      "type": "object",
+      "properties": {
+        "combat_technique": {
+          "description": "The combat techniques and dependent values.",
+          "$ref": "../../_SimpleReferences.schema.json#/$defs/CloseCombatTechniqueReference"
+        },
+        "damage": {
+          "description": "The damage of a weapon consists of a random part using dice and an optional\nflat part.",
+          "$ref": "#/$defs/MeleeDamage"
+        },
+        "damage_threshold": {
+          "description": "The primary attribute damage and threshold value.",
+          "$ref": "./_Weapon.schema.json#/$defs/PrimaryAttributeDamageThreshold"
+        },
+        "at": {
+          "description": "The AT modifier.",
+          "$ref": "#/$defs/AttackModifier"
+        },
+        "pa": {
+          "description": "The PA modifier.",
+          "$ref": "#/$defs/ParryModifier"
+        },
+        "reach": {
+          "description": "The reach of the weapon.",
+          "$ref": "#/$defs/Reach"
+        },
+        "length": {
+          "description": "The length of the weapon in cm/halffingers.",
+          "$ref": "./_Weapon.schema.json#/$defs/Length"
+        },
+        "size": {
+          "description": "The shield size and potential size-depending values.",
+          "$ref": "#/$defs/ShieldSize"
+        },
+        "is_parrying_weapon": {
+          "description": "Is the weapon a parrying weapon?",
+          "type": "boolean"
+        },
+        "is_two_handed_weapon": {
+          "description": "Is the weapon a two-handed weapon?",
+          "type": "boolean"
+        },
+        "is_improvised_weapon": {
+          "description": "Is the weapon an improvised weapon?",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "combat_technique",
+        "damage",
+        "at",
+        "is_parrying_weapon",
+        "is_two_handed_weapon",
+        "is_improvised_weapon"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/_RangedWeapon.schema.json

@@ -0,0 +1,172 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/_RangedWeapon.schema.json",
+  "$defs": {
+    "RangedDamage": {
+      "description": "The damage of a ranged weapon. It consists of a random part using dice and an\noptional flat part ny default. Some ranged weapons may work different so that\ndamage is either not applicable at all or it is outlined as *Special* and\nfurther defined in a description.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Default"
+            },
+            "default": {
+              "$ref": "#/$defs/DefaultRangedDamage"
+            }
+          },
+          "required": [
+            "tag",
+            "default"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "NotApplicable"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Special"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "DefaultRangedDamage": {
+      "description": "The damage of a weapon consists of a random part using dice and an optional\nflat part.",
+      "type": "object",
+      "properties": {
+        "dice": {
+          "description": "How many dice of which type are rolled to get the damage.",
+          "$ref": "../../_Dice.schema.json#/$defs/Dice"
+        },
+        "flat": {
+          "description": "Flat damage, if any. It gets added to the result of the dice rolls.",
+          "type": "integer",
+          "default": 0
+        }
+      },
+      "required": [
+        "dice"
+      ],
+      "additionalProperties": false
+    },
+    "RangedWeapon": {
+      "title": "Ranged Weapon",
+      "type": "object",
+      "properties": {
+        "combat_technique": {
+          "description": "The combat techniques and dependent values.",
+          "$ref": "../../_SimpleReferences.schema.json#/$defs/RangedCombatTechniqueReference"
+        },
+        "damage": {
+          "description": "The damage of a weapon consists of a random part using dice and an optional\nflat part.",
+          "$ref": "#/$defs/RangedDamage"
+        },
+        "reload_time": {
+          "description": "One or multiple reload times.",
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/ReloadTime"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        },
+        "range": {
+          "description": "The range brackets for the weapon: close, medium, far. Distances in m.",
+          "$ref": "#/$defs/Range"
+        },
+        "ammunition": {
+          "description": "The needed ammunition.",
+          "$ref": "#/$defs/AmmunitionReference"
+        },
+        "length": {
+          "description": "The length of the weapon in cm/halffingers.",
+          "$ref": "./_Weapon.schema.json#/$defs/Length"
+        },
+        "is_improvised_weapon": {
+          "description": "Is the weapon an improvised weapon?",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "combat_technique",
+        "damage",
+        "reload_time",
+        "range",
+        "length",
+        "is_improvised_weapon"
+      ],
+      "additionalProperties": false
+    },
+    "AmmunitionReference": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The item's identifier.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "additionalProperties": false
+    },
+    "Range": {
+      "type": "object",
+      "properties": {
+        "close": {
+          "description": "The close range bracket for the weapon. Distance in m.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "medium": {
+          "description": "The medium range bracket for the weapon. Distance in m.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "far": {
+          "description": "The far range bracket for the weapon. Distance in m.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "close",
+        "medium",
+        "far"
+      ],
+      "additionalProperties": false
+    },
+    "ReloadTime": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "A reload time value in actions.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/_Weapon.schema.json

@@ -0,0 +1,99 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/_Weapon.schema.json",
+  "$defs": {
+    "PrimaryAttributeDamageThreshold": {
+      "description": "The primary attribute damage and threshold value. You can either use an\ninteger, an object or a pair. Use an integer if you just have to define a\nsingle threshold value for the default primary attribute of the combat\ntechnique. Use an object if you need to define the value only or if you need\nto define the value as well as a single different primary attribute than\nwhich the combat technique uses. Use the pair if you need to set the primary\nattributes to AGI and STR (the combat technique has AGI but this item has\nAGI/STR) and/or if you need to set different thresholds for AGI and STR (e.g.\nAGI 14/STR 15). If the same values are in the pair, they will be merged (AGI\n14/STR 14 will be AGI/STR 14).",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Default"
+            },
+            "default": {
+              "$ref": "#/$defs/DefaultPrimaryAttributeDamageThreshold"
+            }
+          },
+          "required": [
+            "tag",
+            "default"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "List"
+            },
+            "list": {
+              "$ref": "#/$defs/PrimaryAttributeDamageThresholdList"
+            }
+          },
+          "required": [
+            "tag",
+            "list"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "DefaultPrimaryAttributeDamageThreshold": {
+      "type": "object",
+      "properties": {
+        "threshold": {
+          "description": "The attribute value representing the damage threshold for the primary\nattribute of the item's combat technique.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "threshold"
+      ],
+      "additionalProperties": false
+    },
+    "PrimaryAttributeDamageThresholdList": {
+      "type": "object",
+      "properties": {
+        "list": {
+          "description": "A list of primary attributes with their associated threshold.",
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/SinglePrimaryAttributeDamageThreshold"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        }
+      },
+      "required": [
+        "list"
+      ],
+      "additionalProperties": false
+    },
+    "SinglePrimaryAttributeDamageThreshold": {
+      "type": "object",
+      "properties": {
+        "attribute": {
+          "description": "The primary attribute.",
+          "$ref": "../../_SimpleReferences.schema.json#/$defs/AttributeReference"
+        },
+        "threshold": {
+          "description": "The attribute value representing the damage threshold.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "attribute",
+        "threshold"
+      ],
+      "additionalProperties": false
+    },
+    "Length": {
+      "description": "The length of the weapon in cm/halffingers.",
+      "type": "integer",
+      "minimum": 1
+    }
+  }
+}

package/schema/equipment/item/sub/ArmorType.schema.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/sub/ArmorType.schema.json",
+  "$ref": "#/$defs/ArmorType",
+  "$defs": {
+    "ArmorType": {
+      "title": "Armor Type",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The armor type's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "sturdiness_rating": {
+          "description": "Each armor type has a *sturdiness rating*. The higher the rating, the more\ndurable the armor. Rolling higher than this rating during a sturdiness\ncheck means the armor receives one level of the new condition *Wear*.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/ArmorTypeTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "sturdiness_rating",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "ArmorTypeTranslation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The name of the armor type.",
+          "$ref": "../../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/{Reach.schema.json → item/sub/Reach.schema.json}

@@ -1,8 +1,8 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "/equipment/Reach.schema.json",
-  "$ref": "#/definitions/Reach",
-  "definitions": {
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/sub/Reach.schema.json",
+  "$ref": "#/$defs/Reach",
+  "$defs": {
     "Reach": {
       "title": "Reach",
       "type": "object",
@@ -17,18 +17,7 @@
           "type": "object",
           "patternProperties": {
             "^[a-z]{2}-[A-Z]{2}$": {
-              "type": "object",
-              "properties": {
-                "name": {
-                  "description": "The name of the reach.",
-                  "type": "string",
-                  "minLength": 1
-                }
-              },
-              "required": [
-                "name"
-              ],
-              "additionalProperties": false
+              "$ref": "#/$defs/ReachTranslation"
             }
           },
           "minProperties": 1,
@@ -40,6 +29,19 @@
         "translations"
       ],
       "additionalProperties": false
+    },
+    "ReachTranslation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The name of the reach.",
+          "$ref": "../../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
     }
   }
 }