optolith-database-schema 0.0.1

package/schema/magicalActions/MagicalMelody.schema.json

@@ -0,0 +1,254 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "magicalActions/MagicalMelody.schema.json",
+  "$ref": "#/definitions/MagicalMelody",
+  "definitions": {
+    "MagicalMelody": {
+      "title": "Magical Melody",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The magical melody's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "check": {
+          "description": "Lists the linked three attributes used to make a skill check.",
+          "$ref": "../_SkillCheck.schema.json#/definitions/SkillCheck"
+        },
+        "check_penalty": {
+          "description": "In some cases, the target's Spirit or Toughness is applied as a penalty.",
+          "$ref": "../_SkillCheck.schema.json#/definitions/SkillCheckPenalty"
+        },
+        "skill": {
+          "description": "Arcane bards must make a *Singing (area of application)* or *Music (area of\napplication)* check for each magical melody.",
+          "type": "array",
+          "items": {
+            "$ref": "./_SkillReference.schema.json#/definitions/SkillReference"
+          },
+          "minItems": 1,
+          "maxItems": 2,
+          "uniqueItems": true
+        },
+        "parameters": {
+          "description": "Measurable parameters of a magical melody.",
+          "$ref": "#/definitions/PerformanceParameters"
+        },
+        "property_id": {
+          "description": "The property's identifier.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "music_tradition": {
+          "description": "The music tradition(s) the magical melody is available for. This also\ndefines the different names in each music tradition.",
+          "type": "array",
+          "items": {
+            "$ref": "./_MusicTradition.schema.json#/definitions/MusicTraditionReference"
+          },
+          "minItems": 1
+        },
+        "improvement_cost": {
+          "description": "States which column is used to improve the skill.",
+          "$ref": "../_ImprovementCost.schema.json#/definitions/ImprovementCost"
+        },
+        "src": {
+          "$ref": "../source/_PublicationRef.schema.json#/definitions/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The name of the magical melody.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "effect": {
+                  "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.",
+                  "$ref": "../_ActivatableSkill.schema.json#/definitions/Effect/T"
+                },
+                "duration": {
+                  "type": "object",
+                  "properties": {
+                    "full": {
+                      "type": "string"
+                    },
+                    "abbr": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "full",
+                    "abbr"
+                  ],
+                  "additionalProperties": false
+                },
+                "cost": {
+                  "type": "object",
+                  "properties": {
+                    "full": {
+                      "type": "string"
+                    },
+                    "abbr": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "full",
+                    "abbr"
+                  ],
+                  "additionalProperties": false
+                },
+                "errata": {
+                  "$ref": "../source/_Erratum.schema.json#/definitions/Errata"
+                }
+              },
+              "required": [
+                "name",
+                "effect",
+                "duration",
+                "cost"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "check",
+        "skill",
+        "parameters",
+        "property_id",
+        "music_tradition",
+        "improvement_cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "PerformanceParameters": {
+      "description": "Measurable parameters of a magical melody.",
+      "type": "object",
+      "properties": {
+        "duration": {
+          "type": "object",
+          "properties": {
+            "length": {
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Long"
+                    }
+                  },
+                  "required": [
+                    "tag"
+                  ],
+                  "additionalProperties": false
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Short"
+                    }
+                  },
+                  "required": [
+                    "tag"
+                  ],
+                  "additionalProperties": false
+                }
+              ]
+            },
+            "reusability": {
+              "oneOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "OneTime"
+                    }
+                  },
+                  "required": [
+                    "tag"
+                  ],
+                  "additionalProperties": false
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "tag": {
+                      "const": "Sustainable"
+                    }
+                  },
+                  "required": [
+                    "tag"
+                  ],
+                  "additionalProperties": false
+                }
+              ]
+            }
+          },
+          "required": [
+            "length",
+            "reusability"
+          ],
+          "additionalProperties": false
+        },
+        "cost": {
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Fixed"
+                },
+                "value": {
+                  "description": "The (temporary) AE cost value.",
+                  "type": "integer",
+                  "minimum": 1
+                }
+              },
+              "required": [
+                "tag",
+                "value"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "FirstPerson"
+                },
+                "value": {
+                  "description": "The (temporary) AE cost value for the first targeted person. The AE\ncost for each additional person is half this value.",
+                  "type": "integer",
+                  "minimum": 1,
+                  "multipleOf": 2
+                }
+              },
+              "required": [
+                "tag",
+                "value"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        }
+      },
+      "required": [
+        "duration",
+        "cost"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/magicalActions/MagicalRune.schema.json

@@ -0,0 +1,426 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "magicalActions/MagicalRune.schema.json",
+  "$ref": "#/definitions/MagicalRune",
+  "definitions": {
+    "MagicalRune": {
+      "title": "Magical Rune",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The magical rune's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "check": {
+          "description": "Lists the linked three attributes used to make a skill check.",
+          "$ref": "../_SkillCheck.schema.json#/definitions/SkillCheck"
+        },
+        "check_penalty": {
+          "description": "In some cases, the target's Spirit or Toughness is applied as a penalty.",
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "CloseCombatTechnique"
+                },
+                "map": {
+                  "description": "A map from close combat techniques to their modifiers.",
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "combat_technique_id": {
+                        "description": "The close combat technique's identifier.",
+                        "type": "integer",
+                        "minimum": 1
+                      },
+                      "modifier": {
+                        "description": "The check modifier for the specified close combat technique.",
+                        "type": "integer"
+                      }
+                    },
+                    "required": [
+                      "combat_technique_id",
+                      "modifier"
+                    ],
+                    "additionalProperties": false
+                  },
+                  "minItems": 1
+                },
+                "other": {
+                  "type": "object",
+                  "properties": {
+                    "modifier": {
+                      "description": "The check modifier for close combat techniques not specified in\n`map`.",
+                      "type": "integer"
+                    }
+                  },
+                  "required": [
+                    "modifier"
+                  ],
+                  "additionalProperties": false
+                }
+              },
+              "required": [
+                "tag",
+                "map",
+                "other"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "parameters": {
+          "description": "Measurable parameters of a magical rune.",
+          "$ref": "#/definitions/PerformanceParameters"
+        },
+        "property_id": {
+          "description": "The property's identifier.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "improvement_cost": {
+          "description": "States which column is used to improve the skill.",
+          "$ref": "../_ImprovementCost.schema.json#/definitions/ImprovementCost"
+        },
+        "src": {
+          "$ref": "../source/_PublicationRef.schema.json#/definitions/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The name of the magical rune.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "native_name": {
+                  "description": "The native name of the magical rune.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "effect": {
+                  "description": "The effect description may be either a plain text or a text that is\ndivided by a list of effects for each quality level. It may also be a\nlist for each two quality levels.",
+                  "$ref": "../_ActivatableSkill.schema.json#/definitions/Effect/T"
+                },
+                "cost": {
+                  "type": "object",
+                  "properties": {
+                    "full": {
+                      "type": "string"
+                    },
+                    "abbr": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "full",
+                    "abbr"
+                  ],
+                  "additionalProperties": false
+                },
+                "crafting_time": {
+                  "type": "object",
+                  "properties": {
+                    "slow": {
+                      "type": "object",
+                      "properties": {
+                        "full": {
+                          "type": "string"
+                        },
+                        "abbr": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "full",
+                        "abbr"
+                      ],
+                      "additionalProperties": false
+                    },
+                    "fast": {
+                      "type": "object",
+                      "properties": {
+                        "full": {
+                          "type": "string"
+                        },
+                        "abbr": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "full",
+                        "abbr"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "required": [
+                    "slow",
+                    "fast"
+                  ],
+                  "additionalProperties": false
+                },
+                "duration": {
+                  "type": "object",
+                  "properties": {
+                    "slow": {
+                      "type": "object",
+                      "properties": {
+                        "full": {
+                          "type": "string"
+                        },
+                        "abbr": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "full",
+                        "abbr"
+                      ],
+                      "additionalProperties": false
+                    },
+                    "fast": {
+                      "type": "object",
+                      "properties": {
+                        "full": {
+                          "type": "string"
+                        },
+                        "abbr": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "full",
+                        "abbr"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "required": [
+                    "slow",
+                    "fast"
+                  ],
+                  "additionalProperties": false
+                },
+                "errata": {
+                  "$ref": "../source/_Erratum.schema.json#/definitions/Errata"
+                }
+              },
+              "required": [
+                "name",
+                "native_name",
+                "effect",
+                "cost",
+                "crafting_time",
+                "duration"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "check",
+        "parameters",
+        "property_id",
+        "improvement_cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "PerformanceParameters": {
+      "description": "Measurable parameters of a magical rune.",
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The AE cost.",
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Single"
+                },
+                "value": {
+                  "description": "The 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 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": "Disjunction"
+                },
+                "list": {
+                  "description": "A set of possible AE cost values.",
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "value": {
+                        "description": "The AE cost value.",
+                        "type": "integer",
+                        "minimum": 1
+                      }
+                    },
+                    "required": [
+                      "value"
+                    ],
+                    "additionalProperties": false
+                  },
+                  "minItems": 2
+                }
+              },
+              "required": [
+                "tag",
+                "list"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "crafting_time": {
+          "description": "The crafting time.",
+          "type": "object",
+          "properties": {
+            "value": {
+              "description": "The (unitless) crafting time.",
+              "oneOf": [
+                {
+                  "const": 1
+                },
+                {
+                  "const": 2
+                },
+                {
+                  "const": 4
+                }
+              ]
+            },
+            "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": {
+                    "per": {
+                      "description": "The crafting time has to be per a specific countable entity, e.g. `8\naction per person`.",
+                      "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
+                    }
+                  },
+                  "required": [],
+                  "minProperties": 1,
+                  "additionalProperties": false
+                }
+              },
+              "minProperties": 1,
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "value"
+          ],
+          "additionalProperties": false
+        },
+        "duration": {
+          "description": "The duration.",
+          "type": "object",
+          "properties": {
+            "slow": {
+              "description": "The duration on slow rune application.",
+              "$ref": "../_ActivatableSkill.schema.json#/definitions/Duration/CheckResultBased"
+            },
+            "fast": {
+              "description": "The duration on fast rune application.",
+              "$ref": "../_ActivatableSkill.schema.json#/definitions/Duration/CheckResultBased"
+            }
+          },
+          "required": [
+            "slow",
+            "fast"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "crafting_time",
+        "duration"
+      ],
+      "additionalProperties": false
+    }
+  }
+}