> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/edcompanions/features/guis.md).

# GUIs

All GUIs live in `guis/` and use the same config-driven framework as PinnaPrison. A GUI file:

```yaml
title: 'Companions'          # supports & codes, &#RRGGBB hex and custom-font glyphs
rows: 6
open-sound: 'ENTITY_BAT_TAKEOFF'
main-menu: ''                # GUI opened when this one closes (back navigation)
item-click-cooldown: 0
update-interval: 0           # ticks between auto-refreshes (0 = off)

pagination:                  # optional
  source: 'companion-storage'
  slots: '9-44'
  previous-page: { slot: 48, material: TIPPED_ARROW, name: '&c&lPrevious Page' }
  next-page:     { slot: 50, material: TIPPED_ARROW, name: '&a&lNext Page' }

items:
  my-button:
    material: DIAMOND        # or texture-<base64> / head-<name>
    slot: '46'               # int, list or ranges "0-8,17"
    name: '&3&lCompanion &b&lUpgrades'
    lore: [ '&7...' ]
    glow: false
    custom-item: { type: 'open-gui', gui: 'upgrades' }
    left-click-actions: [ 'sound BLOCK_NOTE_BLOCK_PLING' ]
```

## Bundled GUIs

| File                | Purpose                                                                         |
| ------------------- | ------------------------------------------------------------------------------- |
| `eggs.yml`          | The buy GUI on placed eggs — animations toggle, roll preview, 1x/3x/10x buttons |
| `companions.yml`    | Storage + equip slots + Equip Best + delete mode + navigation                   |
| `fusion.yml`        | 5 fuse slots, fuse + Fuse All buttons                                           |
| `upgrades.yml`      | Luck / Shiny / Rainbow / Void upgrade buttons                                   |
| `bulk-delete.yml`   | Per-rarity bulk delete                                                          |
| `display-modes.yml` | `/companions displaymode` picker                                                |

## Custom item types

`open-gui`, `animations-toggle`, `egg-open` (`amount`), `slot-indicator` (`index`, `locked:` sub-item, `equipped-lore`), `equip-best`, `storage-info`, `delete-mode`, `confirm-delete`, `fuse-slot` (`index`), `fuse`, `fuse-all`, `upgrade` (`upgrade`), `bulk-delete` (`rarity`), `display-mode` (`mode`).

## Paged sources

* `companion-storage` — the player's companions. The pagination section's `mode` (`equip` / `delete` / `fuse`) decides the click behavior, and the per-mode `*-lines` lists are appended to each entry's lore.
* `egg-companions` — the roll pool of the GUI's egg (`{egg}` placeholder), with `filtered-lines` appended to filtered entries. Clicking toggles the filter.

## Actions

Every item supports `left/right/shift-left/shift-right/any-click-actions` with the actions: `message`, `console`, `player`, `title`, `title-subtitle`, `sound`, `close`, `open-gui`, `give-economy <provider> <currency> <amount>`, `take-economy <provider> <currency> <amount>`.