# GUIs

Being available to players, the GUIs in PrisonPick serve a similar purpose: to make it easy for the player to perform an action or fetch information. The [Help GUI](#help-gui) and the [Pickaxe GUI](#pickaxe-gui) both do this. Items may not be removed from the GUI and the player will be prevented from clicking any items in their inventory as well.

## Help GUI

The Help GUI is a GUI that can be opened when a player uses the command `/prisonpick helpgui`. The player will be presented with a menu of base commands which, if applicable, can be clicked to view their subcommands.\
The fill material for both the Base Command GUI and the SubCommand GUI is black stained glass panes.\
\
The Help GUI is most likely the least customizable aspect of the plugin because it is only available to admins and is automatically changed based upon how many commands there are. This is so that I, the developer, do not have to change a part of the GUI every time I add/remove/change a command in the plugin.

### Base Command GUI

If a command has subcommands it's presented as a CHEST\_MINECART; otherwise, it will be presented as a MINECART. Every base command will be displayed with the item name being the base command and the lore being subcommands. The base command will be displayed with its most basic alias, such as `/prisonpick`.

{% hint style="info" %}
The lore will most likely include a description of the base command when there is a base command added that does not have any subcommands.
{% endhint %}

![A base command within the Base Command GUI](https://3456334028-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M6fEY18VuCweySnZ3g-%2F-MVfzW6aOJsRWJ07VbjV%2F-MVg19CmBzQMt883LyF3%2Fjavaw_8teGAB4BNA.png?alt=media\&token=c7e7ce6c-4826-4f89-ade1-c87623cfe8d9)

### Subcommands GUI

Subcommands are displayed through this GUI. Each subcommand will be displayed as a MINECART because a subcommand cannot have a subcommand. Detailed information about subcommands can be found within the lore of the item. This information is fetched from the [messages.yml](https://wiki.darrionatplugins.com/plugins/prisonpick/configuration-files/messages.yml-1.0.2), so the information of subcommands can be customized to a degree.

![A subcommand within the Subcommand GUI](https://3456334028-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M6fEY18VuCweySnZ3g-%2F-MVg2Jiv0qvAR_bn0Yn2%2F-MVg2PiyQluSi-oT4KD2%2Fjavaw_mKi71G8iOQ.png?alt=media\&token=5e4273df-3e80-48a0-8126-b6296dd59c66)

## Pickaxe GUI

The Pickaxe GUI is opened when a player right-clicks their custom item. This GUI is used to upgrade [enchantments](https://wiki.darrionatplugins.com/plugins/prisonpick/enchantments). The displayed name of the GUI, the number of rows in the GUI, and the fill item \[an item that occupies all empty slots] for the GUI can all be customized within the [config.yml](https://wiki.darrionatplugins.com/plugins/prisonpick/configuration-files/config.yml-1.0.2). Adding an enchantment will update the player's items to whatever new stats they have. Where/how this data is saved is mentioned [here](https://wiki.darrionatplugins.com/plugins/prisonpick/saving-data).\
\
Enchantments can also be upgraded in different amounts based upon the click type. This can be changed in the [enchants.yml](https://wiki.darrionatplugins.com/plugins/prisonpick/configuration-files/enchants.yml-1.0.2). Setting any of these to **MAX** will make it automatically calculate the max amount of levels that it can upgrade with the player's current balance.

| Click Type        | Upgrade Amount |
| ----------------- | -------------- |
| Left-Click        | 1              |
| Right-Click       | 10             |
| Shift Right-Click | 100            |
| Middle-Click      | MAX            |

{% hint style="info" %}
There will most likely be a way to display any item you want in the pickaxe GUI in the future. This will allow for placeholders, stats, etc to be displayed.
{% endhint %}

![The Night Vision enchantment within the Pickaxe GUI](https://3456334028-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M6fEY18VuCweySnZ3g-%2F-MVg3FijZ88yK8wdfcsI%2F-MVg6-bpmCsMRJH0TFvN%2Fjavaw_0HU4taahUT.png?alt=media\&token=ff17bbc4-865e-474a-bfab-ffca5f35aa08)


---

# Agent Instructions: 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://wiki.darrionatplugins.com/plugins/prisonpick/guis.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.