aboutsummaryrefslogtreecommitdiff
path: root/building_guide/recipes.md
diff options
context:
space:
mode:
authorhistoria <[not public]>2026-07-01 03:21:52 -0400
committerhistoria <[not public]>2026-07-01 03:21:52 -0400
commitfbe5090ac3325ff8ea6989cdf4515c7f077c975b (patch)
tree1811ad9c6a596e7177bb2c42944c389c0a120066 /building_guide/recipes.md
parent5f37dc9b6f6b79da04da70ae0c33ec8d02998587 (diff)
downloadthehouseoficarus-fbe5090ac3325ff8ea6989cdf4515c7f077c975b.tar.gz
feat: item messaging standardized, custom messages for production paths implemented
Diffstat (limited to 'building_guide/recipes.md')
-rw-r--r--building_guide/recipes.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/building_guide/recipes.md b/building_guide/recipes.md
index e865fa6..96bf0f9 100644
--- a/building_guide/recipes.md
+++ b/building_guide/recipes.md
@@ -18,7 +18,7 @@ Crafting information lives on the **output item's YAML file** via the `craft:` b
| `ingredients` | []IngredientEntry | Ingredients consumed (see below) |
| `output_qty` | int | Quantity produced (default 1, for stackables) |
| `fail` | string | ItemID produced on failure (optional) |
-| `message` | string | Success message per cycle (optional, see message defaults) |
+| `success_message` | string | Success message per cycle (optional, see message defaults) |
| `fail_message` | string | Failure message (optional, empty = silent fail) |
| `start_message`| string | Message when action begins (optional, see message defaults) |
| `end_message` | string | Message when action completes (optional, see message defaults) |
@@ -29,7 +29,7 @@ The output is the item itself — no `output` field needed. The item ID IS the c
### Message Variables
-All message fields (`message`, `fail_message`, `start_message`, `end_message`, and `steps[].message`) support variables that expand to colorized item names:
+All message fields (`success_message`, `fail_message`, `start_message`, `end_message`, and `steps[].message`) support variables that expand to colorized item names:
| Variable | Expands to |
| -------- | ----------------------------------------------- |
@@ -47,7 +47,7 @@ Variables work alongside inline color tags (`{C4}text{/}`) which are expanded af
If a message field is omitted from the YAML, the game uses a skill-level default based on the craft `type`:
-| Type | Default `message` | Default `start_message` |
+| Type | Default `success_message` | Default `start_message` |
|------|-------------------|------------------------|
| `cooking` | `"Cooked to perfection. %n looks great!"` | `"You start cooking %i1."` |
| `smelt` | `"You remove a white hot %n!"` | `"You place the %i1 into the furnace."` |
@@ -81,7 +81,7 @@ craft:
message: "You try to puzzle how the pieces fit together."
- tick: 3
message: "Aha, this edge lines up here!"
- message: "You assemble the map!"
+ success_message: "You assemble the map!"
```
### IngredientEntry — Multi-Item Ingredient Slots
@@ -120,7 +120,7 @@ craft:
quantity: 1
- items: [eye_of_newt]
quantity: 1
- message: "You mix a %n." # %n expands to "stim potion" colored
+ success_message: "You mix a %n." # %n expands to "stim potion" colored
```
### Station-Based Production
@@ -139,8 +139,8 @@ craft:
quantity: 1
- items: [tin_ore]
quantity: 1
- message: "You smelt a %n." # default is "You remove a white hot %n!"
- # overridden here for simpler flavor
+ success_message: "You smelt a %n." # default is "You remove a white hot %n!"
+ # overridden here for simpler flavor
```
```yaml
@@ -154,7 +154,7 @@ craft:
ingredients:
- items: [bronze_bar]
quantity: 1
- # message omitted — uses default "You smith a %n."
+ # success_message omitted — uses default "You smith a %n."
```
For stackable outputs, use `output_qty`:
@@ -171,7 +171,7 @@ craft:
- items: [bronze_bar]
quantity: 1
output_qty: 15
- # message omitted — uses default "You smith a %n."
+ # success_message omitted — uses default "You smith a %n."
```
### Tool-Based Production
@@ -206,7 +206,7 @@ craft:
byproducts: [empty_vial, empty_jug]
- items: [empty_bucket]
quantity: 1
- message: "You pour the %i1 into the %i2." # %i1 = water source, %i2 = bucket
+ success_message: "You pour the %i1 into the %i2." # %i1 = water source, %i2 = bucket
```
### Multi-Piece Assembly (3+ items → 1)
@@ -227,7 +227,7 @@ craft:
message: "You try to puzzle how the pieces fit together."
- tick: 3
message: "Aha, this edge lines up here!"
- message: "You assemble the %n."
+ success_message: "You assemble the %n."
```
### Clean Recipes
@@ -245,7 +245,7 @@ craft:
ingredients:
- items: [grimy_guam]
quantity: 1
- # message omitted — uses default "You clean the %i1."
+ # success_message omitted — uses default "You clean the %i1."
# %i1 expands to the grimy herb name with its color
```