mirrors/EXDSchema
1
Fork 0
mirror of https://github.com/xivdev/EXDSchema.git synced 2025-06-06 16:17:46 +00:00
Code Activity

Add schema

Browse source
This commit is contained in:
Asriel Camora 2025-03-05 17:38:07 -08:00
parent 48db4b87e3
commit 33c6a128e7
2 changed files with 294 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
.vscode/settings.json vendored Normal file
View file

@ -0,0 +1,7 @@
{
"yaml.schemas": {
"schema.json": [
"*.yml"
]
}
}

287
schema.json Normal file
View file

@ -0,0 +1,287 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "EXDSchema",
"type": "object",
"additionalProperties": false,
"required": [
"name",
"fields"
],
"properties": {
"name": {
"description": "Name of the underlying .exd sheet",
"type": "string",
"pattern": "^\\w+$"
},
"displayField": {
"description": "Field to display in a UI. Completely optional, but must link to a valid top-level field name.",
"type": "string",
"pattern": "^\\w+$"
},
"fields": {
"description": "A list of fields in the sheet, ordered by offset",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"$ref": "#/$defs/namedField"
}
},
"relations": {
"$ref": "#/$defs/relations"
}
},
"$defs": {
"baseField": {
"type": "object",
"properties": {
"type": {
"description": "Type of the field",
"type": "string",
"enum": [
"scalar",
"link",
"array",
"icon",
"modelId",
"color"
],
"default": "scalar"
},
"comment": {
"description": "Developer-readable comment",
"type": "string"
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "scalar"
}
}
},
"then": {}
},
{
"if": {
"properties": {
"type": {
"const": "link"
}
},
"required": [
"type"
]
},
"then": {
"oneOf": [
{
"properties": {
"targets": {
"description": "List of sheets that this field links to",
"type": "array",
"minItems": 1,
"items": {
"description": "Sheet name",
"type": "string",
"pattern": "^\\w+$"
}
}
},
"required": [
"targets"
]
},
{
"properties": {
"condition": {
"description": "Switch case conditional for what sheet(s) this field links to, based on the value of 'switch'",
"type": "object",
"additionalProperties": false,
"required": [
"switch",
"cases"
],
"properties": {
"switch": {
"description": "Field to switch on",
"type": "string",
"pattern": "^\\w+$"
},
"cases": {
"description": "List of cases to switch on. The key is switch's value, and the value is a list of sheet names",
"type": "object",
"patternProperties": {
"^[1-9]\\d*$": {
"type": "array",
"minItems": 1,
"items": {
"description": "Sheet name",
"type": "string",
"pattern": "^\\w+$"
}
}
}
}
}
}
},
"required": [
"condition"
]
}
]
}
},
{
"if": {
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"required": [
"count"
],
"properties": {
"count": {
"description": "Number of elements in the array",
"type": "number",
"exclusiveMinimum": 1
},
"fields": {
"type": "array",
"uniqueItems": true,
"minItems": 1
},
"relations": {
"$ref": "#/$defs/relations"
}
},
"if": {
"properties": {
"fields": {
"type": "array",
"maxItems": 1
}
}
},
"then": {
"properties": {
"fields": {
"type": "array",
"description": "Field type of the array (single item per array element)",
"items": {
"$ref": "#/$defs/unnamedField"
}
}
}
},
"else": {
"properties": {
"fields": {
"type": "array",
"description": "Fields in the array (multiple items per array element)",
"items": {
"$ref": "#/$defs/namedField"
}
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "icon"
}
},
"required": [
"type"
]
},
"then": {}
},
{
"if": {
"properties": {
"type": {
"const": "modelId"
}
},
"required": [
"type"
]
},
"then": {}
},
{
"if": {
"properties": {
"type": {
"const": "color"
}
},
"required": [
"type"
]
},
"then": {}
}
]
},
"unnamedField": {
"type": "object",
"unevaluatedProperties": false,
"allOf": [
{
"$ref": "#/$defs/baseField"
}
]
},
"namedField": {
"type": "object",
"unevaluatedProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"description": "Name of the field",
"type": "string",
"pattern": "^\\w+$"
}
},
"allOf": [
{
"$ref": "#/$defs/baseField"
}
]
},
"relations": {
"description": "Relations between fields in the sheet. Helps with the https://en.wikipedia.org/wiki/AoS_and_SoA problem.",
"type": "object",
"unevaluatedProperties": false,
"patternProperties": {
"^\\w+$": {
"description": "List of fields to move into a relation. All fields must be arrays that have the same count.",
"type": "array",
"minItems": 1,
"items": {
"description": "Field name (cannot be nested)",
"type": "string",
"pattern": "^\\w+$"
}
}
}
}
}
}