# Custom GUI

We have added the ability to customize the GUI you receive when entering staff mode.\
Previously in Staff+ you already could add custom modules and switch certain modules on and off.\
We have taken that one step further and added the ability to create a custom GUI based on permissions.

{% hint style="info" %}
This configuration section is completely optional. If you don't add the `custom-gui` configuration, the staff-mode GUI will be shown based on the module configurations.
{% endhint %}

## Configuration

Example of a valid GUI configuration

```yaml
staff-mode:
  custom-gui:
    # key, can be anything
    Helper:
      # Permission needed to see this gui
      permission: rank.helper
      # Determines which gui will be shown if the staff member has multiple gui permissions.
      # A greater weight value will get priority.
      weight: 1
      # The gui items. Format "modulename:inventorySlot"
      gui:
      - compass-module:1
      - vanish-module:2
      - counter-module:3
      - follow-module:4
    Mod:
      permission: rank.moderator
      weight: 2
      gui:
      - compass-module:1
      - random-teleport-module:2
      - vanish-module:3
      - counter-module:4
      - freeze-module:5
      - follow-module:6
      - Whip:7
    Admin:
      permission: rank.admin
      weight: 3
      gui:
      - compass-module:1
      - random-teleport-module:2
      - vanish-module:3
      - gui-module:4
      - counter-module:5
      - freeze-module:6
      - cps-module:7
      - examine-module:8
      - follow-module:9
  custom-modules:
    Whip:
      enabled: true
      type: ITEM
      slot: 34
      item: STICK
      name: '&7Knock out stick'
      lore: '&8Knock em out!!'
      enchantment: knockback:2
```

{% hint style="warning" %}

* If a staff-mode module is disabled it won't show up in the GUI 
* If a player has the permission to enter staff mode but none of the GUI permissions, his GUI will just be empty 
* Custom modules can also be used inside the GUI config. Make sure the key name matches.
  {% endhint %}

### Example GUI

The following GUIs are displayed while in staff-mode depending on your permissions.

#### Helper

![](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MQj5Lpud-QCj0TGXYSO%2F-MQj76Rl4lTShqY6h-dl%2Fmode-helper.png?alt=media\&token=4a31ba96-ce95-43e0-9c36-07ecc4f35b87)

#### Mod

![](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MQj5Lpud-QCj0TGXYSO%2F-MQj7BEaWwpTsZkAp3IZ%2Fmode-mod.png?alt=media\&token=9b320c4e-08e0-41d1-b6f0-e6c05086988a)

#### Admin

![](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MQj5Lpud-QCj0TGXYSO%2F-MQj7EWfhIy3TO1Iy9k3%2Fmode-admin.png?alt=media\&token=640e4907-a364-4ec9-a3bc-87885c26d942)