> For the complete documentation index, see [llms.txt](https://docs.mipcraft.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mipcraft.eu/smartgolems/configuration-guide.md).

# Configuration Guide

The `config.yml` file allows server administrators to customize every aspect of SmartGolems, from crafting recipes and upgrade amounts to GUI titles, transition animations, and nametags.

## 1. Recipes Configuration (`recipes:`)

Each golem specialization recipe can be customized or disabled:

```yaml
recipes:
  crop_farmer:
    enabled: true
    result_item: COPPER_GOLEM_SPAWN_EGG
    custom_model_data: 0
    display_name: "&a&lCrop Farmer Golem"
    glow: true
    lore:
      - "&7Harvests mature crops, smart-replants seeds, and deposits extra harvest into chests."
    pattern:
      - " C "
      - " H "
      - " C "
    ingredients:
      C: COPPER_INGOT
      H: WOODEN_HOE
```

### Key Fields

* `enabled` *(boolean)*: Toggle the recipe on or off.
* `result_item` *(Material / Custom ID)*: Bukkit Material or `craftengine:<id>` result item.
* `custom_model_data` *(int)*: CustomModelData integer for resource pack models.
* `display_name` *(string)*: Item name supporting color codes (`&a`, `&b`, etc.).
* `pattern` *(list of 3 strings)*: 3x3 crafting matrix pattern.
* `ingredients` *(map)*: Character map to vanilla materials, `upgrade:<id>_<tier>`, or `craftengine:<id>`.

## 2. Upgrades Configuration (`upgrades:`)

Define upgrade amounts, max tiers, and per-tier shaped crafting recipes:

```yaml
upgrades:
  speed:
    enabled: true
    display_name: "&eMovement Speed"
    amount_per_level: 0.05
    max_level: 5
    tiers:
      1:
        item: FEATHER
        craftengine_id: ""
        display_name: "&e⚡ Speed Core I &7[★☆☆☆☆]"
        lore:
          - "&7Increases golem movement speed by &a+15%&7."
        recipe:
          enabled: true
          shape:
            - " S "
            - "SFS"
            - " R "
          ingredients:
            S: SUGAR
            F: FEATHER
            R: REDSTONE
```

## 3. Customizable Nametags (`golem_names:`)

Controls the clean icon tag displayed overhead for each golem:

```yaml
golem_names:
  omni: "&6★"
  crop_farmer: "&a🌾"
  tree_farmer: "&2🪓"
  flower_farmer: "&e🌸"
  animal_rancher: "&c🐾"
  quarry: "&4⛏"
  sorter: "&d📦"
  transport: "&b🚚"
```

## 4. GUI Titles (`gui_titles:`)

Customize the title headers for all menus:

```yaml
gui_titles:
  crop_farmer: "&8[&a🌾&8] &aCrop Farmer Golem"
  tree_farmer: "&8[&2🪓&8] &2Tree Lumberjack"
  flower_farmer: "&8[&e🌸&8] &eFlower Farmer"
  quarry: "&8[&4⛏&8] &4Quarry Excavator"
  sorter: "&8[&d📦&8] &dSorting Golem"
  transport: "&8[&b🚚&8] &bItem Transport"
  animal_rancher: "&8[&c🐾&8] &cAnimal Rancher"
  omni: "&8[&6★&8] &6Omni Master Golem"
  connections: "&8[&b📡&8] &bConnections & Routes"
  chest_filter: "&8[&d✦&8] &dChest Filters: "
  equipment: "&8[&3⚔&8] &3Tool & Equipment"
  storage_editable: "&8[&2📦&8] &2Storage [Editable]"
  storage_live: "&8[&9📦&8] &9Storage [Live View]"
```

## 5. Anti-Oxidation & Rust Prevention (`anti_oxidation:`)

```yaml
anti_oxidation:
  enabled: true
```

{% hint style="info" %}
When `true`, prevents all smart golems from oxidizing, weathering, or freezing into statues.
{% endhint %}