Managing the Compendium Items

Items

Create one

In the Compendium section's title bar, click Create Item. A prompt asks for a name (pre-filled with "New item") — confirm it, and MPX creates items/<slug>.json and opens it.

Fields

{
  "id": "…",
  "name": "Rusty Cutlass",
  "slug": "rusty-cutlass",
  "attributes": { "measurement": "imperial", "ruleset": "5.5e" },
  "data": {
    "type": "meleeWeapon",
    "typeDetail": "Cutlass",
    "rarity": "common",
    "attunement": false,
    "attunementDetail": "",
    "value": 5,
    "weight": 3,
    "ac": 0,
    "stealth": false,
    "str": 0,
    "properties": ["light"],
    "mastery": "nick",
    "dmg1": "1d6",
    "dmg2": "",
    "dmgType": "slashing",
    "range": "",
    "container": false,
    "capacity": 0
  },
  "descr": "A short, curved blade pitted with rust and salt.",
  "image": "items/rusty-cutlass.png",
  "sources": [{ "name": "The Sunken Lighthouse", "page": 4 }],
  "tags": ["weapon", "nautical"]
}

Only id, name, and slug are actually required — everything else is written empty and filled in as needed. id is generated for you; don't change it.

Top-level fields

Field	Format	Purpose
descr	Text	The item's description.
image	items/<file>	The item's illustration. The file must exist in the project.
sources	Array of { name, page }	Where the item comes from, e.g. [{ "name": "Player's Handbook", "page": 219 }].
tags	Array of strings	Keywords.

data fields

Field	Format	Purpose
type	One of: (empty), custom, armor, weapon, lightArmor, mediumArmor, heavyArmor, shield, meleeWeapon, rangedWeapon, ammunition, rod, staff, wand, potion, ring, scroll, wondrousItem, adventuringGear, wealth, gemstone, tool, poison, instrument, arcaneFocus, holySymbol, mount, equipmentPack, tradeGood, druidicFocus, vehicleLand, vehicleWater, vehicleSpace	The item's category.
typeDetail	Text	A more specific label shown next to the type, e.g. "Cutlass" for a meleeWeapon.
rarity	One of: (empty), common, uncommon, rare, veryrare, legendary, artifact, unknown
attunement	true/false	Whether the item requires attunement.
attunementDetail	Text	The attunement requirement's detail, e.g. "by a spellcaster".
value	Number	Cost, in gold pieces. 0 is treated as not set.
weight	Number	In lb (imperial) or kg (metric), matching attributes.measurement — not converted between the two. 0 is treated as not set.
ac	Number	Armor class, for armor/shields. 0 is treated as not set.
stealth	true/false	Whether the item imposes Stealth disadvantage.
str	Number	Minimum Strength score required. 0 is treated as not set.
properties	Array, from: ammunition, finesse, heavy, light, loading, range, reach, special, thrown, twoHanded, versatile, cleave, graze, nick, push, sap, slow, topple, vex	Weapon properties.
mastery	One of: (empty), cleave, graze, nick, push, sap, slow, topple, vex	Weapon mastery.
dmg1 / dmg2	Text, e.g. 1d6	Damage dice — one-handed / two-handed (or versatile) use.
dmgType	One of: (empty), acid, bludgeoning, cold, fire, force, lightning, necrotic, piercing, poison, psychic, radiant, slashing, thunder
range	Text, e.g. 20/60	For a ranged/thrown weapon.
container	true/false	Whether the item can hold other items.
capacity	Number	Container capacity, in the same unit as weight. 0 is treated as not set.

Inline authoring

An item can also be written directly inside a page, as a fenced ```item block — type mpx-item and accept the snippet suggestion for the full template. The block is "flat" — the data fields sit at the top level, no data: wrapper:

```item
name: "Lantern Keeper's Whistle"
slug: lantern-keepers-whistle
attributes:
  measurement: "imperial"
  ruleset: "5.5e"
image: "items/"
showImage: true
type: "wondrousItem"
rarity: "uncommon"
attunement: true
value: 0
weight: 0
descr: "A bone whistle."
sources:
  - name: "The Sunken Lighthouse"
    page: 9
showSources: true
tags: ["wondrous", "quest"]
showTags: true
```

slug is optional inline — generated from name if left out. id isn't part of the inline form at all.

Three show* toggles: showImage, showSources, showTags (project defaults: mpx.defaultShowItemImage, mpx.defaultShowItemSources, mpx.defaultShowItemTags).

Next step

Spells.