optolith-database-schema 0.1.0 → 0.1.3

package/schema/FamiliarsTrick_AnimalType.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "FamiliarsTrick_AnimalType.schema.json",
+  "$ref": "#/definitions/AnimalType",
+  "definitions": {
+    "AnimalType": {
+      "title": "Animal Type",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The animal type's identifier. An unique, increasing integer.",
+          "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}$": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The animal type name.",
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/_Activatable.schema.json

@@ -280,7 +280,251 @@
     },
     "Penalty": {
       "description": "The penalty the special ability gives when used.",
-      "const": ""
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Single"
+            },
+            "value": {
+              "description": "The penalty value.",
+              "type": "integer"
+            },
+            "applies_to_parry": {
+              "description": "Set to `true` if the penalty applies to the parry instead of the attack.",
+              "const": true
+            }
+          },
+          "required": [
+            "tag",
+            "value"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByHandedness"
+            },
+            "one_handed": {
+              "description": "The penalty value for one-handed weapons.",
+              "type": "integer"
+            },
+            "two_handed": {
+              "description": "The penalty value for two-handed weapons.",
+              "type": "integer"
+            },
+            "applies_to_parry": {
+              "description": "Set to `true` if the penalty applies to the parry instead of the attack.",
+              "const": true
+            }
+          },
+          "required": [
+            "tag",
+            "one_handed",
+            "two_handed"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByActivation"
+            },
+            "active": {
+              "description": "The penalty value if the entry has been bought by the character.",
+              "type": "integer"
+            },
+            "inactive": {
+              "description": "The penalty value if the entry has not been bought by the character.",
+              "type": "integer"
+            },
+            "applies_to_parry": {
+              "description": "Set to `true` if the penalty applies to the parry instead of the attack.",
+              "const": true
+            }
+          },
+          "required": [
+            "tag",
+            "active",
+            "inactive"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Selection"
+            },
+            "options": {
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Specific"
+                    },
+                    "list": {
+                      "description": "The list of specific penalty options.",
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "value": {
+                            "description": "The penalty value.",
+                            "type": "integer"
+                          }
+                        },
+                        "required": [
+                          "value"
+                        ],
+                        "additionalProperties": false
+                      },
+                      "minItems": 2,
+                      "uniqueItems": true
+                    }
+                  },
+                  "required": [
+                    "tag",
+                    "list"
+                  ],
+                  "additionalProperties": false
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Range"
+                    },
+                    "minimum": {
+                      "description": "The minimum penalty value.",
+                      "type": "integer"
+                    },
+                    "maximum": {
+                      "description": "The maximum penalty value.",
+                      "type": "integer"
+                    }
+                  },
+                  "required": [
+                    "tag",
+                    "minimum",
+                    "maximum"
+                  ],
+                  "additionalProperties": false
+                }
+              ]
+            }
+          },
+          "required": [
+            "tag",
+            "options"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByLevel"
+            },
+            "levels": {
+              "description": "A continuous range of penalties for each level. The first element is the\npenalty for the first level, the second element is the penalty for the\nsecond level, and so on.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "value": {
+                    "description": "The penalty value for this level.",
+                    "type": "integer"
+                  }
+                },
+                "required": [
+                  "value"
+                ],
+                "additionalProperties": false
+              },
+              "minItems": 2
+            },
+            "external_id": {
+              "description": "The identifier of the combat-related special ability of which the level\ndefines the penalty instead.",
+              "$ref": "./_Identifier.schema.json#/definitions/Identifier/Group/CombatRelatedSpecialAbility"
+            }
+          },
+          "required": [
+            "tag",
+            "levels"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByAttack"
+            },
+            "list": {
+              "description": "A list of penalties for subsequent attacks. The first element is the\npenalty for the first attack, the second element is the penalty for the\nsecond attack, and so on. The order of the first element may be changed\nusing `initial_order`, so that e.g. if set to `2`, the first element is\nthe penalty for the second attack, the second element is the penalty for\nthe third attack, and so on.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "value": {
+                    "description": "The penalty value for this order.",
+                    "type": "integer"
+                  }
+                },
+                "required": [
+                  "value"
+                ],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            },
+            "initial_order": {
+              "description": "The order of the first element in the `list` of penalties.",
+              "type": "number"
+            },
+            "attack_replacement": {
+              "description": "Set if a predefined different word should be used instead of the word\n`attack` for display purposes.",
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Throw"
+                    }
+                  },
+                  "required": [
+                    "tag"
+                  ],
+                  "additionalProperties": false
+                }
+              ]
+            }
+          },
+          "required": [
+            "tag",
+            "list"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "DependsOnHitZone"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
     },
     "ArcaneEnergyCost": {
       "description": "The AE Cost.",
@@ -506,7 +750,6 @@
         "value": {
           "description": "The referenced entry's numeric identifier.",
           "type": "integer",
-          "maximum": 8,
           "minimum": 1
         }
       },
@@ -525,7 +768,6 @@
         "value": {
           "description": "The referenced entry's numeric identifier.",
           "type": "integer",
-          "maximum": 8,
           "minimum": 1
         }
       },

package/schema/_Identifier.schema.json

@@ -54,6 +54,14 @@
             "ChronicleEnchantment"
           ]
         },
+        "CombatRelatedSpecialAbility": {
+          "enum": [
+            "CombatSpecialAbility",
+            "CombatStyleSpecialAbility",
+            "AdvancedCombatSpecialAbility",
+            "CommandSpecialAbility"
+          ]
+        },
         "Rated": {
           "enum": [
             "Attribute",
@@ -89,7 +97,24 @@
             "value": {
               "description": "The referenced entry's numeric identifier.",
               "type": "integer",
-              "maximum": 8,
+              "minimum": 1
+            }
+          },
+          "required": [
+            "tag",
+            "value"
+          ],
+          "additionalProperties": false
+        },
+        "CombatRelatedSpecialAbility": {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "$ref": "#/definitions/Identifier/Tag/CombatRelatedSpecialAbility"
+            },
+            "value": {
+              "description": "The referenced entry's numeric identifier.",
+              "type": "integer",
               "minimum": 1
             }
           },
@@ -108,7 +133,6 @@
             "value": {
               "description": "The referenced entry's numeric identifier.",
               "type": "integer",
-              "maximum": 8,
               "minimum": 1
             }
           },
@@ -127,7 +151,6 @@
             "value": {
               "description": "The referenced entry's numeric identifier.",
               "type": "integer",
-              "maximum": 8,
               "minimum": 1
             }
           },
@@ -146,7 +169,6 @@
             "value": {
               "description": "The referenced entry's numeric identifier.",
               "type": "integer",
-              "maximum": 8,
               "minimum": 1
             }
           },

package/schema/specialAbility/AdvancedCombatSpecialAbility.schema.json

@@ -8,25 +8,28 @@
       "type": "object",
       "properties": {
         "id": {
-          "$ref": "#/definitions/Id"
+          "$ref": "../_Activatable.schema.json#/definitions/Id"
         },
         "levels": {
-          "$ref": "#/definitions/Levels"
+          "$ref": "../_Activatable.schema.json#/definitions/Levels"
         },
         "usage_type": {
-          "$ref": "#/definitions/CombatSpecialAbilityType"
+          "$ref": "../_Activatable.schema.json#/definitions/CombatSpecialAbilityType"
         },
         "skill_applications": {
-          "$ref": "#/definitions/SkillApplications"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillApplications"
         },
         "skill_uses": {
-          "$ref": "#/definitions/SkillUses"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillUses"
+        },
+        "penalty": {
+          "$ref": "../_Activatable.schema.json#/definitions/Penalty"
         },
         "combat_techniques": {
-          "$ref": "#/definitions/ApplicableCombatTechniques"
+          "$ref": "../_Activatable.schema.json#/definitions/ApplicableCombatTechniques"
         },
         "ap_value": {
-          "$ref": "#/definitions/AdventurePointsValue"
+          "$ref": "../_Activatable.schema.json#/definitions/AdventurePointsValue"
         },
         "src": {
           "$ref": "../source/_PublicationRef.schema.json#/definitions/PublicationRefs"
@@ -39,13 +42,13 @@
               "type": "object",
               "properties": {
                 "name": {
-                  "$ref": "#/definitions/Name"
+                  "$ref": "../_Activatable.schema.json#/definitions/Name"
                 },
                 "name_in_library": {
-                  "$ref": "#/definitions/NameInLibrary"
+                  "$ref": "../_Activatable.schema.json#/definitions/NameInLibrary"
                 },
                 "rules": {
-                  "$ref": "#/definitions/Rules"
+                  "$ref": "../_Activatable.schema.json#/definitions/Rules"
                 },
                 "errata": {
                   "$ref": "../source/_Erratum.schema.json#/definitions/Errata"

package/schema/specialAbility/AdvancedKarmaSpecialAbility.schema.json

@@ -8,19 +8,19 @@
       "type": "object",
       "properties": {
         "id": {
-          "$ref": "#/definitions/Id"
+          "$ref": "../_Activatable.schema.json#/definitions/Id"
         },
         "levels": {
-          "$ref": "#/definitions/Levels"
+          "$ref": "../_Activatable.schema.json#/definitions/Levels"
         },
         "skill_applications": {
-          "$ref": "#/definitions/SkillApplications"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillApplications"
         },
         "skill_uses": {
-          "$ref": "#/definitions/SkillUses"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillUses"
         },
         "ap_value": {
-          "$ref": "#/definitions/AdventurePointsValue"
+          "$ref": "../_Activatable.schema.json#/definitions/AdventurePointsValue"
         },
         "src": {
           "$ref": "../source/_PublicationRef.schema.json#/definitions/PublicationRefs"
@@ -33,13 +33,13 @@
               "type": "object",
               "properties": {
                 "name": {
-                  "$ref": "#/definitions/Name"
+                  "$ref": "../_Activatable.schema.json#/definitions/Name"
                 },
                 "name_in_library": {
-                  "$ref": "#/definitions/NameInLibrary"
+                  "$ref": "../_Activatable.schema.json#/definitions/NameInLibrary"
                 },
                 "rules": {
-                  "$ref": "#/definitions/Rules"
+                  "$ref": "../_Activatable.schema.json#/definitions/Rules"
                 },
                 "errata": {
                   "$ref": "../source/_Erratum.schema.json#/definitions/Errata"

package/schema/specialAbility/AdvancedMagicalSpecialAbility.schema.json

@@ -8,19 +8,19 @@
       "type": "object",
       "properties": {
         "id": {
-          "$ref": "#/definitions/Id"
+          "$ref": "../_Activatable.schema.json#/definitions/Id"
         },
         "levels": {
-          "$ref": "#/definitions/Levels"
+          "$ref": "../_Activatable.schema.json#/definitions/Levels"
         },
         "skill_applications": {
-          "$ref": "#/definitions/SkillApplications"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillApplications"
         },
         "skill_uses": {
-          "$ref": "#/definitions/SkillUses"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillUses"
         },
         "ap_value": {
-          "$ref": "#/definitions/AdventurePointsValue"
+          "$ref": "../_Activatable.schema.json#/definitions/AdventurePointsValue"
         },
         "src": {
           "$ref": "../source/_PublicationRef.schema.json#/definitions/PublicationRefs"
@@ -33,13 +33,13 @@
               "type": "object",
               "properties": {
                 "name": {
-                  "$ref": "#/definitions/Name"
+                  "$ref": "../_Activatable.schema.json#/definitions/Name"
                 },
                 "name_in_library": {
-                  "$ref": "#/definitions/NameInLibrary"
+                  "$ref": "../_Activatable.schema.json#/definitions/NameInLibrary"
                 },
                 "rules": {
-                  "$ref": "#/definitions/Rules"
+                  "$ref": "../_Activatable.schema.json#/definitions/Rules"
                 },
                 "errata": {
                   "$ref": "../source/_Erratum.schema.json#/definitions/Errata"

package/schema/specialAbility/AdvancedSkillSpecialAbility.schema.json

@@ -8,19 +8,19 @@
       "type": "object",
       "properties": {
         "id": {
-          "$ref": "#/definitions/Id"
+          "$ref": "../_Activatable.schema.json#/definitions/Id"
         },
         "levels": {
-          "$ref": "#/definitions/Levels"
+          "$ref": "../_Activatable.schema.json#/definitions/Levels"
         },
         "skill_applications": {
-          "$ref": "#/definitions/SkillApplications"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillApplications"
         },
         "skill_uses": {
-          "$ref": "#/definitions/SkillUses"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillUses"
         },
         "ap_value": {
-          "$ref": "#/definitions/AdventurePointsValue"
+          "$ref": "../_Activatable.schema.json#/definitions/AdventurePointsValue"
         },
         "src": {
           "$ref": "../source/_PublicationRef.schema.json#/definitions/PublicationRefs"
@@ -33,13 +33,13 @@
               "type": "object",
               "properties": {
                 "name": {
-                  "$ref": "#/definitions/Name"
+                  "$ref": "../_Activatable.schema.json#/definitions/Name"
                 },
                 "name_in_library": {
-                  "$ref": "#/definitions/NameInLibrary"
+                  "$ref": "../_Activatable.schema.json#/definitions/NameInLibrary"
                 },
                 "rules": {
-                  "$ref": "#/definitions/Rules"
+                  "$ref": "../_Activatable.schema.json#/definitions/Rules"
                 },
                 "errata": {
                   "$ref": "../source/_Erratum.schema.json#/definitions/Errata"

package/schema/specialAbility/AncestorGlyph.schema.json

@@ -8,13 +8,13 @@
       "type": "object",
       "properties": {
         "id": {
-          "$ref": "#/definitions/Id"
+          "$ref": "../_Activatable.schema.json#/definitions/Id"
         },
         "levels": {
-          "$ref": "#/definitions/Levels"
+          "$ref": "../_Activatable.schema.json#/definitions/Levels"
         },
         "ap_value": {
-          "$ref": "#/definitions/AdventurePointsValue"
+          "$ref": "../_Activatable.schema.json#/definitions/AdventurePointsValue"
         },
         "src": {
           "$ref": "../source/_PublicationRef.schema.json#/definitions/PublicationRefs"
@@ -27,13 +27,13 @@
               "type": "object",
               "properties": {
                 "name": {
-                  "$ref": "#/definitions/Name"
+                  "$ref": "../_Activatable.schema.json#/definitions/Name"
                 },
                 "name_in_library": {
-                  "$ref": "#/definitions/NameInLibrary"
+                  "$ref": "../_Activatable.schema.json#/definitions/NameInLibrary"
                 },
                 "rules": {
-                  "$ref": "#/definitions/Rules"
+                  "$ref": "../_Activatable.schema.json#/definitions/Rules"
                 },
                 "errata": {
                   "$ref": "../source/_Erratum.schema.json#/definitions/Errata"

package/schema/specialAbility/BlessedTradition.schema.json

@@ -8,13 +8,13 @@
       "type": "object",
       "properties": {
         "id": {
-          "$ref": "#/definitions/Id"
+          "$ref": "../_Activatable.schema.json#/definitions/Id"
         },
         "skill_applications": {
-          "$ref": "#/definitions/SkillApplications"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillApplications"
         },
         "skill_uses": {
-          "$ref": "#/definitions/SkillUses"
+          "$ref": "../_Activatable.schema.json#/definitions/SkillUses"
         },
         "primary": {
           "description": "The tradition's primary attribute. Leave empty if the tradition does not\nhave one.",
@@ -223,7 +223,7 @@
           "type": "number"
         },
         "ap_value": {
-          "$ref": "#/definitions/AdventurePointsValue"
+          "$ref": "../_Activatable.schema.json#/definitions/AdventurePointsValue"
         },
         "src": {
           "$ref": "../source/_PublicationRef.schema.json#/definitions/PublicationRefs"
@@ -236,7 +236,7 @@
               "type": "object",
               "properties": {
                 "name": {
-                  "$ref": "#/definitions/Name"
+                  "$ref": "../_Activatable.schema.json#/definitions/Name"
                 },
                 "name_compressed": {
                   "description": "A shorter name of the tradition's name, used in liturgical chant\ndescriptions.",
@@ -244,7 +244,7 @@
                   "minLength": 1
                 },
                 "name_in_library": {
-                  "$ref": "#/definitions/NameInLibrary"
+                  "$ref": "../_Activatable.schema.json#/definitions/NameInLibrary"
                 },
                 "special_rules": {
                   "description": "The special rules of the tradition. They should be sorted like they are\nin the book.",