> For the complete documentation index, see [llms.txt](https://star-generator.gitbook.io/star-generator-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://star-generator.gitbook.io/star-generator-docs/configuration/recipe-yml.md).

# recipe yml

Recipe files define craft time, energy cost, required ingredients, output items, permissions, command rewards, recipe icons, and optional vanilla crafting registration.

Pack recipe files are loaded from:

```
plugins/StarGenerator/pack/<pack-name>/recipe/*.yml
```

The recipe id is:

```
<pack-name>:<file-name>.yml
```

Example:

```
Starter_IceCream:vanilla_scoop.yml
```

## Example

```yaml
permission: ""
time: 24
energy: 4
shapeless: true
commands: []
icon:
  type: "itemsadder:starter_icecream:vanilla_scoop"
  amount: 2
  name: "&bVanilla Scoop"
  lore:
    - "&fTakes &e%crafting_time% &fto generate."
items:
  item_1:
    chance: 1
    type: "itemsadder:starter_icecream:vanilla_scoop"
    amount: 2
recipe:
  column_0:
    slot_0:
      type: "itemsadder:starter_icecream:milk_bucket"
      amount: 1
    slot_1:
      type: "itemsadder:starter_icecream:cream"
      amount: 1
    slot_2:
      type: "itemsadder:starter_icecream:sugar_crystals"
      amount: 1
  column_1:
    slot_0:
      type: "itemsadder:starter_icecream:vanilla_pod"
      amount: 1
  column_2: {}
```

## Fields

| Field             | Description                                                                                      |
| ----------------- | ------------------------------------------------------------------------------------------------ |
| `permission`      | Optional permission required to craft this recipe. Empty means no recipe permission requirement. |
| `time`            | Base craft duration in seconds.                                                                  |
| `energy`          | Base recipe energy cost.                                                                         |
| `shapeless`       | If `true`, matching can ignore exact ingredient positions where supported by the table logic.    |
| `commands`        | Commands run when the recipe completes.                                                          |
| `reward_type`     | `EXCLUSIVE` or `INDEPENDENT`. Optional.                                                          |
| `icon`            | Recipe icon shown in recipe GUIs. Supports recipe placeholders.                                  |
| `items`           | Output reward pool.                                                                              |
| `recipe`          | Crafting grid ingredients.                                                                       |
| `vanillaCrafting` | Optional Minecraft crafting-table registration.                                                  |

## Recipe Icon Lore

Recipe icon `name` and `lore` support placeholders such as:

```
%crafting_time%
%energy_cost%
%total_energy%
%current_energy%
%max_energy%
%energy_percent%
%default_detail%
```

If `icon.lore` is empty and `recipe-icon.default-detail.apply-when-lore-empty` is enabled in `config.yml`, StarGenerator applies the configured default detail lore automatically.

## Output Items

```yaml
items:
  item_1:
    chance: 1
    type: "itemsadder:starter_icecream:vanilla_scoop"
    amount: 2
```

Output fields:

| Field        | Description                                                 |
| ------------ | ----------------------------------------------------------- |
| `type`       | Item path. Required.                                        |
| `amount`     | Minimum amount and default output amount.                   |
| `max_amount` | Optional maximum amount for randomized output amount logic. |
| `chance`     | Chance weight used by the reward roll.                      |
| `name`       | Optional display name override.                             |
| `lore`       | Optional lore override.                                     |

To output a StarGenerator table item:

```yaml
items:
  table:
    chance: 1
    type: "table:Starter_IceCream:frostcraft.yml"
    amount: 1
```

## Ingredients

Ingredients are configured in columns and slots:

```yaml
recipe:
  column_0:
    slot_0:
      type: "minecraft:sugar:0"
      amount: 1
```

Ingredient fields:

| Field    | Description                             |
| -------- | --------------------------------------- |
| `type`   | Item path or group reference. Required. |
| `amount` | Required item amount.                   |
| `name`   | Optional display name override.         |
| `lore`   | Optional lore override.                 |

## Item Groups

Use a group reference when multiple items should match the same ingredient slot:

```yaml
type: "@group:Starter_IceCream:icecream_outputs"
```

Group files live under:

```
plugins/StarGenerator/pack/<pack-name>/group/*.yml
```

## Vanilla Crafting

Enable `vanillaCrafting` when the recipe should be registered in the normal Minecraft crafting table.

For a normal item output:

```yaml
vanillaCrafting:
  enabled: true
  output: "item_1"
  shapeless: true
```

For a StarGenerator table item output:

```yaml
vanillaCrafting:
  enabled: true
  table: "Starter_IceCream:frostcraft.yml"
  shapeless: false
items:
  table:
    chance: 1
    type: "table:Starter_IceCream:frostcraft.yml"
    amount: 1
```

Minecraft recipes can only return one result item. If a StarGenerator recipe has multiple outputs, select the output key with `vanillaCrafting.output`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://star-generator.gitbook.io/star-generator-docs/configuration/recipe-yml.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.