5etools-utils 0.2.2 → 0.3.0

package/schema/brew/items-shared.json

@@ -0,0 +1,295 @@
+{
+	"$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",
+			"examples": [
+				"$",
+				"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",
+			"examples": [
+				"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",
+				"examples": [
+					"2H",
+					"A",
+					"AF",
+					"BF",
+					"EM",
+					"F",
+					"H",
+					"L",
+					"LD",
+					"OTH",
+					"R",
+					"RLD",
+					"S",
+					"T",
+					"V"
+				]
+			}
+		},
+		"itemScfType": {
+			"type": "string",
+			"examples": [
+				"arcane",
+				"druid",
+				"holy"
+			]
+		},
+		"itemTier": {
+			"type": "string",
+			"description": "Item Tier as per XGE p135",
+			"examples": [
+				"minor",
+				"major"
+			]
+		},
+		"itemWeaponCategory": {
+			"type": "string",
+			"examples": [
+				"simple",
+				"martial"
+			]
+		},
+		"itemAmmoType": {
+			"type": "string",
+			"examples": [
+				"energy cell",
+				"modern bullet",
+				"blowgun needle|phb",
+				"crossbow bolt|phb",
+				"arrow|phb",
+				"renaissance bullet",
+				"sling bullet|phb"
+			]
+		},
+		"fluff": {
+			"description": "This is intended to be used for Homebrew only - site data should include a fluff file per source.",
+			"anyOf": [
+				{
+					"description": "References \"itemFluff\" array items",
+					"type": "object",
+					"properties": {
+						"_itemFluff": {
+							"type": "object",
+							"properties": {
+								"name": {
+									"type": "string"
+								},
+								"source": {
+									"type": "string"
+								}
+							}
+						},
+						"_appendItemFluff": {
+							"type": "object",
+							"properties": {
+								"name": {
+									"type": "string"
+								},
+								"source": {
+									"type": "string"
+								}
+							}
+						}
+					}
+				},
+				{
+					"$ref": "util.json#/$defs/fluffObject"
+				}
+			]
+		}
+	}
+}