5etools-utils 0.2.2 → 0.3.0

package/schema/brew/vehicles.json

@@ -0,0 +1,854 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "vehicles.json",
+	"version": "1.7.0",
+	"type": "object",
+	"$defs": {
+		"vehicleTerrain": {
+			"description": "Note that a vehicle's \"primary\" terrain should be listed first.",
+			"type": "array",
+			"items": {
+				"type": "string",
+				"examples": [
+					"land",
+					"sea",
+					"air",
+					"space"
+				]
+			}
+		},
+		"_vehicleCost": {
+			"description": "In copper pieces.",
+			"type": "number"
+		},
+		"spelljammerPaceObj": {
+			"type": "object",
+			"properties": {
+				"walk": {
+					"$ref": "#/$defs/_spelljammerPace"
+				},
+				"burrow": {
+					"$ref": "#/$defs/_spelljammerPace"
+				},
+				"climb": {
+					"$ref": "#/$defs/_spelljammerPace"
+				},
+				"fly": {
+					"$ref": "#/$defs/_spelljammerPace"
+				},
+				"swim": {
+					"$ref": "#/$defs/_spelljammerPace"
+				}
+			},
+			"additionalProperties": false
+		},
+		"_spelljammerPace": {
+			"type": [
+				"string",
+				"number"
+			]
+		},
+		"vehicle": {
+			"oneOf": [
+				{
+					"$ref": "#/$defs/vehicleShip"
+				},
+				{
+					"$ref": "#/$defs/vehicleSpelljammer"
+				},
+				{
+					"$ref": "#/$defs/vehicleInfernalWarMachine"
+				},
+				{
+					"$ref": "#/$defs/vehicleCreature"
+				},
+				{
+					"$ref": "#/$defs/vehicleObject"
+				}
+			]
+		},
+		"vehicleUpgrade": {
+			"type": "object",
+			"properties": {
+				"name": {
+					"type": "string"
+				},
+				"entries": {
+					"type": "array",
+					"items": {
+						"$ref": "entry.json"
+					}
+				},
+				"source": {
+					"type": "string"
+				},
+				"page": {
+					"$ref": "util.json#/$defs/page"
+				},
+				"otherSources": {
+					"$ref": "util.json#/$defs/otherSources"
+				},
+				"upgradeType": {
+					"type": "array",
+					"items": {
+						"$ref": "util.json#/$defs/dataOptionalfeatureType",
+						"type": "string"
+					}
+				},
+				"hasFluff": {
+					"type": "boolean"
+				},
+				"hasFluffImages": {
+					"type": "boolean"
+				}
+			},
+			"required": [
+				"name",
+				"entries",
+				"source",
+				"upgradeType"
+			],
+			"additionalProperties": false
+		},
+		"vehicleShip": {
+			"type": "object",
+			"properties": {
+				"name": {
+					"type": "string"
+				},
+				"source": {
+					"type": "string"
+				},
+				"page": {
+					"$ref": "util.json#/$defs/page"
+				},
+				"otherSources": {
+					"$ref": "util.json#/$defs/otherSources"
+				},
+				"vehicleType": {
+					"const": "SHIP"
+				},
+				"terrain": {
+					"$ref": "#/$defs/vehicleTerrain"
+				},
+				"size": {
+					"type": "string"
+				},
+				"dimensions": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"capCrew": {
+					"type": "integer"
+				},
+				"capPassenger": {
+					"type": "integer"
+				},
+				"capCargo": {
+					"type": [
+						"number",
+						"string"
+					]
+				},
+				"pace": {
+					"type": [
+						"number"
+					]
+				},
+				"str": {
+					"type": "integer"
+				},
+				"dex": {
+					"type": "integer"
+				},
+				"con": {
+					"type": "integer"
+				},
+				"int": {
+					"type": "integer"
+				},
+				"wis": {
+					"type": "integer"
+				},
+				"cha": {
+					"type": "integer"
+				},
+				"conditionImmune": {
+					"type": "array",
+					"items": {
+						"$ref": "entry.json#/$defs/dataCondImmune"
+					}
+				},
+				"immune": {
+					"type": "array",
+					"items": {
+						"$ref": "entry.json#/$defs/dataDamImmune"
+					}
+				},
+				"actionThresholds": {
+					"type": "object",
+					"description": "A map of \"number of vehicle actions\": \"number of remaining crew members\"",
+					"patternProperties": {
+						"\\d+": {
+							"type": "integer"
+						}
+					}
+				},
+				"action": {
+					"type": "array",
+					"items": {
+						"$ref": "entry.json"
+					}
+				},
+				"hull": {
+					"type": "object",
+					"properties": {
+						"ac": {
+							"type": "integer"
+						},
+						"hp": {
+							"type": "integer"
+						},
+						"hpNote": {
+							"type": "string"
+						},
+						"dt": {
+							"type": "integer",
+							"description": "Damage Threshold"
+						}
+					},
+					"required": [
+						"ac",
+						"hp"
+					],
+					"additionalProperties": false
+				},
+				"control": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"name": {
+								"type": "string"
+							},
+							"ac": {
+								"type": "integer"
+							},
+							"hp": {
+								"type": "integer"
+							},
+							"dt": {
+								"type": "integer",
+								"description": "Damage Threshold"
+							},
+							"entries": {
+								"type": "array",
+								"items": {
+									"$ref": "entry.json"
+								}
+							}
+						},
+						"required": [
+							"ac",
+							"hp",
+							"entries"
+						],
+						"additionalProperties": false
+					}
+				},
+				"movement": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"name": {
+								"type": "string"
+							},
+							"isControl": {
+								"type": "boolean"
+							},
+							"ac": {
+								"type": "integer"
+							},
+							"hp": {
+								"type": "integer"
+							},
+							"hpNote": {
+								"type": "string"
+							},
+							"dt": {
+								"type": "integer",
+								"description": "Damage Threshold"
+							},
+							"locomotion": {
+								"description": "Legacy format, from the original UA release.",
+								"type": "array",
+								"items": {
+									"type": "object",
+									"properties": {
+										"mode": {
+											"type": "string"
+										},
+										"entries": {
+											"type": "array",
+											"items": {
+												"$ref": "entry.json"
+											}
+										}
+									},
+									"required": [
+										"mode",
+										"entries"
+									],
+									"additionalProperties": false
+								}
+							},
+							"speed": {
+								"type": "array",
+								"items": {
+									"type": "object",
+									"properties": {
+										"mode": {
+											"type": "string"
+										},
+										"entries": {
+											"type": "array",
+											"items": {
+												"$ref": "entry.json"
+											}
+										}
+									},
+									"required": [
+										"mode",
+										"entries"
+									],
+									"additionalProperties": false
+								}
+							}
+						},
+						"required": [
+							"ac",
+							"hp"
+						],
+						"additionalProperties": false
+					}
+				},
+				"weapon": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"name": {
+								"type": "string"
+							},
+							"ac": {
+								"type": "integer"
+							},
+							"hp": {
+								"type": "integer"
+							},
+							"count": {
+								"type": "integer"
+							},
+							"dt": {
+								"type": "integer",
+								"description": "Damage Threshold"
+							},
+							"entries": {
+								"type": "array",
+								"items": {
+									"$ref": "entry.json"
+								}
+							}
+						},
+						"required": [
+							"name",
+							"entries"
+						],
+						"additionalProperties": false
+					}
+				},
+				"other": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"name": {
+								"type": "string"
+							},
+							"entries": {
+								"type": "array",
+								"items": {
+									"$ref": "entry.json"
+								}
+							}
+						},
+						"required": [
+							"entries"
+						],
+						"additionalProperties": false
+					}
+				},
+				"trait": {
+					"oneOf": [
+						{
+							"type": "array",
+							"items": {
+								"type": "object",
+								"properties": {
+									"name": {
+										"type": "string"
+									},
+									"entries": {
+										"type": "array",
+										"items": {
+											"$ref": "entry.json"
+										}
+									},
+									"type": {
+										"type": "string",
+										"enum": [
+											"entries",
+											"inset"
+										]
+									},
+									"sort": {
+										"description": "Forces a sort order. Traits with sort orders will always be arranged before those without.",
+										"type": "integer"
+									}
+								},
+								"required": [
+									"name",
+									"entries"
+								],
+								"additionalProperties": false
+							}
+						},
+						{
+							"type": "null"
+						}
+					]
+				},
+				"hasToken": {
+					"type": "boolean"
+				},
+				"hasFluff": {
+					"type": "boolean"
+				},
+				"hasFluffImages": {
+					"type": "boolean"
+				},
+				"fluff": {
+					"description": "This is intended to be used for Homebrew only - site data should include a fluff file per source",
+					"$ref": "util.json#/$defs/fluffObject"
+				},
+				"tokenUrl": {
+					"type": "string"
+				},
+				"foundrySystem": {
+					"$ref": "util.json#/$defs/foundrySystemObject"
+				},
+				"foundryFlags": {
+					"$ref": "util.json#/$defs/foundryFlagsObject"
+				},
+				"foundryImg": {
+					"$ref": "util.json#/$defs/foundryImg"
+				}
+			},
+			"required": [
+				"name",
+				"source"
+			],
+			"additionalProperties": false
+		},
+		"vehicleSpelljammer": {
+			"type": "object",
+			"properties": {
+				"name": {
+					"type": "string"
+				},
+				"source": {
+					"type": "string"
+				},
+				"page": {
+					"$ref": "util.json#/$defs/page"
+				},
+				"otherSources": {
+					"$ref": "util.json#/$defs/otherSources"
+				},
+				"vehicleType": {
+					"const": "SPELLJAMMER"
+				},
+				"terrain": {
+					"$ref": "#/$defs/vehicleTerrain"
+				},
+				"dimensions": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"capCrew": {
+					"type": "integer"
+				},
+				"capCrewNote": {
+					"type": "string"
+				},
+				"capCargo": {
+					"type": [
+						"number",
+						"string"
+					]
+				},
+				"pace": {
+					"$ref": "#/$defs/spelljammerPaceObj"
+				},
+				"speed": {
+					"$ref": "util.json#/$defs/speed"
+				},
+				"hull": {
+					"type": "object",
+					"properties": {
+						"ac": {
+							"type": "integer"
+						},
+						"acFrom": {
+							"type": "array",
+							"items": {
+								"type": "string"
+							}
+						},
+						"hp": {
+							"type": "integer"
+						},
+						"dt": {
+							"type": "integer",
+							"description": "Damage Threshold"
+						}
+					},
+					"required": [
+						"ac",
+						"hp"
+					],
+					"additionalProperties": false
+				},
+				"cost": {
+					"$ref": "#/$defs/_vehicleCost"
+				},
+				"weapon": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"name": {
+								"type": "string"
+							},
+							"ac": {
+								"type": "integer"
+							},
+							"hp": {
+								"type": "integer"
+							},
+							"count": {
+								"type": "integer"
+							},
+							"crew": {
+								"type": "integer"
+							},
+							"costs": {
+								"type": "array",
+								"items": {
+									"type": "object",
+									"properties": {
+										"cost": {
+											"$ref": "#/$defs/_vehicleCost"
+										},
+										"note": {
+											"type": "string"
+										}
+									},
+									"additionalProperties": false
+								}
+							},
+							"entries": {
+								"type": "array",
+								"items": {
+									"$ref": "entry.json"
+								}
+							},
+							"action": {
+								"type": "array",
+								"items": {
+									"type": "object",
+									"properties": {
+										"name": {
+											"type": "string"
+										},
+										"entries": {
+											"type": "array",
+											"items": {
+												"$ref": "entry.json"
+											}
+										}
+									},
+									"additionalProperties": false
+								}
+							}
+						},
+						"required": [
+							"name",
+							"entries"
+						],
+						"additionalProperties": false
+					}
+				},
+				"hasToken": {
+					"type": "boolean"
+				},
+				"hasFluff": {
+					"type": "boolean"
+				},
+				"hasFluffImages": {
+					"type": "boolean"
+				},
+				"fluff": {
+					"description": "This is intended to be used for Homebrew only - site data should include a fluff file per source",
+					"$ref": "util.json#/$defs/fluffObject"
+				},
+				"tokenUrl": {
+					"type": "string"
+				},
+				"foundrySystem": {
+					"$ref": "util.json#/$defs/foundrySystemObject"
+				},
+				"foundryFlags": {
+					"$ref": "util.json#/$defs/foundryFlagsObject"
+				},
+				"foundryImg": {
+					"$ref": "util.json#/$defs/foundryImg"
+				}
+			},
+			"required": [
+				"name",
+				"source"
+			],
+			"additionalProperties": false
+		},
+		"vehicleInfernalWarMachine": {
+			"type": "object",
+			"properties": {
+				"name": {
+					"type": "string"
+				},
+				"source": {
+					"type": "string"
+				},
+				"page": {
+					"$ref": "util.json#/$defs/page"
+				},
+				"otherSources": {
+					"$ref": "util.json#/$defs/otherSources"
+				},
+				"vehicleType": {
+					"const": "INFWAR"
+				},
+				"terrain": {
+					"$ref": "#/$defs/vehicleTerrain"
+				},
+				"size": {
+					"type": "string"
+				},
+				"weight": {
+					"type": "integer"
+				},
+				"capCreature": {
+					"type": "number"
+				},
+				"capCargo": {
+					"type": "number"
+				},
+				"speed": {
+					"type": "integer"
+				},
+				"str": {
+					"type": "integer"
+				},
+				"dex": {
+					"type": "integer"
+				},
+				"con": {
+					"type": "integer"
+				},
+				"int": {
+					"type": "integer"
+				},
+				"wis": {
+					"type": "integer"
+				},
+				"cha": {
+					"type": "integer"
+				},
+				"hp": {
+					"type": "object",
+					"properties": {
+						"hp": {
+							"type": "integer",
+							"description": "Hit Points"
+						},
+						"dt": {
+							"type": "integer",
+							"description": "Damage Threshold"
+						},
+						"mt": {
+							"type": "integer",
+							"description": "Mishap Threshold"
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"hp",
+						"dt",
+						"mt"
+					]
+				},
+				"conditionImmune": {
+					"type": "array",
+					"items": {
+						"$ref": "entry.json#/$defs/dataCondImmune"
+					}
+				},
+				"immune": {
+					"type": "array",
+					"items": {
+						"$ref": "entry.json#/$defs/dataDamImmune"
+					}
+				},
+				"trait": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"name": {
+								"type": "string"
+							},
+							"entries": {
+								"type": "array",
+								"items": {
+									"$ref": "entry.json"
+								}
+							}
+						}
+					}
+				},
+				"actionStation": {
+					"type": "array",
+					"description": "The Action Stations section of a vehicle block, for example the \"Helm\" or a weapon.",
+					"items": {
+						"type": "object",
+						"properties": {
+							"name": {
+								"type": "string"
+							},
+							"entries": {
+								"type": "array",
+								"items": {
+									"$ref": "entry.json"
+								}
+							}
+						}
+					}
+				},
+				"reaction": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"name": {
+								"type": "string"
+							},
+							"entries": {
+								"type": "array",
+								"items": {
+									"$ref": "entry.json"
+								}
+							}
+						}
+					}
+				},
+				"hasToken": {
+					"type": "boolean"
+				},
+				"hasFluff": {
+					"type": "boolean"
+				},
+				"hasFluffImages": {
+					"type": "boolean"
+				},
+				"fluff": {
+					"description": "This is intended to be used for Homebrew only - site data should include a fluff file per source",
+					"$ref": "util.json#/$defs/fluffObject"
+				},
+				"tokenUrl": {
+					"type": "string"
+				},
+				"foundrySystem": {
+					"$ref": "util.json#/$defs/foundrySystemObject"
+				},
+				"foundryFlags": {
+					"$ref": "util.json#/$defs/foundryFlagsObject"
+				},
+				"foundryImg": {
+					"$ref": "util.json#/$defs/foundryImg"
+				}
+			},
+			"required": [
+				"name",
+				"source"
+			],
+			"additionalProperties": false
+		},
+		"vehicleCreature": {
+			"type": "object",
+			"properties": {
+				"vehicleType": {
+					"const": "CREATURE"
+				},
+				"terrain": {
+					"$ref": "#/$defs/vehicleTerrain"
+				}
+			}
+		},
+		"vehicleObject": {
+			"type": "object",
+			"properties": {
+				"vehicleType": {
+					"const": "OBJECT"
+				},
+				"terrain": {
+					"$ref": "#/$defs/vehicleTerrain"
+				}
+			}
+		}
+	},
+	"properties": {
+		"vehicle": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"$ref": "#/$defs/vehicle"
+			}
+		},
+		"vehicleUpgrade": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"$ref": "#/$defs/vehicleUpgrade"
+			}
+		}
+	},
+	"additionalProperties": false
+}