optolith-database-schema 0.1.3 → 0.1.4

package/schema/_Activatable.schema.json

@@ -23,7 +23,9 @@
       "minimum": 2
     },
     "Maximum": {
-      "const": ""
+      "description": "The number stating how often you can buy the entry. The **default** depends on\nthe entry type:\n\n- **Advantage:** `1` in all cases (as specified in the **Core Rules**)\n- **Disadvantage:** `1` in all cases (as specified in the **Core Rules**)\n- **Special Abilities:** `1` if no options can be selected, otherwise the\n  number of possible options\n\nThe maximum is only set if it differs from the defaults specified above.",
+      "type": "integer",
+      "minimum": 1
     },
     "Options": {
       "const": ""
@@ -526,17 +528,828 @@
         }
       ]
     },
+    "EnchantmentCost": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ArcaneEnergyCost"
+            },
+            "ae_cost": {
+              "$ref": "#/definitions/ArcaneEnergyCost"
+            }
+          },
+          "required": [
+            "tag",
+            "ae_cost"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "BindingCost"
+            },
+            "binding_cost": {
+              "$ref": "#/definitions/BindingCost"
+            }
+          },
+          "required": [
+            "tag",
+            "binding_cost"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
     "ArcaneEnergyCost": {
       "description": "The AE Cost.",
-      "const": ""
-    },
-    "Volume": {
-      "description": "The volume points the enchantment needs.",
-      "const": ""
-    },
-    "BindingCost": {
-      "description": "The binding cost for an enchantment.",
-      "const": ""
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Fixed"
+            },
+            "value": {
+              "description": "The AE cost value.",
+              "type": "integer",
+              "minimum": 1
+            },
+            "is_permanent": {
+              "description": "Set to `true` if the AE costs are permanent.",
+              "const": true
+            },
+            "interval": {
+              "description": "Specified if the AE cost `value` has to be paid for each time interval.",
+              "$ref": "./_ActivatableSkill.schema.json#/definitions/Duration/UnitValue"
+            },
+            "per_level": {
+              "description": "The AE cost are per level of the enchantment. It may either be displayed\nin a compressed way (e.g. `1 AE per level`) or in a verbose way (e.g. `1\nAE for level I; 2 AE for level II`).",
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Compressed"
+                    }
+                  },
+                  "required": [
+                    "tag"
+                  ],
+                  "additionalProperties": false
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Verbose"
+                    }
+                  },
+                  "required": [
+                    "tag"
+                  ],
+                  "additionalProperties": false
+                }
+              ]
+            },
+            "translations": {
+              "description": "All translations for the entry, identified by IETF language tag\n(BCP47).",
+              "type": "object",
+              "patternProperties": {
+                "^[a-z]{2}-[A-Z]{2}$": {
+                  "type": "object",
+                  "properties": {
+                    "note": {
+                      "description": "A note, appended to the generated string in parenthesis.",
+                      "type": "object",
+                      "properties": {
+                        "default": {
+                          "description": "The full note.",
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "compressed": {
+                          "description": "A compressed note, if applicable. If not specified it should not\nbe displayed in small location.",
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "required": [
+                        "default"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "required": [],
+                  "minProperties": 1,
+                  "additionalProperties": false
+                }
+              },
+              "minProperties": 1,
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "value"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "PerCountable"
+            },
+            "value": {
+              "description": "The AE cost value that has to be per a specific countable entity.",
+              "type": "integer",
+              "minimum": 1
+            },
+            "base_value": {
+              "description": "If defined, in addition to the cost per entity you have to pay a flat\namount, regardless of the entity count.",
+              "type": "integer",
+              "minimum": 1
+            },
+            "translations": {
+              "description": "All translations for the entry, identified by IETF language tag\n(BCP47).",
+              "type": "object",
+              "patternProperties": {
+                "^[a-z]{2}-[A-Z]{2}$": {
+                  "type": "object",
+                  "properties": {
+                    "per": {
+                      "description": "The cost have to be per a specific countable entity, e.g. `8 AE per\nperson`.",
+                      "type": "object",
+                      "properties": {
+                        "default": {
+                          "description": "The full countable entity name.",
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "compressed": {
+                          "description": "The compressed countable entity name.",
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "required": [
+                        "default",
+                        "compressed"
+                      ],
+                      "additionalProperties": false
+                    },
+                    "note": {
+                      "description": "A note, appended to the generated string in parenthesis.",
+                      "type": "object",
+                      "properties": {
+                        "default": {
+                          "description": "The full note.",
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "compressed": {
+                          "description": "A compressed note, if applicable. If not specified it should not\nbe displayed in small location.",
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "required": [
+                        "default"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "required": [
+                    "per"
+                  ],
+                  "minProperties": 1,
+                  "additionalProperties": false
+                }
+              },
+              "minProperties": 1,
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "value"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ActivationAndHalfInterval"
+            },
+            "value": {
+              "description": "The AE cost value that has to be payed for activation. Half of this value\nhas to be payed each interval.",
+              "type": "integer",
+              "minimum": 2,
+              "multipleOf": 2
+            },
+            "interval": {
+              "description": "The time interval for which the AE cost `value` has to be paid.",
+              "$ref": "./_ActivatableSkill.schema.json#/definitions/Duration/UnitValue"
+            }
+          },
+          "required": [
+            "tag",
+            "value",
+            "interval"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Indefinite"
+            },
+            "modifier": {
+              "description": "The indefinite AE cost may be modified by a certain value.",
+              "type": "object",
+              "properties": {
+                "arithmetic": {
+                  "description": "The arithmetic how to apply the `value` to the indefinite base value.",
+                  "oneOf": [
+                    {
+                      "type": "object",
+                      "properties": {
+                        "tag": {
+                          "const": "Add"
+                        }
+                      },
+                      "required": [
+                        "tag"
+                      ],
+                      "additionalProperties": false
+                    },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "tag": {
+                          "const": "Multiply"
+                        }
+                      },
+                      "required": [
+                        "tag"
+                      ],
+                      "additionalProperties": false
+                    }
+                  ]
+                },
+                "value": {
+                  "description": "The value that is applied to the indefinite base value using the\ndefined `arithmetic`.",
+                  "type": "integer",
+                  "minimum": 1
+                }
+              },
+              "required": [
+                "arithmetic",
+                "value"
+              ],
+              "additionalProperties": false
+            },
+            "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": {
+                    "description": {
+                      "description": "A description of where the cost come from.",
+                      "type": "object",
+                      "properties": {
+                        "default": {
+                          "description": "The full description of where the cost come from.",
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "compressed": {
+                          "description": "A compressed description of where the cost come from for use in\nsmall areas (e.g. on character sheet).",
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "required": [
+                        "default",
+                        "compressed"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "required": [
+                    "description"
+                  ],
+                  "additionalProperties": false
+                }
+              },
+              "minProperties": 1,
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "modifier",
+            "translations"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Disjunction"
+            },
+            "interval": {
+              "description": "Specified if the selected AE cost option has to be paid for each time\ninterval.",
+              "type": "object",
+              "properties": {
+                "value": {
+                  "description": "The interval itself.",
+                  "$ref": "./_ActivatableSkill.schema.json#/definitions/Duration/UnitValue"
+                },
+                "activation_value": {
+                  "description": "The AE cost value for activation.",
+                  "type": "integer",
+                  "minimum": 1
+                },
+                "after_activation": {
+                  "description": "Set to `true` if the action where the enchantment is casted does\n**not** as a part of the first interval that has to be payed, so that\nthe first interval payment needs to be done after the activation.\n\nThis works different than other sustained spells, since for them the\nend of the cast usually already counts as part of the first interval.",
+                  "type": "boolean"
+                }
+              },
+              "required": [
+                "value",
+                "activation_value",
+                "after_activation"
+              ],
+              "additionalProperties": false
+            },
+            "options": {
+              "description": "The possible AE cost values.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "value": {
+                    "description": "A possible AE cost value.",
+                    "type": "integer",
+                    "minimum": 1
+                  },
+                  "translations": {
+                    "description": "All translations for the entry, identified by IETF language tag\n(BCP47).",
+                    "type": "object",
+                    "patternProperties": {
+                      "^[a-z]{2}-[A-Z]{2}$": {
+                        "type": "object",
+                        "properties": {
+                          "note": {
+                            "description": "A note, appended to the generated option string in parenthesis.",
+                            "type": "object",
+                            "properties": {
+                              "default": {
+                                "description": "The full note.",
+                                "type": "string",
+                                "minLength": 1
+                              },
+                              "compressed": {
+                                "description": "A compressed note, if applicable. If not specified it should not\nbe displayed in small location.",
+                                "type": "string",
+                                "minLength": 1
+                              }
+                            },
+                            "required": [
+                              "default"
+                            ],
+                            "additionalProperties": false
+                          }
+                        },
+                        "required": [],
+                        "minProperties": 1,
+                        "additionalProperties": false
+                      }
+                    },
+                    "minProperties": 1,
+                    "additionalProperties": false
+                  }
+                },
+                "required": [
+                  "value"
+                ],
+                "additionalProperties": false
+              }
+            }
+          },
+          "required": [
+            "tag",
+            "options"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "None"
+            },
+            "translations": {
+              "description": "All translations for the entry, identified by IETF language tag\n(BCP47).",
+              "type": "object",
+              "patternProperties": {
+                "^[a-z]{2}-[A-Z]{2}$": {
+                  "type": "object",
+                  "properties": {
+                    "note": {
+                      "description": "A note, appended to the generated string in parenthesis.",
+                      "type": "object",
+                      "properties": {
+                        "default": {
+                          "description": "The full note.",
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "compressed": {
+                          "description": "A compressed note, if applicable. If not specified it should not\nbe displayed in small location.",
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "required": [
+                        "default"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "required": [],
+                  "minProperties": 1,
+                  "additionalProperties": false
+                }
+              },
+              "minProperties": 1,
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Variable"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "Volume": {
+      "description": "The volume points the enchantment needs.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Fixed"
+            },
+            "points": {
+              "description": "The volume points.",
+              "type": "integer",
+              "minimum": 0
+            }
+          },
+          "required": [
+            "tag",
+            "points"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "PerLevel"
+            },
+            "points": {
+              "description": "The volume points per level.",
+              "type": "integer",
+              "minimum": 1
+            }
+          },
+          "required": [
+            "tag",
+            "points"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByLevel"
+            },
+            "list": {
+              "description": "The volume points for each level. The first element is the volume points\nfor the first level, the second element is the volume points for the\nsecond level, and so on.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "points": {
+                    "description": "The volume points for this level.",
+                    "type": "integer",
+                    "minimum": 0
+                  }
+                },
+                "required": [
+                  "points"
+                ],
+                "additionalProperties": false
+              },
+              "minItems": 2
+            }
+          },
+          "required": [
+            "tag",
+            "list"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Map"
+            },
+            "map": {
+              "$ref": "#/definitions/VolumeMap"
+            }
+          },
+          "required": [
+            "tag",
+            "map"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "VolumeMap": {
+      "description": "A content that is `3/4/5 Points for Chimera, Daimonid, Golems, Undead /\nFairies, Ghosts / Demons, Elementals` may be respresented as the following\nmap:\n\n```yaml\noptions:\n  - points: 3\n    associated_options:\n      - id:\n          tag: General\n          value: # ...\n      # ...\n    translations:\n      en-US:\n        label: \"Chimera, Daimonid, Golems, Undead\"\n        label_standalone: \"Chimera/Daimonid/Golems/Undead\"\n  - points: 4\n    associated_options:\n      - id:\n          tag: General\n          value: # ...\n      # ...\n    translations:\n      en-US:\n        label: \"Fairies, Ghosts\"\n        label_standalone: \"Fairies/Ghosts\"\n  - points: 5\n    associated_options:\n      - id:\n          tag: General\n          value: # ...\n      # ...\n    translations:\n      en-US:\n        label: \"Demons, Elementals\"\n        label_standalone: \"Demons/Elementals\"\n```\n\nThis will generate the exact same string as seen above. The associated\noptions are not present in the example, but they link to the options the\nvolume specification is meant for.",
+      "type": "object",
+      "properties": {
+        "options": {
+          "description": "The possible costs and associated labels.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/VolumeMapOption"
+          },
+          "minItems": 2
+        },
+        "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": {
+                "list_prepend": {
+                  "description": "Place a string between the `for` and the grouped map option labels.",
+                  "type": "string"
+                },
+                "list_append": {
+                  "description": "Place a string after the grouped map option labels.",
+                  "type": "string"
+                },
+                "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.",
+                  "type": "string"
+                }
+              },
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "options"
+      ],
+      "additionalProperties": false
+    },
+    "VolumeMapOption": {
+      "type": "object",
+      "properties": {
+        "points": {
+          "description": "The full permanent AE cost value for this option.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "associated_options": {
+          "description": "Links to the options this volume specification is meant for.",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "description": "The option's identifier.",
+                "$ref": "./_Identifier.schema.json#/definitions/Identifier/Group/VolumePointsOptionReference"
+              }
+            },
+            "required": [
+              "id"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "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": {
+                "label": {
+                  "description": "The description of the option for cost string generation.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "label_standalone": {
+                  "description": "The description of the option if used standalone. Only used if\ndifferent from `label`.",
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "label"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "points",
+        "associated_options"
+      ],
+      "additionalProperties": false
+    },
+    "BindingCost": {
+      "description": "The binding cost for an enchantment.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Fixed"
+            },
+            "permanent_value": {
+              "description": "The permanent AE cost.",
+              "type": "integer",
+              "minimum": 1
+            }
+          },
+          "required": [
+            "tag",
+            "permanent_value"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "PerLevel"
+            },
+            "permanent_value": {
+              "description": "The permanent AE cost per level.",
+              "type": "integer",
+              "minimum": 1
+            }
+          },
+          "required": [
+            "tag",
+            "permanent_value"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Map"
+            },
+            "map": {
+              "$ref": "#/definitions/BindingCostMap"
+            }
+          },
+          "required": [
+            "tag",
+            "map"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "BindingCostMap": {
+      "description": "A content that is `2/4/8 permanent AE for spell-swords with the combat\ntechnique Daggers, Swords, or Two-Handed Swords` may be respresented as the\nfollowing map:\n\n```yaml\noptions:\n  - permanent_value: 2\n    translations:\n      en-US:\n        label: \"Daggers\"\n        label_standalone: \"Dagger\"\n  - permanent_value: 4\n    translations:\n      en-US:\n        label: \"Swords\"\n        label_standalone: \"Sword\"\n  - permanent_value: 8\n    translations:\n      en-US:\n        label: \"Two-Handed Swords\"\n        label_standalone: \"Two-Handed Sword\"\nlist_prepend: \"spell-swords with the combat technique\"\n```\n\nThis will generate the exact same string as seen above.",
+      "type": "object",
+      "properties": {
+        "options": {
+          "description": "The possible costs and associated labels.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/VolumeMapOption"
+          },
+          "minItems": 2
+        },
+        "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": {
+                "list_prepend": {
+                  "description": "Place a string between the `for` and the grouped map option labels.",
+                  "type": "string"
+                },
+                "list_append": {
+                  "description": "Place a string after the grouped map option labels.",
+                  "type": "string"
+                },
+                "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.",
+                  "type": "string"
+                }
+              },
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "options"
+      ],
+      "additionalProperties": false
+    },
+    "BindingCostMapOption": {
+      "type": "object",
+      "properties": {
+        "permanent_value": {
+          "description": "The full permanent AE cost value for this option.",
+          "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": {
+                "label": {
+                  "description": "The description of the option for cost string generation.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "label_standalone": {
+                  "description": "The description of the option if used standalone. Only used if\ndifferent from `label`.",
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "label"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "permanent_value"
+      ],
+      "additionalProperties": false
     },
     "Property": {
       "description": "The magic property's identifier. `DependingOnProperty` can only be used if\nthe special ability has an option to select a property.",