schema.json

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"version": "1.4.0",
	"type": "object",
	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",

	"properties": {
		"_meta": {
			"description": "Metadata for the included data arrays",
			"type": "object",
			"properties": {
				"sources": {
					"type": "array",
					"items": {
						"type": "object",
						"description": "A set of properties describing a \"source.\" A source could be, for example, a homebrew PDF, book, or blog post.",
						"properties": {
							"json": {
								"type": "string",
								"description": "An identifying string, as seen in the JSON in \"source\" fields."
							},
							"abbreviation": {
								"type": "string",
								"description": "Abbreviated form of the source, to display on the site."
							},
							"color": {
								"type": "string",
								"description": "HTML hex color code this source should use when displayed in lists, e.g. 'ff00ff'"
							},
							"full": {
								"type": "string",
								"description": "Full title of the source, to display on the site."
							},
							"authors": {
								"type": "array",
								"description": "A list of authors who created the homebrew source.",
								"items": {
									"type": "string",
									"description": "Author name."
								}
							},
							"convertedBy": {
								"type": "array",
								"description": "An optional list of people who contributed to converting the source to 5etools format.",
								"items": {
									"type": "string",
									"description": "Contributor name."
								}
							},
							"dateReleased": {
								"type": "string",
								"format": "date",
								"description": "The release date of the source, e.g. \"2000-01-31\". Dates myst be specified in precisely this format, with two digits given for both month and day."
							},
							"version": {
								"type": "string",
								"description": "The source version, e.g. \"1.2.3\"."
							},
							"url": {
								"type": "string",
								"description": "A direct link to the source, if available in web form or on a store."
							},
							"targetSchema": {
								"type": "string",
								"description": "The target schema version in 5etools, e.g. \"1.2.3\"."
							}
						},
						"required": [
							"json",
							"abbreviation",
							"full",
							"version"
						]
					}
				},
				"skill": {
					"type": "object",
					"description": "Object keys are Skill names, which can referenced using {@skill <key>} (case sensitive)",
					"patternProperties": {
						".*": {
							"type": "string"
						}
					}
				},
				"senses": {
					"type": "object",
					"description": "Object keys are Sense names, which can referenced using {@sense <key>} (case insensitive)",
					"patternProperties": {
						".*": {
							"type": "string"
						}
					}
				},
				"spellSchools": {
					"type": "object",
					"description": "Object names are spell school abbreviations (e.g. `\"X\"`); values should be objects with `\"full\"`` (used in the main entry, e.g. \"Evocation\") and `\"short\"` (used in the list view, e.g. `\"Evoc.\"`) key/values.",
					"patternProperties": {
						".*": {
							"type": "object",
							"properties": {
								"full": {
									"type": "string"
								},
								"short": {
									"type": "string"
								},
								"color": {
									"type": "string",
									"description": "HTML hex color code this source should use when displayed in lists, e.g. 'ff00ff'"
								}
							},
							"required": [
								"full",
								"short"
							]
						}
					}
				},
				"spellDistanceUnits": {
					"type": "object",
					"description": "Object names are spell distance units (e.g. `\"hectares\"`); values should be objects with optional `\"singular\"`` (singular form of the unit, e.g. \"foot\" for the singular of \"feet\"--if unspecified, a trailing \"s\" is removed from the plural version, if it exists, and the result is used as the singular form) and `\"feetPerUnit\"` (e.g. for a \"yards\" custom unit, this would be `3`, as there are three feet in a yard) key/values.",
					"patternProperties": {
						".*": {
							"type": "object",
							"properties": {
								"feetPerUnit": {
									"type": "number"
								},
								"singular": {
									"type": "string"
								}
							},
							"required": [
								"feetPerUnit"
							]
						}
					}
				},
				"optionalFeatureTypes": {
					"type": "object",
					"description": "Object names are optional feature \"type\" shorthands (e.g. \"EI\" for \"Eldritch Invocation\" which will be displayed in the list view as a sortable column",
					"patternProperties": {
						".*": {
							"type": "string"
						}
					}
				},
				"psionicTypes": {
					"type": "object",
					"description": "Object names are psionic type abbreviations (e.g. `\"X\"`); values should be objects with `\"full\"`` (used in the main entry, e.g. \"Greater Discipline\") and `\"short\"` (used in the list view, e.g. `\"G. Discipline\"`) key/values.",
					"patternProperties": {
						".*": {
							"type": "object",
							"properties": {
								"full": {
									"type": "string"
								},
								"short": {
									"type": "string"
								},
								"hasOrder": {
									"description": "If this type has a psionic order.",
									"type": "boolean"
								},
								"isAltDisplay": {
									"description": "If this type should display its psionic type/order with the format \"Greater Discipline (Awakened)\" instead of the standard \"Awakened Greater Discipline\"",
									"type": "boolean"
								}
							},
							"required": [
								"full",
								"short"
							]
						}
					}
				},
				"dateAdded": {
					"type": "integer",
					"description": "The epoch timestamp (in seconds) when the homebrew was added to the repository. Not guaranteed to be anywhere near accurate."
				},
				"dateLastModified": {
					"type": "integer",
					"description": "The epoch timestamp (in seconds) when the homebrew was last modified. Not guaranteed to be anywhere near accurate."
				},
				"currencyConversions": {
					"type": "object",
					"description": "Keys should be uniquely-named value conversion objects, and can be referenced from item entities as \"currencyConversion\": \"<MyKey>\". The currency conversion info will then be used when rendering the value of the item.",
					"patternProperties": {
						".*": {
							"type": "array",
							"items": {
								"type": "object",
								"properties": {
									"coin": {
										"type": "string",
										"description": "Coin abbreviation, e.g. \"gp\""
									},
									"mult": {
										"type": "number",
										"description": "A multiplier for converting copper to this currency, e.g. \"0.01\" for standard gold pieces"
									},
									"isFallback": {
										"type": "boolean",
										"description": "If true, this currency will be used as a fallback when the copper value of the item is a fractional value (e.g. a single ball bearing is worth 0.1 cp; marking gold as the fallback currency would have this be converted to gold)."
									}
								},
								"required": [
									"coin",
									"mult"
								]
							}
						}
					}
				},
				"dependencies": {
					"description": "(Currently unused.)",
					"type": "object",
					"properties": {
						"monster": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					}
				},
				"unlisted": {
					"description": "If this homebrew file should be ignored/hidden by any indexer.",
					"type": "boolean"
				}
			},
			"required": [
				"sources"
			]
		},
		"makebrewCreatureTrait": {
			"description": "Additional trait templates which can be used in the homebrew builder.",
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"name": {
						"type": "string"
					},
					"source": {
						"type": "string"
					},
					"entries": {
						"type": "array"
					}
				},
				"required": [
					"name",
					"source",
					"entries"
				]
			}
		},
		"adventure": {
			"type": "array"
		},
		"adventureData": {
			"type": "array"
		},
		"book": {
			"type": "array"
		},
		"bookData": {
			"type": "array"
		},
		"class": {
			"type": "array"
		},
		"subclass": {
			"type": "array"
		},
		"spell": {
			"type": "array"
		},
		"roll20Spell": {
			"description": "Based on the Roll20 JSON data",
			"type": "array"
		},
		"foundrySpell": {
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"name": {
						"description": "Used to link spells in the homebrew to this extra Foundry data",
						"type": "string"
					},
					"source": {
						"description": "Used to link spells in the homebrew to this extra Foundry data",
						"type": "string"
					},
					"data": {
						"description": "Foundry data",
						"properties": {
							"target.value": {
								"type": "integer"
							},
							"target.units": {
								"type": "string"
							},
							"target.type": {
								"description": "From Foundry's `CONFIG.DND5E.targetTypes`",
								"type": "string",
								"enum": [
									"none",
									"self",
									"creature",
									"ally",
									"enemy",
									"object",
									"space",
									"radius",
									"sphere",
									"cylinder",
									"cone",
									"square",
									"cube",
									"line",
									"wall"
								]
							}
						}
					}
				},
				"required": [
					"name",
					"source"
				],
				"additionalProperties": false
			}
		},
		"item": {
			"type": "array"
		},
		"itemGroup": {
			"type": "array"
		},
		"baseitem": {
			"type": "array"
		},
		"itemProperty": {
			"type": "array"
		},
		"itemType": {
			"type": "array"
		},
		"variant": {
			"type": "array"
		},
		"background": {
			"type": "array"
		},
		"condition": {
			"type": "array"
		},
		"disease": {
			"type": "array"
		},
		"deity": {
			"type": "array"
		},
		"encounter": {
			"type": "array"
		},
		"feat": {
			"type": "array"
		},
		"object": {
			"type": "array"
		},
		"psionic": {
			"type": "array"
		},
		"race": {
			"type": "array"
		},
		"reward": {
			"type": "array"
		},
		"ship": {
			"type": "array"
		},
		"table": {
			"type": "array"
		},
		"trap": {
			"type": "array"
		},
		"hazard": {
			"type": "array"
		},
		"optionalfeature": {
			"type": "array"
		},
		"variantrule": {
			"type": "array"
		},
		"legendaryGroup": {
			"type": "array"
		},
		"language": {
			"type": "array"
		},
		"monster": {
			"type": "array"
		}
	}
}