BlueGit

timfa questward

Files

questward / .cursor / rules / item-descriptions.mdc

item-descriptions.mdc

item-descriptions.mdc 1.4 KiB Download Raw
1---
2description: Item (and station) descriptions must stay in-universe; never expose mechanics or implementation status.
3alwaysApply: true
4---
5
6# In-universe item descriptions
7
8Player-facing `description` text on items (and craft-station blurbs shown in UI) **must** describe the thing in-world — what it is, looks like, or is for — never how the game implements it.
9
10## Forbidden
11
12- Stack sizes, slots, skill levels, equip rules, UI labels
13- Implementation status (“TBD”, “for now”, “mostly cosmetic”, “placeholder”, “tintable”, “scaffold”)
14- Code/art notes (“shared sprite”, “overrides material colour”)
15- Out-of-character systems talk (“your bag”, “inventory space”)
16
17## Allowed
18
19- In-world craft hints at the softest end, e.g. “Smelt these ores in a furnace.”
20- Flavor and material/origin that a character could know
21
22```text
23# ❌ BAD
24"Mostly cosmetic for now; optional dye overrides the material colour."
25"Same colour and uses stack up to 16."
26"Drink to apply its effect (effects TBD)."
27"Bronze may be equipped at any Woodcutting level."
28
29# ✅ GOOD
30"A warm cotton sweater, soft enough for travel."
31"Bottled colour for cloth and clothing."
32"A bottled brew. Sip with care."
33"A bronze axe for felling trees."
34```
35
36When adding or editing item defs, write lore/flavor first; put rules in code and tooltips that are explicitly mechanical if needed later — not in `description`.