aboutsummaryrefslogtreecommitdiff
path: root/worldbuilding_guide/items.md
blob: e9e4352a2f480586a4226232f816e2f3d9786486 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
## Items

```yaml
id: bronze_pickaxe
name: bronze pickaxe
color: "178"                   # xterm-256 color index (0-255)
aliases: ["pick", "pickaxe"]
description: "A sturdy bronze pickaxe."
value: 10
stackable: false
equip_slot: main_hand        # optional — where it equips
weapon_type: melee            # optional — melee or ranged
stats:                        # optional — combat bonuses
  attack_bonus: 2
  strength_bonus: 1
speed: 5                      # ticks between attacks
tool_type: pickaxe            # used by gather behaviors that require "tool: pickaxe"
tool_speed: 2                 # reduces gather wait time
```

### Color

The `color` field accepts xterm-256 palette indices (0-255) with optional modifiers:

```yaml
color: "178"                   # bronze/gold
color: "75 bold"               # bold steel blue
color: "g:196,208,226"         # gradient red → orange → gold
```

In ANSI mode, extended colors (16-255) automatically downgrade to the nearest ANSI color. Use `colortable` in-game to see all 256 colors.

Key item (quest token, not equippable):
```yaml
id: pass_stub
name: pass stub
description: "A crumpled slip of paper stamped with the guard's seal."
value: 0
stackable: false
```

---

## Firemaking

```yaml
id: logs
name: logs
fire_level: 1         # firemaking level required
fire_xp: 40           # XP for burning/stoking
burn_ticks: 24        # how long the fire burns
```

## Food / Healing

```yaml
id: bread
name: bread
color: "222"
description: "A fresh loaf of bread, still warm from the oven."
value: 5
heal_value: 5         # positive = heal, negative = damage
eat_message: "You eat the bread. Warm and satisfying."
```

## MadeFrom — Item Combinations

Define what items combine to make this item. Used by the `use` command.

```yaml
id: bread_dough
name: bread dough
color: "222"
made_from:
  - items: [pot_of_flour]
    qty: 1
  - items: [bucket_of_water, pitcher_of_water]
    qty: 1
```

Each entry is an ingredient slot. Multiple `items` means any of them works. The first matching item found in inventory is consumed. See also `recipes.md` for station-based recipes.