> For the complete documentation index, see [llms.txt](https://wiki.staffplusplus.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.staffplusplus.org/master/features/staff-mode/custom-gui.md).

# 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

![](/files/-MQj76Rl4lTShqY6h-dl)

#### Mod

![](/files/-MQj7BEaWwpTsZkAp3IZ)

#### Admin

![](/files/-MQj7EWfhIy3TO1Iy9k3)


---

# 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, and the optional `goal` query parameter:

```
GET https://wiki.staffplusplus.org/master/features/staff-mode/custom-gui.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.