5etools-utils 0.2.2 → 0.3.0

package/schema/site/items-base.json

@@ -0,0 +1,425 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "items-base.json",
+	"version": "1.5.1",
+	"$defs": {
+		"itemPropertyLookupArray": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"$ref": "#/$defs/itemPropertyLookup"
+			}
+		},
+		"itemTypeLookupArray": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"$ref": "#/$defs/itemTypeLookup"
+			}
+		},
+		"itemLookupBase": {
+			"type": "object",
+			"properties": {
+				"abbreviation": {
+					"type": "string"
+				},
+				"source": {
+					"type": "string"
+				},
+				"page": {
+					"$ref": "util.json#/$defs/page"
+				},
+				"name": {
+					"type": "string"
+				}
+			},
+			"additionalProperties": false,
+			"required": [
+				"abbreviation",
+				"source",
+				"page"
+			]
+		},
+		"itemPropertyLookup": {
+			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"abbreviation": {
+							"type": "string"
+						},
+						"source": {
+							"type": "string"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"name": {
+							"type": "string"
+						},
+						"template": {
+							"type": "string"
+						},
+						"entries": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"abbreviation",
+						"source",
+						"page"
+					]
+				},
+				{
+					"type": "object",
+					"properties": {
+						"abbreviation": {
+							"type": "string"
+						},
+						"source": {
+							"type": "string"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"name": {
+							"type": "string"
+						},
+						"template": {
+							"type": "string"
+						},
+						"entriesTemplate": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"abbreviation",
+						"source",
+						"page"
+					]
+				}
+			]
+		},
+		"itemTypeLookup": {
+			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"abbreviation": {
+							"type": "string"
+						},
+						"source": {
+							"type": "string"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"name": {
+							"type": "string"
+						},
+						"entries": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"abbreviation",
+						"source",
+						"page"
+					]
+				},
+				{
+					"type": "object",
+					"properties": {
+						"abbreviation": {
+							"type": "string"
+						},
+						"source": {
+							"type": "string"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"name": {
+							"type": "string"
+						},
+						"entriesTemplate": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"abbreviation",
+						"source",
+						"page"
+					]
+				}
+			]
+		}
+	},
+	"type": "object",
+	"properties": {
+		"baseitem": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string"
+					},
+					"type": {
+						"$ref": "items-shared.json#/$defs/itemType"
+					},
+					"rarity": {
+						"$ref": "items-shared.json#/$defs/itemRarity"
+					},
+					"source": {
+						"type": "string"
+					},
+					"page": {
+						"$ref": "util.json#/$defs/page"
+					},
+					"ac": {
+						"type": "integer"
+					},
+					"age": {
+						"$ref": "items-shared.json#/$defs/itemAge"
+					},
+					"armor": {
+						"description": "Flag used when merging generic variants",
+						"type": "boolean"
+					},
+					"axe": {
+						"type": "boolean"
+					},
+					"dmg1": {
+						"type": "string"
+					},
+					"dmg2": {
+						"type": "string"
+					},
+					"dmgType": {
+						"$ref": "util.json#/$defs/dataDamageTags"
+					},
+					"entries": {
+						"type": "array",
+						"items": {
+							"$ref": "entry.json"
+						}
+					},
+					"property": {
+						"$ref": "items-shared.json#/$defs/itemProperty"
+					},
+					"range": {
+						"type": "string"
+					},
+					"reload": {
+						"type": "integer"
+					},
+					"scfType": {
+						"$ref": "items-shared.json#/$defs/itemScfType"
+					},
+					"stealth": {
+						"type": "boolean"
+					},
+					"strength": {
+						"type": "string"
+					},
+					"sword": {
+						"type": "boolean"
+					},
+					"mace": {
+						"type": "boolean"
+					},
+					"spear": {
+						"type": "boolean"
+					},
+					"hammer": {
+						"type": "boolean"
+					},
+					"bow": {
+						"type": "boolean"
+					},
+					"crossbow": {
+						"type": "boolean"
+					},
+					"club": {
+						"type": "boolean"
+					},
+					"dagger": {
+						"type": "boolean"
+					},
+					"net": {
+						"type": "boolean"
+					},
+					"firearm": {
+						"type": "boolean"
+					},
+					"staff": {
+						"description": "Adds the italicized \"Staff\" text to the item info line (below the name).",
+						"type": "boolean"
+					},
+					"value": {
+						"description": "In copper pieces.",
+						"type": "number"
+					},
+					"valueMult": {
+						"type": "number"
+					},
+					"weapon": {
+						"type": "boolean"
+					},
+					"weaponCategory": {
+						"$ref": "items-shared.json#/$defs/itemWeaponCategory"
+					},
+					"weight": {
+						"type": "number"
+					},
+					"weightMult": {
+						"type": "number"
+					},
+					"quantity": {
+						"type": "integer"
+					},
+					"srd": {
+						"$ref": "util.json#/$defs/srd"
+					},
+					"basicRules": {
+						"$ref": "util.json#/$defs/basicRules"
+					},
+					"otherSources": {
+						"$ref": "util.json#/$defs/otherSources"
+					},
+					"ammoType": {
+						"$ref": "items-shared.json#/$defs/itemAmmoType"
+					},
+					"packContents": {
+						"type": "array",
+						"items": {
+							"oneOf": [
+								{
+									"type": "string"
+								},
+								{
+									"type": "object",
+									"properties": {
+										"special": {
+											"type": "string"
+										},
+										"quantity": {
+											"type": "integer"
+										}
+									},
+									"additionalProperties": false,
+									"required": [
+										"special"
+									]
+								},
+								{
+									"type": "object",
+									"properties": {
+										"item": {
+											"type": "string"
+										},
+										"quantity": {
+											"type": "integer"
+										}
+									},
+									"additionalProperties": false,
+									"required": [
+										"item",
+										"quantity"
+									]
+								}
+							]
+						}
+					},
+					"lootTables": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					},
+					"hasFluff": {
+						"type": "boolean"
+					},
+					"hasFluffImages": {
+						"type": "boolean"
+					}
+				},
+				"required": [
+					"name",
+					"type",
+					"rarity",
+					"source"
+				],
+				"additionalProperties": false
+			}
+		},
+		"itemProperty": {
+			"$ref": "#/$defs/itemPropertyLookupArray"
+		},
+		"itemType": {
+			"$ref": "#/$defs/itemTypeLookupArray"
+		},
+		"itemEntry": {
+			"type": "array",
+			"minItems": 1,
+			"items": {
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string"
+					},
+					"source": {
+						"type": "string"
+					},
+					"entriesTemplate": {
+						"type": "array",
+						"items": {
+							"$ref": "entry.json"
+						}
+					}
+				}
+			}
+		},
+		"itemTypeAdditionalEntries": {
+			"type": "array",
+			"minItems": 1,
+			"items": {
+				"type": "object",
+				"properties": {
+					"appliesTo": {
+						"type": "string"
+					},
+					"entries": {
+						"type": "array",
+						"items": {
+							"$ref": "entry.json"
+						}
+					}
+				},
+				"additionalProperties": false
+			}
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site/items-shared.json

@@ -0,0 +1,259 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "items-shared.json",
+	"title": "Shared Item Schema",
+	"description": "Shared item definitions to be used in item schemas.",
+	"version": "1.0.1",
+	"$defs": {
+		"_itemModifySpeedEqual": {
+			"type": "string",
+			"enum": [
+				"walk",
+				"burrow",
+				"climb",
+				"fly",
+				"swim"
+			]
+		},
+		"itemModifySpeed": {
+			"type": "object",
+			"properties": {
+				"multiply": {
+					"type": "object",
+					"properties": {
+						"walk": {
+							"type": "number"
+						},
+						"burrow": {
+							"type": "number"
+						},
+						"climb": {
+							"type": "number"
+						},
+						"fly": {
+							"type": "number"
+						},
+						"swim": {
+							"type": "number"
+						},
+						"*": {
+							"type": "number"
+						}
+					},
+					"additionalProperties": false
+				},
+				"static": {
+					"type": "object",
+					"properties": {
+						"walk": {
+							"type": "number"
+						},
+						"burrow": {
+							"type": "number"
+						},
+						"climb": {
+							"type": "number"
+						},
+						"fly": {
+							"type": "number"
+						},
+						"swim": {
+							"type": "number"
+						},
+						"*": {
+							"type": "number"
+						}
+					},
+					"additionalProperties": false
+				},
+				"equal": {
+					"type": "object",
+					"properties": {
+						"walk": {
+							"$ref": "#/$defs/_itemModifySpeedEqual"
+						},
+						"burrow": {
+							"$ref": "#/$defs/_itemModifySpeedEqual"
+						},
+						"climb": {
+							"$ref": "#/$defs/_itemModifySpeedEqual"
+						},
+						"fly": {
+							"$ref": "#/$defs/_itemModifySpeedEqual"
+						},
+						"swim": {
+							"$ref": "#/$defs/_itemModifySpeedEqual"
+						}
+					},
+					"additionalProperties": false
+				},
+				"bonus": {
+					"type": "object",
+					"properties": {
+						"walk": {
+							"type": "number"
+						},
+						"burrow": {
+							"type": "number"
+						},
+						"climb": {
+							"type": "number"
+						},
+						"fly": {
+							"type": "number"
+						},
+						"swim": {
+							"type": "number"
+						},
+						"*": {
+							"type": "number"
+						}
+					},
+					"additionalProperties": false
+				}
+			},
+			"additionalProperties": false
+		},
+		"itemRarity": {
+			"anyOf": [
+				{
+					"$ref": "util.json#/$defs/rarity"
+				},
+				{
+					"type": "string",
+					"description": "\"none\" is for mundane items. \"unknown (magic)\" is for miscellaneous magical items. \"unknown\" is for miscellaneous mundane items. \"varies\" is for item groups, or for magic variants, where it has the special functionality of maintaining a base item's rarity when creating specific variants.",
+					"enum": [
+						"none",
+						"unknown",
+						"unknown (magic)",
+						"varies"
+					]
+				}
+			]
+		},
+		"itemRecharge": {
+			"enum": [
+				"round",
+				"restShort",
+				"restLong",
+				"dawn",
+				"dusk",
+				"midnight",
+				"special"
+			]
+		},
+		"itemRechargeAmount": {
+			"type": [
+				"integer",
+				"string"
+			]
+		},
+		"itemType": {
+			"type": "string",
+			"$comment": "Dumped from `Object(Parser.ITEM_TYPE_JSON_TO_ABV)`",
+			"description": "$: Treasure\n A: Ammunition\n AF: Ammunition (futuristic)\n AIR: Vehicle (air)\n AT: Artisan Tool\n EM: Eldritch Machine\n EXP: Explosive\n FD: Food and Drink\n G: Adventuring Gear\n GS: Gaming Set\n GV: Generic Variant\n HA: Heavy Armor\n INS: Instrument\n LA: Light Armor\n M: Melee Weapon\n MA: Medium Armor\n MNT: Mount\n MR: Master Rune \n OTH: Other\n P: Potion\n R: Ranged Weapon\n RD: Rod\n RG: Ring\n S: Shield\n SC: Scroll\n SCF: Spellcasting Focus\n SHP: Vehicle (water)\n SPC: Vehicle (space)\n T: Tool\n TAH: Tack and Harness\n TG: Trade Good\n VEH: Vehicle (land)\n WD: Wand",
+			"enum": [
+				"$",
+				"A",
+				"AF",
+				"AIR",
+				"AT",
+				"EM",
+				"EXP",
+				"FD",
+				"G",
+				"GS",
+				"GV",
+				"HA",
+				"INS",
+				"LA",
+				"M",
+				"MA",
+				"MNT",
+				"MR",
+				"OTH",
+				"P",
+				"R",
+				"RD",
+				"RG",
+				"S",
+				"SC",
+				"SCF",
+				"SHP",
+				"SPC",
+				"T",
+				"TAH",
+				"TG",
+				"VEH",
+				"WD"
+			]
+		},
+		"itemAge": {
+			"type": "string",
+			"enum": [
+				"futuristic",
+				"modern",
+				"renaissance"
+			]
+		},
+		"itemProperty": {
+			"type": "array",
+			"description": "2H: Two-Handed\n A: Ammunition\n AF: Ammunition (futuristic)\n BF: Burst Fire\n EM: Eldritch Machine\n F: Finesse\n H: Heavy\n L: Light\n LD: Loading\n OTH: Other\n R: Reach\n RLD: Reload\n S: Special\n T: Thrown\n V: Versatile",
+			"items": {
+				"type": "string",
+				"enum": [
+					"2H",
+					"A",
+					"AF",
+					"BF",
+					"EM",
+					"F",
+					"H",
+					"L",
+					"LD",
+					"OTH",
+					"R",
+					"RLD",
+					"S",
+					"T",
+					"V"
+				]
+			}
+		},
+		"itemScfType": {
+			"type": "string",
+			"enum": [
+				"arcane",
+				"druid",
+				"holy"
+			]
+		},
+		"itemTier": {
+			"type": "string",
+			"description": "Item Tier as per XGE p135",
+			"enum": [
+				"minor",
+				"major"
+			]
+		},
+		"itemWeaponCategory": {
+			"type": "string",
+			"enum": [
+				"simple",
+				"martial"
+			]
+		},
+		"itemAmmoType": {
+			"type": "string",
+			"enum": [
+				"energy cell",
+				"modern bullet",
+				"blowgun needle|phb",
+				"crossbow bolt|phb",
+				"arrow|phb",
+				"renaissance bullet",
+				"sling bullet|phb"
+			]
+		}
+	}
+}