optolith-database-schema 0.8.1 → 0.10.0

package/schema/magicalActions/MagicalRune.schema.json

@@ -12,8 +12,12 @@
           "type": "integer",
           "minimum": 1
         },
-        "option": {
-          "$ref": "#/$defs/MagicalRuneOption"
+        "options": {
+          "description": "The options the magical rune has, if any.\n\nIf there are multiple options, the magical rune may be activated for each\noption, that is, multiple times.",
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/MagicalRuneOption"
+          }
         },
         "check": {
           "description": "Lists the linked three attributes used to make a skill check.",
@@ -33,7 +37,7 @@
         },
         "improvement_cost": {
           "description": "States which column is used to improve the skill.",
-          "$ref": "../_ImprovementCost.schema.json#/$defs/ImprovementCost"
+          "$ref": "#/$defs/MagicalRuneImprovementCost"
         },
         "src": {
           "$ref": "../source/_PublicationRef.schema.json#/$defs/PublicationRefs"
@@ -68,6 +72,10 @@
           "description": "The name of the magical rune.\n\nIf the rune has an option, the option’s name will/should not be included in\nthe name as well as its surrounding parenthesis. It will/should be combined\non demand.",
           "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString"
         },
+        "name_in_library": {
+          "description": "The full name of the entry as stated in the sources. Only use when `name`\nneeds to be different from full name for text generation purposes.",
+          "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
         "native_name": {
           "description": "The native name of the magical rune.",
           "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString"
@@ -182,7 +190,6 @@
       },
       "required": [
         "name",
-        "native_name",
         "effect",
         "cost",
         "crafting_time",
@@ -196,33 +203,33 @@
           "type": "object",
           "properties": {
             "tag": {
-              "const": "CloseCombatTechnique"
+              "const": "CombatTechnique"
             },
-            "close_combat_technique": {
-              "$ref": "#/$defs/MagicalRuneCloseCombatTechniqueCheckPenalty"
+            "combat_technique": {
+              "$ref": "#/$defs/MagicalRuneCombatTechniqueCheckPenalty"
             }
           },
           "required": [
             "tag",
-            "close_combat_technique"
+            "combat_technique"
           ],
           "additionalProperties": false
         }
       ]
     },
-    "MagicalRuneCloseCombatTechniqueCheckPenalty": {
+    "MagicalRuneCombatTechniqueCheckPenalty": {
       "type": "object",
       "properties": {
         "map": {
-          "description": "A map from close combat techniques to their modifiers.",
+          "description": "A map from combat techniques to their modifiers.",
           "type": "array",
           "items": {
-            "$ref": "#/$defs/MagicalRuneCloseCombatTechniqueCheckPenaltyMapping"
+            "$ref": "#/$defs/MagicalRuneCombatTechniqueCheckPenaltyMapping"
           },
           "minItems": 1
         },
         "rest": {
-          "$ref": "#/$defs/MagicalRuneCloseCombatTechniqueCheckPenaltyRest"
+          "$ref": "#/$defs/MagicalRuneCombatTechniqueCheckPenaltyRest"
         }
       },
       "required": [
@@ -231,29 +238,29 @@
       ],
       "additionalProperties": false
     },
-    "MagicalRuneCloseCombatTechniqueCheckPenaltyMapping": {
+    "MagicalRuneCombatTechniqueCheckPenaltyMapping": {
       "type": "object",
       "properties": {
-        "combat_technique_id": {
-          "description": "The close combat technique's identifier.",
-          "$ref": "../_Identifier.schema.json#/$defs/CloseCombatTechniqueIdentifier"
+        "id": {
+          "description": "The combat technique's identifier.",
+          "$ref": "../_IdentifierGroup.schema.json#/$defs/CombatTechniqueIdentifier"
         },
         "modifier": {
-          "description": "The check modifier for the specified close combat technique.",
+          "description": "The check modifier for the specified combat technique.",
           "type": "integer"
         }
       },
       "required": [
-        "combat_technique_id",
+        "id",
         "modifier"
       ],
       "additionalProperties": false
     },
-    "MagicalRuneCloseCombatTechniqueCheckPenaltyRest": {
+    "MagicalRuneCombatTechniqueCheckPenaltyRest": {
       "type": "object",
       "properties": {
         "modifier": {
-          "description": "The check modifier for close combat techniques not specified in `map`.",
+          "description": "The check modifier for combat techniques not specified in `map`.",
           "type": "integer"
         }
       },
@@ -287,6 +294,61 @@
       "additionalProperties": false
     },
     "MagicalRuneCost": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Single"
+            },
+            "single": {
+              "$ref": "#/$defs/SingleMagicalRuneCost"
+            }
+          },
+          "required": [
+            "tag",
+            "single"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Disjunction"
+            },
+            "disjunction": {
+              "$ref": "#/$defs/MagicalRuneCostDisjunction"
+            }
+          },
+          "required": [
+            "tag",
+            "disjunction"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "DerivedFromOption"
+            },
+            "derived_from_option": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "derived_from_option"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "MagicalRuneOptionCost": {
       "oneOf": [
         {
           "type": "object",
@@ -442,9 +504,76 @@
       ],
       "additionalProperties": false
     },
+    "MagicalRuneImprovementCost": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Constant"
+            },
+            "constant": {
+              "$ref": "#/$defs/ConstantMagicalRuneImprovementCost"
+            }
+          },
+          "required": [
+            "tag",
+            "constant"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "DerivedFromOption"
+            },
+            "derived_from_option": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "derived_from_option"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "ConstantMagicalRuneImprovementCost": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "$ref": "../_ImprovementCost.schema.json#/$defs/ImprovementCost"
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false
+    },
     "MagicalRuneOption": {
       "type": "object",
       "properties": {
+        "id": {
+          "description": "The magical rune option’s identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "cost": {
+          "description": "The option-specific AE cost.",
+          "$ref": "#/$defs/MagicalRuneOptionCost"
+        },
+        "improvement_cost": {
+          "description": "The option-specific improvement cost.",
+          "$ref": "../_ImprovementCost.schema.json#/$defs/ImprovementCost"
+        },
+        "suboption": {
+          "$ref": "#/$defs/MagicalRuneSuboption"
+        },
         "translations": {
           "description": "All translations for the entry, identified by IETF language tag (BCP47).",
           "type": "object",
@@ -458,20 +587,83 @@
         }
       },
       "required": [
+        "id",
+        "cost",
+        "improvement_cost",
+        "suboption",
         "translations"
       ],
       "additionalProperties": false
     },
+    "MagicalRuneSuboption": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Custom"
+            },
+            "custom": {
+              "$ref": "#/$defs/CustomMagicalRuneSuboption"
+            }
+          },
+          "required": [
+            "tag",
+            "custom"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "CustomMagicalRuneSuboption": {
+      "type": "object",
+      "properties": {
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/CustomMagicalRuneSuboptionTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "CustomMagicalRuneSuboptionTranslation": {
+      "type": "object",
+      "properties": {
+        "examples": {
+          "description": "One or more examples for the suboption.",
+          "type": "array",
+          "items": {
+            "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+          }
+        }
+      },
+      "required": [],
+      "additionalProperties": false
+    },
     "MagicalRuneOptionTranslation": {
       "type": "object",
       "properties": {
         "name": {
           "description": "The name of the option.\n\nThe surrounding parenthesis will/should not be included, they will/should\nbe generated.",
           "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "native_name": {
+          "description": "The native name of the magical rune option.",
+          "$ref": "../_NonEmptyString.schema.json#/$defs/NonEmptyString"
         }
       },
       "required": [
-        "name"
+        "name",
+        "native_name"
       ],
       "additionalProperties": false
     }

package/schema/prerequisites/DisplayOption.schema.json

@@ -45,6 +45,10 @@
     "ReplacementDisplayOption": {
       "type": "object",
       "properties": {
+        "sentence_type": {
+          "description": "If the replacement text is a sentence or sentence-like fragment, this\nproperty ensures it is integrated into the prerequisite string correctly.\n\nA standalone sentence is connected to the previous prerequisite string with\na period and a period is also added at the end of the sentence\nautomatically, if it is not present. A connected sentence is connected to\nthe previous prerequisite string with a semicolon and a period is not added\nto the end of the sentence. In this case, if there are prerequisites after\nthis one, they will be connected using a semicolon again, unless a\ndifferent punctuation mark is present at the end of the given text.",
+          "$ref": "./single/TextPrerequisite.schema.json#/$defs/SentenceType"
+        },
         "translations": {
           "description": "All translations for the entry, identified by IETF language tag (BCP47).",
           "type": "object",

package/schema/prerequisites/PrerequisiteGroups.schema.json

@@ -243,7 +243,7 @@
               "const": "RatedMinimumNumber"
             },
             "rated_minimum_number": {
-              "$ref": "./single/RatedPrerequisite.schema.json#/$defs/RatedMinimumNumberPrerequisite"
+              "$ref": "./single/RatedMinimumNumberPrerequisite.schema.json#/$defs/RatedMinimumNumberPrerequisite"
             }
           },
           "required": [
@@ -252,6 +252,22 @@
           ],
           "additionalProperties": false
         },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "RatedSum"
+            },
+            "rated_sum": {
+              "$ref": "./single/RatedSumPrerequisite.schema.json#/$defs/RatedSumPrerequisite"
+            }
+          },
+          "required": [
+            "tag",
+            "rated_sum"
+          ],
+          "additionalProperties": false
+        },
         {
           "type": "object",
           "properties": {
@@ -283,6 +299,22 @@
             "text"
           ],
           "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "SexualCharacteristic"
+            },
+            "sexual_characteristic": {
+              "$ref": "./single/SexualCharacteristicPrerequisite.schema.json#/$defs/SexualCharacteristicPrerequisite"
+            }
+          },
+          "required": [
+            "tag",
+            "sexual_characteristic"
+          ],
+          "additionalProperties": false
         }
       ]
     },
@@ -590,7 +622,7 @@
               "const": "RatedMinimumNumber"
             },
             "rated_minimum_number": {
-              "$ref": "./single/RatedPrerequisite.schema.json#/$defs/RatedMinimumNumberPrerequisite"
+              "$ref": "./single/RatedMinimumNumberPrerequisite.schema.json#/$defs/RatedMinimumNumberPrerequisite"
             }
           },
           "required": [
@@ -599,6 +631,22 @@
           ],
           "additionalProperties": false
         },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "RatedSum"
+            },
+            "rated_sum": {
+              "$ref": "./single/RatedSumPrerequisite.schema.json#/$defs/RatedSumPrerequisite"
+            }
+          },
+          "required": [
+            "tag",
+            "rated_sum"
+          ],
+          "additionalProperties": false
+        },
         {
           "type": "object",
           "properties": {
@@ -630,6 +678,38 @@
             "text"
           ],
           "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "NoOtherAncestorBloodAdvantage"
+            },
+            "no_other_ancestor_blood_advantage": {
+              "$ref": "./single/AncestorBloodPrerequisite.schema.json#/$defs/AncestorBloodPrerequisite"
+            }
+          },
+          "required": [
+            "tag",
+            "no_other_ancestor_blood_advantage"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "SexualCharacteristic"
+            },
+            "sexual_characteristic": {
+              "$ref": "./single/SexualCharacteristicPrerequisite.schema.json#/$defs/SexualCharacteristicPrerequisite"
+            }
+          },
+          "required": [
+            "tag",
+            "sexual_characteristic"
+          ],
+          "additionalProperties": false
         }
       ]
     },
@@ -926,6 +1006,22 @@
             "publication"
           ],
           "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "SexualCharacteristic"
+            },
+            "sexual_characteristic": {
+              "$ref": "./single/SexualCharacteristicPrerequisite.schema.json#/$defs/SexualCharacteristicPrerequisite"
+            }
+          },
+          "required": [
+            "tag",
+            "sexual_characteristic"
+          ],
+          "additionalProperties": false
         }
       ]
     }

package/schema/prerequisites/single/AncestorBloodPrerequisite.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/prerequisites/single/AncestorBloodPrerequisite.schema.json",
+  "$defs": {
+    "AncestorBloodPrerequisite": {
+      "title": "Ancestor Blood Prerequisite",
+      "description": "Requires that no other Ancestor Blood advantage is active.",
+      "type": "object",
+      "properties": {},
+      "required": [],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/RatedMinimumNumberPrerequisite.schema.json

@@ -0,0 +1,166 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/prerequisites/single/RatedMinimumNumberPrerequisite.schema.json",
+  "$defs": {
+    "RatedMinimumNumberPrerequisite": {
+      "title": "Rated Minimum Number Prerequisite",
+      "type": "object",
+      "properties": {
+        "number": {
+          "description": "The minimum number of skills that need to be on the defined minimum skill\nrating.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "value": {
+          "description": "The minimum skill rating the defined minimum number of skills need to be\non.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "targets": {
+          "description": "The targets that contribute to satisfying the prerequisite.",
+          "$ref": "#/$defs/RatedMinimumNumberPrerequisiteTarget"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/$defs/DisplayOption"
+        }
+      },
+      "required": [
+        "number",
+        "value",
+        "targets"
+      ],
+      "additionalProperties": false
+    },
+    "RatedMinimumNumberPrerequisiteTarget": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Skills"
+            },
+            "skills": {
+              "$ref": "#/$defs/RatedMinimumNumberPrerequisiteSkillsTarget"
+            }
+          },
+          "required": [
+            "tag",
+            "skills"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "CombatTechniques"
+            },
+            "combat_techniques": {
+              "$ref": "#/$defs/CombatTechniquesTarget"
+            }
+          },
+          "required": [
+            "tag",
+            "combat_techniques"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Spellworks"
+            },
+            "spellworks": {
+              "$ref": "../../_SimpleReferences.schema.json#/$defs/PropertyReference"
+            }
+          },
+          "required": [
+            "tag",
+            "spellworks"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Liturgies"
+            },
+            "liturgies": {
+              "$ref": "../../_SimpleReferences.schema.json#/$defs/AspectReference"
+            }
+          },
+          "required": [
+            "tag",
+            "liturgies"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "RatedMinimumNumberPrerequisiteSkillsTarget": {
+      "type": "object",
+      "properties": {
+        "list": {
+          "description": "The skills that are taken into account for satisfying the prerequisite.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_SimpleReferences.schema.json#/$defs/SkillReference"
+          },
+          "minItems": 2,
+          "uniqueItems": true
+        }
+      },
+      "required": [
+        "list"
+      ],
+      "additionalProperties": false
+    },
+    "CombatTechniquesTarget": {
+      "type": "object",
+      "properties": {
+        "group": {
+          "$ref": "#/$defs/CombatTechniquesTargetGroup"
+        }
+      },
+      "required": [
+        "group"
+      ],
+      "additionalProperties": false
+    },
+    "CombatTechniquesTargetGroup": {
+      "enum": [
+        "All",
+        "Close",
+        "Ranged"
+      ]
+    },
+    "RatedMinimumNumberPrerequisiteSpellworksTarget": {
+      "type": "object",
+      "properties": {
+        "property": {
+          "description": "The skills that are taken into account for satisfying the prerequisite.",
+          "$ref": "../../_SimpleReferences.schema.json#/$defs/PropertyReference"
+        }
+      },
+      "required": [
+        "property"
+      ],
+      "additionalProperties": false
+    },
+    "RatedMinimumNumberPrerequisiteLiturgiesTarget": {
+      "type": "object",
+      "properties": {
+        "aspect": {
+          "description": "The skills that are taken into account for satisfying the prerequisite.",
+          "$ref": "../../_SimpleReferences.schema.json#/$defs/AspectReference"
+        }
+      },
+      "required": [
+        "aspect"
+      ],
+      "additionalProperties": false
+    }
+  }
+}