optolith-database-schema 0.1.2 → 0.1.5

package/schema/magicalActions/AnimistPower.schema.json

@@ -211,6 +211,10 @@
                   ],
                   "additionalProperties": false
                 },
+                "prerequisites": {
+                  "description": "A prerequisites text.",
+                  "type": "string"
+                },
                 "errata": {
                   "$ref": "../source/_Erratum.schema.json#/definitions/Errata"
                 }

package/schema/magicalActions/Curse.schema.json

@@ -133,7 +133,7 @@
                       "type": "object",
                       "properties": {
                         "per": {
-                          "description": "The cost have to be per a specific countable entity, e.g. `8 KP\nper person`",
+                          "description": "The cost have to be per a specific countable entity, e.g. `8 KP\nper person`.",
                           "type": "object",
                           "properties": {
                             "default": {

package/schema/magicalActions/ElvenMagicalSong.schema.json

@@ -120,7 +120,7 @@
               "minimum": 1
             },
             "interval": {
-              "description": "Specified if the AE cost `value` have to paid for each time interval.",
+              "description": "Specified if the AE cost `value` has to be paid for each time interval.",
               "$ref": "../_ActivatableSkill.schema.json#/definitions/Duration/UnitValue"
             },
             "permanent": {

package/schema/magicalActions/GeodeRitual.schema.json

@@ -30,7 +30,7 @@
           "minimum": 1
         },
         "prerequisites": {
-          "$ref": "../_Prerequisite.schema.json#/definitions/Prerequisite/GroupCollection/GeodeRitual"
+          "$ref": "../_Prerequisite.schema.json#/definitions/GeodeRitualPrerequisites"
         },
         "src": {
           "$ref": "../source/_PublicationRef.schema.json#/definitions/PublicationRefs"

package/schema/prerequisites/ConditionalPrerequisites.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "prerequisites/ConditionalPrerequisites.schema.json",
+  "definitions": {
+    "Preconditions": {
+      "title": "Preconditions (`when`)",
+      "description": "A list of preconditions for the prerequisite it is defined on, so that it\nonly takes effect if the prerequisites in this list are matched.\n\nUsually appears at the `when` property of the parent prerequisite.",
+      "type": "array",
+      "items": {
+        "$ref": "./PrerequisiteGroups.schema.json#/definitions/PreconditionGroup"
+      },
+      "minItems": 1
+    }
+  }
+}

package/schema/prerequisites/DisplayOption.schema.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "prerequisites/DisplayOption.schema.json",
+  "definitions": {
+    "DisplayOption": {
+      "title": "Display Option",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Hide"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ReplaceWith"
+            },
+            "translations": {
+              "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+              "type": "object",
+              "patternProperties": {
+                "^[a-z]{2}-[A-Z]{2}$": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "minProperties": 1,
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "translations"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  }
+}

package/schema/prerequisites/PrerequisiteGroups.schema.json

@@ -0,0 +1,246 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "prerequisites/PrerequisiteGroups.schema.json",
+  "definitions": {
+    "DerivedCharacteristicPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/RulePrerequisite.schema.json#/definitions/RulePrerequisite"
+        }
+      ]
+    },
+    "PublicationPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/PublicationPrerequisite.schema.json#/definitions/PublicationPrerequisite"
+        }
+      ]
+    },
+    "GeneralPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/SexPrerequisite.schema.json#/definitions/SexPrerequisite"
+        },
+        {
+          "$ref": "./single/RacePrerequisite.schema.json#/definitions/RacePrerequisite"
+        },
+        {
+          "$ref": "./single/CulturePrerequisite.schema.json#/definitions/CulturePrerequisite"
+        },
+        {
+          "$ref": "./single/PactPrerequisite.schema.json#/definitions/PactPrerequisite"
+        },
+        {
+          "$ref": "./single/SocialStatusPrerequisite.schema.json#/definitions/SocialStatusPrerequisite"
+        },
+        {
+          "$ref": "./single/StatePrerequisite.schema.json#/definitions/StatePrerequisite"
+        },
+        {
+          "$ref": "./single/RulePrerequisite.schema.json#/definitions/RulePrerequisite"
+        },
+        {
+          "$ref": "./single/PrimaryAttributePrerequisite.schema.json#/definitions/PrimaryAttributePrerequisite"
+        },
+        {
+          "$ref": "./single/ActivatablePrerequisite.schema.json#/definitions/ActivatablePrerequisite"
+        },
+        {
+          "$ref": "./single/ActivatablePrerequisite.schema.json#/definitions/ActivatableSetPrerequisite"
+        },
+        {
+          "$ref": "./single/ActivatablePrerequisite.schema.json#/definitions/ActivatableOptionSetPrerequisite"
+        },
+        {
+          "$ref": "./single/TraditionPrerequisite.schema.json#/definitions/BlessedTraditionPrerequisite"
+        },
+        {
+          "$ref": "./single/TraditionPrerequisite.schema.json#/definitions/MagicalTraditionPrerequisite"
+        },
+        {
+          "$ref": "./single/RatedPrerequisite.schema.json#/definitions/RatedPrerequisite"
+        },
+        {
+          "$ref": "./single/RatedPrerequisite.schema.json#/definitions/RatedSetPrerequisite"
+        },
+        {
+          "$ref": "./single/RatedPrerequisite.schema.json#/definitions/RatedMinimumNumberPrerequisite"
+        },
+        {
+          "$ref": "./single/EnhancementPrerequisite.schema.json#/definitions/ExternalEnhancementPrerequisite"
+        },
+        {
+          "$ref": "./single/TextPrerequisite.schema.json#/definitions/TextPrerequisite"
+        }
+      ]
+    },
+    "ProfessionPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/SexPrerequisite.schema.json#/definitions/SexPrerequisite"
+        },
+        {
+          "$ref": "./single/RacePrerequisite.schema.json#/definitions/RacePrerequisite"
+        },
+        {
+          "$ref": "./single/CulturePrerequisite.schema.json#/definitions/CulturePrerequisite"
+        },
+        {
+          "$ref": "./single/ActivatablePrerequisite.schema.json#/definitions/ActivatablePrerequisite"
+        },
+        {
+          "$ref": "./single/RatedPrerequisite.schema.json#/definitions/RatedPrerequisite"
+        }
+      ]
+    },
+    "AdvantageDisadvantagePrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/CommonSuggestedByRCPPrerequisite.schema.json#/definitions/CommonSuggestedByRCPPrerequisite"
+        },
+        {
+          "$ref": "./single/SexPrerequisite.schema.json#/definitions/SexPrerequisite"
+        },
+        {
+          "$ref": "./single/RacePrerequisite.schema.json#/definitions/RacePrerequisite"
+        },
+        {
+          "$ref": "./single/CulturePrerequisite.schema.json#/definitions/CulturePrerequisite"
+        },
+        {
+          "$ref": "./single/PactPrerequisite.schema.json#/definitions/PactPrerequisite"
+        },
+        {
+          "$ref": "./single/SocialStatusPrerequisite.schema.json#/definitions/SocialStatusPrerequisite"
+        },
+        {
+          "$ref": "./single/StatePrerequisite.schema.json#/definitions/StatePrerequisite"
+        },
+        {
+          "$ref": "./single/RulePrerequisite.schema.json#/definitions/RulePrerequisite"
+        },
+        {
+          "$ref": "./single/PrimaryAttributePrerequisite.schema.json#/definitions/PrimaryAttributePrerequisite"
+        },
+        {
+          "$ref": "./single/ActivatablePrerequisite.schema.json#/definitions/ActivatablePrerequisite"
+        },
+        {
+          "$ref": "./single/ActivatablePrerequisite.schema.json#/definitions/ActivatableSetPrerequisite"
+        },
+        {
+          "$ref": "./single/ActivatablePrerequisite.schema.json#/definitions/ActivatableOptionSetPrerequisite"
+        },
+        {
+          "$ref": "./single/TraditionPrerequisite.schema.json#/definitions/BlessedTraditionPrerequisite"
+        },
+        {
+          "$ref": "./single/TraditionPrerequisite.schema.json#/definitions/MagicalTraditionPrerequisite"
+        },
+        {
+          "$ref": "./single/RatedPrerequisite.schema.json#/definitions/RatedPrerequisite"
+        },
+        {
+          "$ref": "./single/RatedPrerequisite.schema.json#/definitions/RatedSetPrerequisite"
+        },
+        {
+          "$ref": "./single/RatedPrerequisite.schema.json#/definitions/RatedMinimumNumberPrerequisite"
+        },
+        {
+          "$ref": "./single/EnhancementPrerequisite.schema.json#/definitions/ExternalEnhancementPrerequisite"
+        },
+        {
+          "$ref": "./single/TextPrerequisite.schema.json#/definitions/TextPrerequisite"
+        }
+      ]
+    },
+    "ArcaneTraditionPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/SexPrerequisite.schema.json#/definitions/SexPrerequisite"
+        },
+        {
+          "$ref": "./single/CulturePrerequisite.schema.json#/definitions/CulturePrerequisite"
+        }
+      ]
+    },
+    "PersonalityTraitPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/CulturePrerequisite.schema.json#/definitions/CulturePrerequisite"
+        },
+        {
+          "$ref": "./single/TextPrerequisite.schema.json#/definitions/TextPrerequisite"
+        }
+      ]
+    },
+    "SpellworkPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/RulePrerequisite.schema.json#/definitions/RulePrerequisite"
+        },
+        {
+          "$ref": "./single/RatedPrerequisite.schema.json#/definitions/RatedPrerequisite"
+        }
+      ]
+    },
+    "LiturgyPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/RulePrerequisite.schema.json#/definitions/RulePrerequisite"
+        }
+      ]
+    },
+    "InfluencePrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/InfluencePrerequisite.schema.json#/definitions/InfluencePrerequisite"
+        },
+        {
+          "$ref": "./single/TextPrerequisite.schema.json#/definitions/TextPrerequisite"
+        }
+      ]
+    },
+    "LanguagePrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/RacePrerequisite.schema.json#/definitions/RacePrerequisite"
+        },
+        {
+          "$ref": "./single/ActivatablePrerequisite.schema.json#/definitions/ActivatablePrerequisite"
+        },
+        {
+          "$ref": "./single/TextPrerequisite.schema.json#/definitions/TextPrerequisite"
+        }
+      ]
+    },
+    "AnimistPowerPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/AnimistPowerPrerequisite.schema.json#/definitions/AnimistPowerPrerequisite"
+        }
+      ]
+    },
+    "GeodeRitualPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/InfluencePrerequisite.schema.json#/definitions/InfluencePrerequisite"
+        }
+      ]
+    },
+    "EnhancementPrerequisiteGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/EnhancementPrerequisite.schema.json#/definitions/InternalEnhancementPrerequisite"
+        }
+      ]
+    },
+    "PreconditionGroup": {
+      "oneOf": [
+        {
+          "$ref": "./single/PublicationPrerequisite.schema.json#/definitions/PublicationPrerequisite"
+        }
+      ]
+    }
+  }
+}

package/schema/prerequisites/single/ActivatablePrerequisite.schema.json

@@ -0,0 +1,142 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "prerequisites/single/ActivatablePrerequisite.schema.json",
+  "definitions": {
+    "ActivatablePrerequisite": {
+      "title": "Activatable Prerequisite",
+      "description": "Requires a specific advantage, disadvantage or special ability.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Activatable"
+        },
+        "id": {
+          "description": "The activatable entry's identifier.",
+          "$ref": "../../_Identifier.schema.json#/definitions/ActivatableIdentifier"
+        },
+        "active": {
+          "description": "If the required entry should be required to be active or inactive.",
+          "type": "boolean"
+        },
+        "level": {
+          "description": "The required minimum level of the entry.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "options": {
+          "description": "Required select options. Order is important. Typically, you only need the\nfirst array index, though.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_Identifier.schema.json#/definitions/RequirableSelectOptionIdentifier"
+          },
+          "minItems": 1
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        },
+        "when": {
+          "$ref": "../ConditionalPrerequisites.schema.json#/definitions/Preconditions"
+        }
+      },
+      "required": [
+        "tag",
+        "id",
+        "active"
+      ],
+      "additionalProperties": false
+    },
+    "ActivatableSetPrerequisite": {
+      "title": "Activatable Set Prerequisite",
+      "description": "Requires a specific advantage, disadvantage or special ability from a given\nset of entries.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "ActivatableSet"
+        },
+        "id": {
+          "description": "The possible activatable entries' identifiers.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_Identifier.schema.json#/definitions/ActivatableIdentifier"
+          },
+          "minItems": 2
+        },
+        "active": {
+          "description": "If the required entry should be required to be active or inactive.",
+          "type": "boolean"
+        },
+        "level": {
+          "description": "The required minimum level of the entry.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "options": {
+          "description": "Required select options. Order is important. Typically, you only need the\nfirst array index, though.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_Identifier.schema.json#/definitions/RequirableSelectOptionIdentifier"
+          },
+          "minItems": 1
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id",
+        "active"
+      ],
+      "additionalProperties": false
+    },
+    "ActivatableOptionSetPrerequisite": {
+      "title": "Activatable Option Set Prerequisite",
+      "description": "Requires one option from a set of options from a specific advantage,\ndisadvantage or special ability.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "ActivatableOptionSet"
+        },
+        "id": {
+          "description": "The activatable entry's identifier.",
+          "$ref": "../../_Identifier.schema.json#/definitions/ActivatableIdentifier"
+        },
+        "active": {
+          "description": "If the required entry should be required to be active or inactive.",
+          "type": "boolean"
+        },
+        "level": {
+          "description": "The required minimum level of the entry.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "first_option": {
+          "description": "The possible set of first options.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_Identifier.schema.json#/definitions/RequirableSelectOptionIdentifier"
+          },
+          "minItems": 2
+        },
+        "other_options": {
+          "description": "Required other select options. Order is important.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_Identifier.schema.json#/definitions/RequirableSelectOptionIdentifier"
+          },
+          "minItems": 1
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id",
+        "active",
+        "first_option"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/AnimistPowerPrerequisite.schema.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "prerequisites/single/AnimistPowerPrerequisite.schema.json",
+  "definitions": {
+    "AnimistPowerPrerequisite": {
+      "title": "Animist Power Prerequisite",
+      "description": "Requires a specific animist power to be on a minimum value.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "AnimistPower"
+        },
+        "id": {
+          "description": "The animist power's identifier.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "level": {
+          "description": "The level to which the minimum value applies.",
+          "type": "integer",
+          "minimum": 2
+        },
+        "value": {
+          "description": "The required minimum value.",
+          "type": "integer",
+          "minimum": 0
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id",
+        "value"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/CommonSuggestedByRCPPrerequisite.schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "prerequisites/single/CommonSuggestedByRCPPrerequisite.schema.json",
+  "definitions": {
+    "CommonSuggestedByRCPPrerequisite": {
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "CommonSuggestedByRCP"
+        }
+      },
+      "required": [
+        "tag"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/CulturePrerequisite.schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "prerequisites/single/CulturePrerequisite.schema.json",
+  "definitions": {
+    "CulturePrerequisite": {
+      "title": "Culture Prerequisite",
+      "description": "Requires a specific culture or one of a specific set of cultures.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Culture"
+        },
+        "id": {
+          "$ref": "../../_Identifier.schema.json#/definitions/OneOrManyNumericIdentifiers"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/EnhancementPrerequisite.schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "prerequisites/single/EnhancementPrerequisite.schema.json",
+  "definitions": {
+    "ExternalEnhancementPrerequisite": {
+      "title": "External Enhancement Prerequisite",
+      "description": "Requires a specific enhancement from a skill. This should **not** be used\nfor enhancements themselves; they can only require enhancements from the same\nskill they enhance.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Enhancement"
+        },
+        "skill_id": {
+          "description": "The required skill's identifier.",
+          "$ref": "../../_Identifier.schema.json#/definitions/SkillWithEnhancementsIdentifier"
+        },
+        "enhancement_id": {
+          "description": "The required enhancement's identifier.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "skill_id",
+        "enhancement_id"
+      ],
+      "additionalProperties": false
+    },
+    "InternalEnhancementPrerequisite": {
+      "title": "Internal Enhancement Prerequisite",
+      "description": "Requires a specific enhancement from a skill. This can only be used by an\nenhancement to require another enhancement from the same skill.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Enhancement"
+        },
+        "id": {
+          "description": "The enhancement's identifier.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "tag",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/InfluencePrerequisite.schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "prerequisites/single/InfluencePrerequisite.schema.json",
+  "definitions": {
+    "InfluencePrerequisite": {
+      "title": "Influence Prerequisite",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Influence"
+        },
+        "id": {
+          "description": "The influence's identifier.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "active": {
+          "description": "If the referenced influence must or must not be chosen.",
+          "type": "boolean"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id",
+        "active"
+      ],
+      "additionalProperties": false
+    }
+  }
+}