5etools-utils 0.8.37 → 0.9.0

package/schema/ua-fast/actions.json

@@ -0,0 +1,97 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "actions.json",
+	"version": "1.2.0",
+	"type": "object",
+	"$defs": {
+		"action": {
+			"type": "object",
+			"properties": {
+				"name": {
+					"type": "string"
+				},
+				"entries": {
+					"type": "array",
+					"items": {
+						"$ref": "entry.json"
+					}
+				},
+				"source": {
+					"$ref": "util.json#/$defs/source"
+				},
+				"page": {
+					"$ref": "util.json#/$defs/page"
+				},
+				"fromVariant": {
+					"type": "string",
+					"description": "UID of a \"variantrule\" to be linked as a footnote in the action."
+				},
+				"time": {
+					"type": "array",
+					"items": {
+						"oneOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "object",
+								"properties": {
+									"unit": {
+										"type": "string",
+										"enum": [
+											"action",
+											"bonus",
+											"reaction"
+										]
+									},
+									"number": {
+										"type": "integer"
+									}
+								},
+								"required": [
+									"unit",
+									"number"
+								],
+								"additionalProperties": false
+							}
+						]
+					}
+				},
+				"srd": {
+					"$ref": "util.json#/$defs/srd"
+				},
+				"basicRules": {
+					"$ref": "util.json#/$defs/basicRules"
+				},
+				"seeAlsoAction": {
+					"type": "array",
+					"items": {
+						"type": "string",
+						"description": "UIDs of \"action\"s to be linked in a \"See Also\" footnote.\nEx.: \"disarm|dmg\"."
+					}
+				}
+			},
+			"required": [
+				"name",
+				"entries",
+				"source",
+				"page"
+			],
+			"additionalProperties": false
+		}
+	},
+	"properties": {
+		"action": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"$ref": "#/$defs/action"
+			}
+		}
+	},
+	"required": [
+		"action"
+	],
+	"additionalProperties": false
+}

package/schema/ua-fast/adventure/adventure.json

@@ -0,0 +1,12 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "adventure.json",
+	"version": "1.2.0",
+	"type": "object",
+	"properties": {
+		"data": {
+			"$ref": "../util.json#/$defs/adventureBookData"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/ua-fast/adventures.json

@@ -0,0 +1,214 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "adventures.json",
+	"version": "1.10.11",
+	"type": "object",
+	"properties": {
+		"adventure": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string"
+					},
+					"alias": {
+						"$ref": "util.json#/$defs/alias"
+					},
+					"id": {
+						"type": "string",
+						"description": "An ID that will be used to refer to this adventure in tags."
+					},
+					"source": {
+						"$ref": "util.json#/$defs/source"
+					},
+					"parentSource": {
+						"type": "string",
+						"description": "Used for books that contain multiple adventures, e.g. TftYP",
+						"$ref": "util.json#/$defs/source"
+					},
+					"group": {
+						"description": "The group under which this adventure should be listed in the navbar.",
+						"type": "string",
+						"enum": [
+							"supplement",
+							"supplement-alt",
+							"prerelease",
+							"homebrew",
+							"other"
+						]
+					},
+					"contents": {
+						"description": "The linked Table of Contents of the adventure.",
+						"type": "array",
+						"minItems": 1,
+						"items": {
+							"type": "object",
+							"properties": {
+								"name": {
+									"type": "string"
+								},
+								"headers": {
+									"type": "array",
+									"minItems": 1,
+									"items": {
+										"oneOf": [
+											{
+												"type": "string"
+											},
+											{
+												"type": "object",
+												"properties": {
+													"depth": {
+														"type": "integer"
+													},
+													"header": {
+														"type": "string"
+													},
+													"index": {
+														"description": "The relative index of this header in the current chapter, i.e. if \"Treasure\" appears twice and you wish the contents entry to link to the second instance, set the \"index\" to 1.",
+														"type": "integer"
+													}
+												},
+												"required": [
+													"header"
+												]
+											}
+										]
+									}
+								},
+								"ordinal": {
+									"type": "object",
+									"properties": {
+										"type": {
+											"type": "string",
+											"enum": [
+												"chapter",
+												"appendix",
+												"part",
+												"episode",
+												"level"
+											]
+										},
+										"identifier": {
+											"type": [
+												"integer",
+												"string"
+											]
+										}
+									},
+									"additionalProperties": false,
+									"required": [
+										"type",
+										"identifier"
+									]
+								}
+							},
+							"additionalProperties": false,
+							"required": [
+								"name"
+							]
+						}
+					},
+					"level": {
+						"description": "The character levels that the adventure ranges across.",
+						"oneOf": [
+							{
+								"type": "object",
+								"properties": {
+									"start": {
+										"type": "integer"
+									},
+									"end": {
+										"type": "integer"
+									}
+								},
+								"additionalProperties": false,
+								"required": [
+									"start",
+									"end"
+								]
+							},
+							{
+								"type": "object",
+								"properties": {
+									"custom": {
+										"type": "string"
+									}
+								},
+								"additionalProperties": false,
+								"required": [
+									"custom"
+								]
+							}
+						]
+					},
+					"published": {
+						"type": "string",
+						"format": "date",
+						"description": "The date of publication of the adventure, in the format YYYY-MM-DD (RFC3339)."
+					},
+					"publishedOrder": {
+						"description": "A sorting order for adventures within a single source.",
+						"type": "integer"
+					},
+					"coverUrl": {
+						"description": "A direct link to an image which should be 300 x 300px in size. Larger images will be centred and cropped.",
+						"type": "string"
+					},
+					"storyline": {
+						"type": "string",
+						"enum": [
+							"Starter Set",
+							"Tyranny of Dragons",
+							"Elemental Evil",
+							"Rage of Demons",
+							"Ravenloft",
+							"Storm King's Thunder",
+							"Tales from the Yawning Portal",
+							"Tomb of Annihilation",
+							"Waterdeep",
+							"Ravnica",
+							"Extra Life",
+							"Ghosts of Saltmarsh",
+							"Acquisitions Incorporated",
+							"Essentials Kit",
+							"Stranger Things",
+							"Baldur's Gate",
+							"Eberron",
+							"Rick and Morty",
+							"Wildemount",
+							"Icewind Dale",
+							"Mythic Odysseys of Theros",
+							"Candlekeep Mysteries",
+							"Adventures in the Forgotten Realms",
+							"The Wild Beyond the Witchlight",
+							"Ixalan",
+							"NERDS Restoring Harmony",
+							"Strixhaven",
+							"Critical Role",
+							"Journeys through the Radiant Citadel",
+							"Spelljammer",
+							"Dragonlance",
+							"Keys from the Golden Vault"
+						]
+					}
+				},
+				"additionalProperties": false,
+				"required": [
+					"name",
+					"id",
+					"source",
+					"contents",
+					"level",
+					"published",
+					"storyline",
+					"group"
+				]
+			}
+		}
+	},
+	"additionalProperties": false
+}

package/schema/ua-fast/backgrounds.json

@@ -0,0 +1,314 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "backgrounds.json",
+	"version": "1.3.2",
+	"type": "object",
+	"$defs": {
+		"backgroundData": {
+			"type": "object",
+			"properties": {
+				"name": {
+					"type": "string"
+				},
+				"source": {
+					"$ref": "util.json#/$defs/source"
+				},
+				"page": {
+					"$ref": "util.json#/$defs/page"
+				},
+				"prerequisite": {
+					"$ref": "util.json#/$defs/prerequisite"
+				},
+				"skillProficiencies": {
+					"$ref": "util.json#/$defs/skillProficiencies"
+				},
+				"toolProficiencies": {
+					"$ref": "util.json#/$defs/toolProficiencies"
+				},
+				"languageProficiencies": {
+					"$ref": "util.json#/$defs/languageProficiencies"
+				},
+				"feats": {
+					"$ref": "util.json#/$defs/additionalFeatsArray"
+				},
+				"entries": {
+					"type": "array",
+					"items": {
+						"$ref": "entry.json"
+					}
+				},
+				"additionalSources": {
+					"$ref": "util.json#/$defs/additionalSources"
+				},
+				"srd": {
+					"$ref": "util.json#/$defs/srd"
+				},
+				"basicRules": {
+					"$ref": "util.json#/$defs/basicRules"
+				},
+				"otherSources": {
+					"$ref": "util.json#/$defs/otherSources"
+				},
+				"startingEquipment": {
+					"$ref": "util.json#/$defs/startingEquipment"
+				},
+				"additionalSpells": {
+					"$ref": "util.json#/$defs/additionalSpellsArray"
+				},
+				"ability": {
+					"$ref": "util.json#/$defs/abilityScores"
+				},
+				"fromFeature": {
+					"description": "A lookup of other properties which should be tied to the \"Feature: ...\" entry. This is used when e.g. customizing a background during import to a VTT.",
+					"type": "object",
+					"patternProperties": {
+						"^.*$": {
+							"type": "boolean",
+							"const": true
+						}
+					}
+				},
+				"hasFluff": {
+					"type": "boolean"
+				},
+				"hasFluffImages": {
+					"type": "boolean"
+				}
+			},
+			"additionalProperties": false
+		},
+		"background": {
+			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"name": {
+							"type": "string"
+						},
+						"source": {
+							"$ref": "util.json#/$defs/source"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"prerequisite": {
+							"$ref": "util.json#/$defs/prerequisite"
+						},
+						"skillProficiencies": {
+							"$ref": "util.json#/$defs/skillProficiencies"
+						},
+						"toolProficiencies": {
+							"$ref": "util.json#/$defs/toolProficiencies"
+						},
+						"languageProficiencies": {
+							"$ref": "util.json#/$defs/languageProficiencies"
+						},
+						"feats": {
+							"$ref": "util.json#/$defs/additionalFeatsArray"
+						},
+						"entries": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"additionalSources": {
+							"$ref": "util.json#/$defs/additionalSources"
+						},
+						"srd": {
+							"$ref": "util.json#/$defs/srd"
+						},
+						"basicRules": {
+							"$ref": "util.json#/$defs/basicRules"
+						},
+						"otherSources": {
+							"$ref": "util.json#/$defs/otherSources"
+						},
+						"startingEquipment": {
+							"$ref": "util.json#/$defs/startingEquipment"
+						},
+						"additionalSpells": {
+							"$ref": "util.json#/$defs/additionalSpellsArray"
+						},
+						"ability": {
+							"$ref": "util.json#/$defs/abilityScores"
+						},
+						"fromFeature": {
+							"description": "A lookup of other properties which should be tied to the \"Feature: ...\" entry. This is used when e.g. customizing a background during import to a VTT.",
+							"type": "object",
+							"patternProperties": {
+								"^.*$": {
+									"type": "boolean",
+									"const": true
+								}
+							}
+						},
+						"hasFluff": {
+							"type": "boolean"
+						},
+						"hasFluffImages": {
+							"type": "boolean"
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"name",
+						"source",
+						"entries"
+					]
+				},
+				{
+					"type": "object",
+					"properties": {
+						"name": {
+							"type": "string"
+						},
+						"source": {
+							"$ref": "util.json#/$defs/source"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"prerequisite": {
+							"$ref": "util.json#/$defs/prerequisite"
+						},
+						"skillProficiencies": {
+							"$ref": "util.json#/$defs/skillProficiencies"
+						},
+						"toolProficiencies": {
+							"$ref": "util.json#/$defs/toolProficiencies"
+						},
+						"languageProficiencies": {
+							"$ref": "util.json#/$defs/languageProficiencies"
+						},
+						"feats": {
+							"$ref": "util.json#/$defs/additionalFeatsArray"
+						},
+						"entries": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"additionalSources": {
+							"$ref": "util.json#/$defs/additionalSources"
+						},
+						"srd": {
+							"$ref": "util.json#/$defs/srd"
+						},
+						"basicRules": {
+							"$ref": "util.json#/$defs/basicRules"
+						},
+						"otherSources": {
+							"$ref": "util.json#/$defs/otherSources"
+						},
+						"startingEquipment": {
+							"$ref": "util.json#/$defs/startingEquipment"
+						},
+						"additionalSpells": {
+							"$ref": "util.json#/$defs/additionalSpellsArray"
+						},
+						"ability": {
+							"$ref": "util.json#/$defs/abilityScores"
+						},
+						"fromFeature": {
+							"description": "A lookup of other properties which should be tied to the \"Feature: ...\" entry. This is used when e.g. customizing a background during import to a VTT.",
+							"type": "object",
+							"patternProperties": {
+								"^.*$": {
+									"type": "boolean",
+									"const": true
+								}
+							}
+						},
+						"hasFluff": {
+							"type": "boolean"
+						},
+						"hasFluffImages": {
+							"type": "boolean"
+						},
+						"_copy": {
+							"type": "object",
+							"properties": {
+								"name": {
+									"type": "string"
+								},
+								"source": {
+									"$ref": "util.json#/$defs/source"
+								},
+								"pantheon": {
+									"description": "Used in deity data",
+									"type": "string"
+								},
+								"shortName": {
+									"description": "Used in subclass data",
+									"type": "string"
+								},
+								"className": {
+									"description": "Used in subclass data",
+									"type": "string"
+								},
+								"classSource": {
+									"description": "Used in subclass data",
+									"$ref": "util.json#/$defs/source"
+								},
+								"_mod": {
+									"$ref": "util.json#/$defs/_modObject"
+								},
+								"_trait": {
+									"type": "object",
+									"properties": {
+										"name": {
+											"type": "string"
+										},
+										"source": {
+											"$ref": "util.json#/$defs/source"
+										}
+									},
+									"required": [
+										"name",
+										"source"
+									]
+								},
+								"_preserve": {
+									"type": "object",
+									"patternProperties": {
+										".*": {
+											"const": true
+										}
+									}
+								}
+							},
+							"required": [
+								"name",
+								"source"
+							],
+							"additionalProperties": false
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"_copy"
+					]
+				}
+			]
+		}
+	},
+	"properties": {
+		"background": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"$ref": "#/$defs/background"
+			}
+		},
+		"_meta": {
+			"$ref": "util.json#/$defs/metaBlock"
+		}
+	},
+	"required": [
+		"background"
+	],
+	"additionalProperties": false
+}