Skip to content

Inventory

Lists items with editable quantities. Items can have switches, like Equipped, and give modifiers while they're on.

A character can have as many inventories as you like, such as equipment, spell components and treasure, but each item name only once across all of them, ignoring case. If two share a name, each card shows an error with links to the others. Any roll's effects can add and remove items.

Example

```dicelist
name: Backpack
inventory:
  - name: Arrows
    quantity: 20
    description: Standard ammunition for bows
  - name: Healing Potion
    quantity: 2
```

Fields

inventory is a list of items. Each has a name, a quantity, and an optional description shown under its name. Write inventory: [] for an empty one that effects can add to.

Editing quantities

Type a new number in an item's box, then press Enter or click away. The change is saved into the note's YAML.

Switches and modifiers

Items can give modifiers, such as a +1 to armor class and saving throws. Give an item switches, such as Equipped or Attuned, and its modifiers apply only while every switch is on. Each switch shows on the item's row. An item with modifiers and no switches always gives them.

Field Description
switches Names with on or off, such as { Equipped: true, Attuned: false }. The card saves these for you.
modifiers The modifiers it gives, written like a modifiers list.
inventory:
  - name: Cloak of Protection
    quantity: 1
    switches: { Equipped: true, Attuned: true }
    modifiers:
      - name: Cloak of Protection
        value: 1
        appliesTo: [armor class, save]

A value with the armor class category picks up the +1 while the cloak is equipped and attuned.

Actions

Effects and event subscriptions can run these. An effect finds the inventory holding the item by its name, wherever it is.

Adding an item no inventory has yet goes to the character's only inventory. With several, say which with the effect's card, the card's name:

effects:
  - target: inventory
    action: add
    card: Spell components
    args: { item: Goodberry, quantity: 10 }

Adding to an item that already exists adds to it wherever it is, so card isn't needed. Item names are matched without regard to case.

add

Adds to an item's quantity. If the item does not exist, it is created, with the description if one is given. An existing item's description is not changed.

Argument Required Description
item Yes Item name.
quantity No How many to add. Whole number, 1 or more. Defaults to 1.
description No Description for the item, if it is created.

remove

Takes from an item's quantity. The item stays in the list at 0.

Argument Required Description
item Yes Item name.
quantity No How many to remove. Whole number, 1 or more. Defaults to 1.

Fails if the item is missing, or if there are not enough. For example: "Not enough Arrows: have 0, need 1".