optolith-database-schema 0.2.4 → 0.4.1

package/schema/_ActivatableSkillCastingTime.schema.json

@@ -0,0 +1,177 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/_ActivatableSkillCastingTime.schema.json",
+  "$defs": {
+    "ModifiableCastingTime": {
+      "type": "object",
+      "properties": {
+        "initial_modification_level": {
+          "description": "The initial skill modification identifier/level.",
+          "type": "integer",
+          "maximum": 6,
+          "minimum": 1
+        }
+      },
+      "required": [
+        "initial_modification_level"
+      ],
+      "additionalProperties": false
+    },
+    "CastingTimeDuringLovemaking": {
+      "description": "The casting time during lovemaking. In Aventurian Intimacy, you may only use\nan activatable skill during lovemaking if it has a casting time used during\nlovemaking.",
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "The (unitless) casting time value.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "unit": {
+          "description": "The unit of the `value`.",
+          "$ref": "#/$defs/CastingTimeDuringLovemakingUnit"
+        }
+      },
+      "required": [
+        "value",
+        "unit"
+      ],
+      "additionalProperties": false
+    },
+    "CastingTimeDuringLovemakingUnit": {
+      "enum": [
+        "SeductionActions",
+        "Rounds"
+      ]
+    },
+    "FastSkillNonModifiableCastingTime": {
+      "type": "object",
+      "properties": {
+        "actions": {
+          "description": "The casting time value in actions.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "actions"
+      ],
+      "additionalProperties": false
+    },
+    "SlowSkillNonModifiableCastingTime": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "The (unitless) casting time value.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "unit": {
+          "$ref": "./SkillModificationLevel.schema.json#/$defs/SlowSkillCastingTimeUnit"
+        }
+      },
+      "required": [
+        "value",
+        "unit"
+      ],
+      "additionalProperties": false
+    },
+    "FastCastingTime": {
+      "type": "object",
+      "properties": {
+        "default": {
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Modifiable"
+                },
+                "modifiable": {
+                  "$ref": "#/$defs/ModifiableCastingTime"
+                }
+              },
+              "required": [
+                "tag",
+                "modifiable"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "NonModifiable"
+                },
+                "non_modifiable": {
+                  "$ref": "#/$defs/FastSkillNonModifiableCastingTime"
+                }
+              },
+              "required": [
+                "tag",
+                "non_modifiable"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "during_lovemaking": {
+          "description": "The casting time during lovemaking. In Aventurian Intimacy, you may only\nuse an activatable skill during lovemaking if it has a casting time used\nduring lovemaking.",
+          "$ref": "#/$defs/CastingTimeDuringLovemaking"
+        }
+      },
+      "required": [
+        "default"
+      ],
+      "additionalProperties": false
+    },
+    "SlowCastingTime": {
+      "type": "object",
+      "properties": {
+        "default": {
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Modifiable"
+                },
+                "modifiable": {
+                  "$ref": "#/$defs/ModifiableCastingTime"
+                }
+              },
+              "required": [
+                "tag",
+                "modifiable"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "NonModifiable"
+                },
+                "non_modifiable": {
+                  "$ref": "#/$defs/SlowSkillNonModifiableCastingTime"
+                }
+              },
+              "required": [
+                "tag",
+                "non_modifiable"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "during_lovemaking": {
+          "description": "The casting time during lovemaking. In Aventurian Intimacy, you may only\nuse an activatable skill during lovemaking if it has a casting time used\nduring lovemaking.",
+          "$ref": "#/$defs/CastingTimeDuringLovemaking"
+        }
+      },
+      "required": [
+        "default"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/_ActivatableSkillCheckResultBased.schema.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/_ActivatableSkillCheckResultBased.schema.json",
+  "$defs": {
+    "CheckResultValue": {
+      "description": "Defines the derived (unitless) value.",
+      "enum": [
+        "QualityLevels",
+        "SkillPoints"
+      ]
+    },
+    "CheckResultArithmetic": {
+      "description": "Defines how the the `value` is set off against the check result.",
+      "enum": [
+        "Multiply",
+        "Divide"
+      ]
+    },
+    "CheckResultBasedModifier": {
+      "type": "object",
+      "properties": {
+        "arithmetic": {
+          "description": "The arithmetic how to apply the `value` to the `base`.",
+          "$ref": "#/$defs/CheckResultArithmetic"
+        },
+        "value": {
+          "description": "The value that is applied to the `base` using the defined `arithmetic`.",
+          "type": "integer",
+          "minimum": 2
+        }
+      },
+      "required": [
+        "arithmetic",
+        "value"
+      ],
+      "additionalProperties": false
+    },
+    "CheckResultBased": {
+      "description": "Defines a parameter being based on a check result.",
+      "type": "object",
+      "properties": {
+        "base": {
+          "description": "The base value that is derived from the check result.",
+          "$ref": "#/$defs/CheckResultValue"
+        },
+        "modifier": {
+          "description": "If defined, it modifies the base value.",
+          "$ref": "#/$defs/CheckResultBasedModifier"
+        }
+      },
+      "required": [
+        "base"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/_ActivatableSkillCost.schema.json

@@ -0,0 +1,448 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/_ActivatableSkillCost.schema.json",
+  "$defs": {
+    "OneTimeCost": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Single"
+            },
+            "single": {
+              "$ref": "#/$defs/SingleOneTimeCost"
+            }
+          },
+          "required": [
+            "tag",
+            "single"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Conjunction"
+            },
+            "conjunction": {
+              "$ref": "#/$defs/MultipleOneTimeCosts"
+            }
+          },
+          "required": [
+            "tag",
+            "conjunction"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Disjunction"
+            },
+            "disjunction": {
+              "$ref": "#/$defs/MultipleOneTimeCosts"
+            }
+          },
+          "required": [
+            "tag",
+            "disjunction"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Map"
+            },
+            "map": {
+              "$ref": "#/$defs/CostMap"
+            }
+          },
+          "required": [
+            "tag",
+            "map"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "SingleOneTimeCost": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Modifiable"
+            },
+            "modifiable": {
+              "$ref": "#/$defs/ModifiableOneTimeCost"
+            }
+          },
+          "required": [
+            "tag",
+            "modifiable"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "NonModifiable"
+            },
+            "non_modifiable": {
+              "$ref": "#/$defs/NonModifiableOneTimeCost"
+            }
+          },
+          "required": [
+            "tag",
+            "non_modifiable"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Indefinite"
+            },
+            "indefinite": {
+              "$ref": "#/$defs/IndefiniteOneTimeCost"
+            }
+          },
+          "required": [
+            "tag",
+            "indefinite"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "MultipleOneTimeCosts": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/SingleOneTimeCost"
+      },
+      "minItems": 2
+    },
+    "ModifiableOneTimeCost": {
+      "type": "object",
+      "properties": {
+        "initial_modification_level": {
+          "description": "The initial skill modification identifier/level.",
+          "type": "integer",
+          "maximum": 6,
+          "minimum": 1
+        },
+        "permanent_value": {
+          "description": "The part of the cost value that has to be spent permanently.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "initial_modification_level"
+      ],
+      "additionalProperties": false
+    },
+    "NonModifiableOneTimeCost": {
+      "type": "object",
+      "properties": {
+        "is_minimum": {
+          "description": "If `true`, the non-modifiable value is a minimum value.",
+          "type": "boolean"
+        },
+        "value": {
+          "description": "The AE cost value.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "permanent_value": {
+          "description": "The part of the cost value that has to be spent permanently.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "per": {
+          "description": "The cost have to be per a specific countable entity, e.g. `8 KP per\nperson`.",
+          "$ref": "#/$defs/NonModifiableOneTimeCostPerCountable"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/NonModifiableOneTimeCostTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false
+    },
+    "NonModifiableOneTimeCostPerCountable": {
+      "type": "object",
+      "properties": {
+        "minimum_total": {
+          "description": "If defined, the minimum total AE that have to be spent casting the\nskill.",
+          "type": "number"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/NonModifiableOneTimeCostPerCountableTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "NonModifiableOneTimeCostPerCountableTranslation": {
+      "type": "object",
+      "properties": {
+        "countable": {
+          "description": "The countable entity name.",
+          "$ref": "./_ResponsiveText.schema.json#/$defs/ResponsiveText"
+        }
+      },
+      "required": [
+        "countable"
+      ],
+      "additionalProperties": false
+    },
+    "NonModifiableOneTimeCostTranslation": {
+      "type": "object",
+      "properties": {
+        "note": {
+          "description": "A note, appended to the generated string in parenthesis.",
+          "$ref": "./_ResponsiveText.schema.json#/$defs/ResponsiveTextOptional"
+        }
+      },
+      "required": [
+        "note"
+      ],
+      "additionalProperties": false
+    },
+    "IndefiniteOneTimeCost": {
+      "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/IndefiniteOneTimeCostTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "IndefiniteOneTimeCostTranslation": {
+      "type": "object",
+      "properties": {
+        "description": {
+          "description": "A description of where the cost come from.",
+          "$ref": "./_ResponsiveText.schema.json#/$defs/ResponsiveText"
+        }
+      },
+      "required": [
+        "description"
+      ],
+      "additionalProperties": false
+    },
+    "CostMap": {
+      "description": "A content that is `2/4/8/16 AE for an item the size of a\ncup/chest/door/castle gate` may be respresented as the following map:\n\n```yaml\noptions:\n  - value: 2\n    label: \"cup\"\n  - value: 4\n    label: \"chest\"\n  - value: 8\n    label: \"door\"\n  - value: 16\n    label: \"castle gate\"\nfor_append: \"an item the size of a\"\n```\n\nThis will generate the exact same string as seen above – given it is set\nfor a spellwork and thus `AE` is used.",
+      "type": "object",
+      "properties": {
+        "options": {
+          "description": "The possible costs and associated labels.",
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/CostMapOption"
+          },
+          "minItems": 2
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/CostMapTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "options"
+      ],
+      "additionalProperties": false
+    },
+    "CostMapOption": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "The full cost value for this option.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "permanent_value": {
+          "description": "The part of the `value` that has to be paid permanently.",
+          "type": "integer",
+          "minimum": 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/CostMapOptionTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false
+    },
+    "CostMapOptionTranslation": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "description": "The description of the option for cost string generation.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "label_standalone": {
+          "description": "The description of the option if used standalone. Only used if\ndifferent from `label`.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        }
+      },
+      "required": [
+        "label"
+      ],
+      "additionalProperties": false
+    },
+    "CostMapTranslation": {
+      "type": "object",
+      "properties": {
+        "list_prepend": {
+          "description": "Place a string between the `for` and the grouped map option labels.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "list_append": {
+          "description": "Place a string after the grouped map option labels.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "replacement": {
+          "description": "If the string from the book cannot be generated using the default\ngeneration technique, use this string. All options still need to be\ninserted propertly, since it may be used by in-game tools to provide a\nselection to players.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        }
+      },
+      "required": [],
+      "additionalProperties": false
+    },
+    "SustainedCost": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Modifiable"
+            },
+            "modifiable": {
+              "$ref": "#/$defs/ModifiableSustainedCost"
+            }
+          },
+          "required": [
+            "tag",
+            "modifiable"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "NonModifiable"
+            },
+            "non_modifiable": {
+              "$ref": "#/$defs/NonModifiableSustainedCost"
+            }
+          },
+          "required": [
+            "tag",
+            "non_modifiable"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "ModifiableSustainedCost": {
+      "type": "object",
+      "properties": {
+        "initial_modification_level": {
+          "description": "The initial skill modification identifier/level.",
+          "type": "integer",
+          "maximum": 6,
+          "minimum": 1
+        },
+        "interval": {
+          "description": "The sustain interval.",
+          "$ref": "./_ActivatableSkillDuration.schema.json#/$defs/DurationUnitValue"
+        }
+      },
+      "required": [
+        "initial_modification_level",
+        "interval"
+      ],
+      "additionalProperties": false
+    },
+    "NonModifiableSustainedCost": {
+      "type": "object",
+      "properties": {
+        "is_minimum": {
+          "description": "If `true`, the non-modifiable value is a minimum value.",
+          "type": "boolean"
+        },
+        "value": {
+          "description": "The AE cost value.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "interval": {
+          "description": "The sustain interval.",
+          "$ref": "./_ActivatableSkillDuration.schema.json#/$defs/DurationUnitValue"
+        }
+      },
+      "required": [
+        "value",
+        "interval"
+      ],
+      "additionalProperties": false
+    }
+  }
+}