optolith-database-schema 0.0.1

package/schema/magicalActions/ZibiljaRitual.schema.json

@@ -0,0 +1,159 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "magicalActions/ZibiljaRitual.schema.json",
+  "$ref": "#/definitions/ZibiljaRitual",
+  "definitions": {
+    "ZibiljaRitual": {
+      "title": "Zibilja Ritual",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The zibilja ritual'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"
+        },
+        "parameters": {
+          "description": "Measurable parameters of a zibilja ritual.",
+          "$ref": "../_ActivatableSkill.schema.json#/definitions/PerformanceParameters"
+        },
+        "target": {
+          "description": "The target category – the kind of creature or object – the skill affects.",
+          "$ref": "../_ActivatableSkill.schema.json#/definitions/TargetCategory/T"
+        },
+        "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 zibilja ritual.",
+                  "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"
+                },
+                "casting_time": {
+                  "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
+                },
+                "range": {
+                  "type": "object",
+                  "properties": {
+                    "full": {
+                      "type": "string"
+                    },
+                    "abbr": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "full",
+                    "abbr"
+                  ],
+                  "additionalProperties": false
+                },
+                "duration": {
+                  "type": "object",
+                  "properties": {
+                    "full": {
+                      "type": "string"
+                    },
+                    "abbr": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "full",
+                    "abbr"
+                  ],
+                  "additionalProperties": false
+                },
+                "target": {
+                  "type": "string"
+                },
+                "errata": {
+                  "$ref": "../source/_Erratum.schema.json#/definitions/Errata"
+                }
+              },
+              "required": [
+                "name",
+                "effect",
+                "casting_time",
+                "cost",
+                "range",
+                "duration",
+                "target"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "check",
+        "parameters",
+        "target",
+        "property_id",
+        "improvement_cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/magicalActions/_MusicTradition.schema.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "magicalActions/_MusicTradition.schema.json",
+  "definitions": {
+    "MusicTraditionReference": {
+      "description": "A reference to a music tradition with the music-tradition-specific name of\nthe entry",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The music tradition's identifier.",
+          "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": {
+                "name": {
+                  "description": "The music-tradition-specific name of the entry.",
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/magicalActions/_SkillReference.schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "magicalActions/_SkillReference.schema.json",
+  "definitions": {
+    "SkillReference": {
+      "description": "A reference to a skill used for performing melodies.",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The skill's identifier.",
+          "$ref": "#/definitions/SkillIdentifier"
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "additionalProperties": false
+    },
+    "SkillIdentifier": {
+      "enum": [
+        9,
+        56
+      ]
+    }
+  }
+}

package/schema/rule/FocusRule.schema.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "rule/FocusRule.schema.json",
+  "$ref": "#/definitions/FocusRule",
+  "definitions": {
+    "FocusRule": {
+      "title": "Focus Rule",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The focus rule's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "subject_id": {
+          "description": "The focus rule's subject's identifier.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "level": {
+          "description": "The focus rule's level.",
+          "type": "integer",
+          "maximum": 4,
+          "minimum": 1
+        },
+        "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 focus rule.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "description": {
+                  "description": "The description of the focus rule.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "errata": {
+                  "$ref": "../source/_Erratum.schema.json#/definitions/Errata"
+                }
+              },
+              "required": [
+                "name",
+                "description"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "subject_id",
+        "level",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/rule/FocusRule_Subject.schema.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "rule/FocusRule_Subject.schema.json",
+  "$ref": "#/definitions/Subject",
+  "definitions": {
+    "Subject": {
+      "title": "Subject",
+      "description": "Subjects or Subject Areas are the categories of Focus Rules.",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The subject's identifier. An unique, increasing integer.",
+          "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": {
+                "name": {
+                  "description": "The subject.",
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/rule/OptionalRule.schema.json

@@ -0,0 +1,96 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "rule/OptionalRule.schema.json",
+  "$ref": "#/definitions/OptionalRule",
+  "definitions": {
+    "OptionalRule": {
+      "title": "Optional Rule",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The optional rule's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "relevance": {
+          "description": "The relevance of the optional rule for Optolith. It may be that it\ninfluences character creating but it may also just influnce the character\nsheet. If it is linked to systems in Optolith, it may be specified if this\nrule has not been implemented in Optolith yet.",
+          "$ref": "#/definitions/Relevance"
+        },
+        "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 optional rule.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "description": {
+                  "description": "The description of the optional rule.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "errata": {
+                  "$ref": "../source/_Erratum.schema.json#/definitions/Errata"
+                }
+              },
+              "required": [
+                "name",
+                "description"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "relevance",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "Relevance": {
+      "description": "The relevance of the optional rule for Optolith. It may be that it influences\ncharacter creating but it may also just influnce the character sheet. If it\nis linked to systems in Optolith, it may be specified if this rule has not\nbeen implemented in Optolith yet.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Extraneous"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Linked"
+            },
+            "isMissingImplementation": {
+              "description": "Does the optional rule have an impact on character creation or character\nsheet and this effect has not been implemented in Optolith yet? If\n`true`, the optional rule cannot be activated.",
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  }
+}

package/schema/source/Publication.schema.json

@@ -0,0 +1,165 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "source/Publication.schema.json",
+  "$ref": "#/definitions/Publication",
+  "definitions": {
+    "Publication": {
+      "title": "Publication",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The publication's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "category": {
+          "description": "The publication category.",
+          "$ref": "#/definitions/Category"
+        },
+        "age_restriction": {
+          "description": "The age the content is restricted to.",
+          "$ref": "#/definitions/AgeRestriction"
+        },
+        "is_missing_implementation": {
+          "description": "The publication is not (fully) implemented and thus needs to be excluded\nfrom * stable releases.",
+          "type": "boolean"
+        },
+        "prerequisites": {
+          "description": "The specific other publications this publication depends on data from.",
+          "$ref": "../_Prerequisite.schema.json#/definitions/GroupCollection/Publication"
+        },
+        "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": {
+                "id": {
+                  "description": "The publisher's publication identifier.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "name": {
+                  "description": "The publication's name.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "abbreviation": {
+                  "description": "The publication's abbreviation.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "release_date": {
+                  "description": "The publication's release date.",
+                  "type": "string",
+                  "format": "date"
+                },
+                "is_missing_implementation": {
+                  "description": "This publication translation is not (fully) implemented and thus needs to\nbe excluded from stable releases.",
+                  "type": "boolean"
+                }
+              },
+              "required": [
+                "name",
+                "abbreviation"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "category",
+        "age_restriction",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "Category": {
+      "description": "The publication category.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "CoreRules"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ExpansionRules"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Sourcebook"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "RegionalSourcebook"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "AgeRestriction": {
+      "description": "The age the content is restricted to.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Adult"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "None"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  }
+}

package/schema/source/_Erratum.schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "source/_Erratum.schema.json",
+  "$ref": "#/definitions/Errata",
+  "definitions": {
+    "Errata": {
+      "title": "Errata",
+      "description": "A list of errata for the entry in the specific language.",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Erratum"
+      },
+      "minItems": 1
+    },
+    "Erratum": {
+      "title": "Erratum",
+      "type": "object",
+      "properties": {
+        "date": {
+          "description": "The date when the change was confirmed and applied to the entry.",
+          "type": "string",
+          "format": "date"
+        },
+        "description": {
+          "description": "A description of what changed.",
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": [
+        "date",
+        "description"
+      ],
+      "additionalProperties": false
+    }
+  }
+}