Skip to content

Commit 79be0cb

Browse files
committed
Added "Recipes" page
1 parent 4885748 commit 79be0cb

1 file changed

Lines changed: 90 additions & 0 deletions

File tree

docs/utilities/recipes.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Recipes
2+
3+
Since Palladium Addon Packs function as datapacks, you can use any normal vanilla recipe json file in an addon.
4+
An online tool to generate files for that is https://crafting.thedestruc7i0n.ca (make sure to select the correct game version).
5+
6+
## Tailoring
7+
Palladium also adds 2 new custom recipe types, for its Tailoring Bench. Both allow you to define recipes for it.
8+
9+
### `palladium:item_tailoring`
10+
11+
| Field | Type | Required? | Default/Fallback | Description |
12+
|----------------------|-------------------|-------------------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
13+
| `results` | object | required (must contain at least one item) || Map of armor slots to the result items. Possible slots are: `head`, `chest`, `legs`, `feet`. |
14+
| `ingredients` | array | required (non‑empty) || Shapeless input ingredients. Each element is a `SizedIngredient` object (see table below). If empty, deserialization fails. |
15+
| `tool` | Ingredient | required (must be non‑empty) || A standard Minecraft `Ingredient` JSON describing the required tailoring tool. If empty/invalid, deserialization fails. |
16+
| `title` | Text Component | required || Localized text shown for the recipe title. Uses Minecraft `Component` JSON format (can be a raw string or structured object). |
17+
| `tool_icon` | Resource Location | optional | `null` | Resource location for the icon used in the tailoring menu tool slot. Example: `"minecraft:item/diamond_sword"` or a custom texture location. |
18+
| `category` | Resource Location | optional | `null` | Resource location identifying a category for grouping recipes together in the tailoring menu recipe book. |
19+
| `requires_unlocking` | boolean | optional | `true` | If `true`, the recipe requires unlocking before it appears and can be crafted. |
20+
21+
#### `ingredients`
22+
Each element must be a non‑empty `Ingredient` with a positive count.
23+
24+
| Field | Type | Required? | Default/Fallback | Notes |
25+
|--------------|----------------|----------------------|------------------|------------------------------------------------------------------------------------------|
26+
| `ingredient` | Ingredient | required (non‑empty) || Standard Minecraft `Ingredient` JSON (item, tag, or alternatives). Cannot be empty here. |
27+
| `count` | integer (>= 1) | optional | `1` | Number of items required for this ingredient. Must be positive. |
28+
29+
#### Example
30+
```json
31+
{
32+
"type": "palladium:item_tailoring",
33+
"results": {
34+
"head": "minecraft:diamond_helmet",
35+
"chest": "minecraft:diamond_chestplate",
36+
"legs": "minecraft:diamond_leggings",
37+
"feet": "minecraft:diamond_boots"
38+
},
39+
"ingredients": [
40+
{
41+
"ingredient": {
42+
"item": "minecraft:diamond"
43+
},
44+
"count": 24
45+
}
46+
],
47+
"tool": {
48+
"item": "minecraft:shears"
49+
},
50+
"tool_icon": "palladium:item/empty_tool_slot_shears",
51+
"title": "Diamond Armor",
52+
"category": "test:vanilla_armor",
53+
"requires_unlocking": false
54+
}
55+
```
56+
57+
### `palladium:suit_set_tailoring`
58+
59+
Works essentially the same, but can directly use a suit set to declare its results.
60+
61+
| Field | Type | Required? | Default/Fallback | Description |
62+
|----------------------|-------------------|------------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
63+
| `suit_set` | object | required || ID of a suit set that will be the result of this recipe |
64+
| `ingredients` | array | required (non‑empty) || Shapeless input ingredients. Each element is a `SizedIngredient` object (see table below). If empty, deserialization fails. |
65+
| `tool` | Ingredient | required (must be non‑empty) || A standard Minecraft `Ingredient` JSON describing the required tailoring tool. If empty/invalid, deserialization fails. |
66+
| `title` | Text Component | required || Localized text shown for the recipe title. Uses Minecraft `Component` JSON format (can be a raw string or structured object). |
67+
| `tool_icon` | Resource Location | optional | `null` | Resource location for the icon used in the tailoring menu tool slot. Example: `"minecraft:item/diamond_sword"` or a custom texture location. |
68+
| `category` | Resource Location | optional | `null` | Resource location identifying a category for grouping recipes together in the tailoring menu recipe book. |
69+
| `requires_unlocking` | boolean | optional | `true` | If `true`, the recipe requires unlocking before it appears and can be crafted. |
70+
71+
#### Example
72+
```json
73+
{
74+
"type": "palladium:suit_set_tailoring",
75+
"suit_set": "test:wood",
76+
"ingredients": [
77+
{
78+
"ingredient": {
79+
"item": "minecraft:oak_wood"
80+
},
81+
"count": 24
82+
}
83+
],
84+
"tool": {
85+
"item": "minecraft:shears"
86+
},
87+
"tool_icon": "palladium:item/empty_tool_slot_shears",
88+
"category": "test:pack_armor"
89+
}
90+
```

0 commit comments

Comments
 (0)