GUI Settings

GUI Global Settings

ManifestProvided by GUI

Global settings for the GUI Extension. Allows defining default sounds, storage interaction config, and skill tree node connectors.

Fields

Field	Type	Default	Description
audioDefaults	MenuAudioConfig	—	Default sounds for every menu. A sound set here is played when the open_gui action leaves that sound empty (open, close, scroll, click); a sound set on the action always wins. MenuAudioConfig (4) Field Type Default Description onOpen Sound? — Sound played when the GUI is opened. onClose Sound? — Sound played when the GUI is closed. onScroll Sound? — Sound played when the GUI is scrolled. onClick Sound? — Sound played when an item is clicked.
scrollArrows	List<ScrollArrowConfig>	empty	Default arrows of scrollable layouts (those with showDefaultButtons on). Add only the directions to customize: an arrow with no entry here is a plain arrow item named ▲ ▼ ◀ ▶, in the right column (up, down) or the bottom row (left, right). ScrollArrowConfig (4) Field Type Default Description direction ScrollDirection UP Scroll direction this arrow stands for.Values:UPDOWNLEFTRIGHT item Item? — Item of the arrow. Leave empty for a plain arrow. x Int? — Column of the arrow in the menu (0 = leftmost). Leave empty for the default place. y Int? — Row of the arrow in the menu (0 = top). Leave empty for the default place.
storageInteraction	StorageInteractionConfig	—	Configure which mouse/keyboard clicks trigger each storage action (place, take, fill, drop). StorageInteractionConfig (7) Field Type Default Description placeOneClick StorageClickType LEFT Click to place ONE item from cursor into the storage slotValues:LEFTRIGHTSHIFT_LEFTSHIFT_RIGHTMIDDLEDOUBLE_CLICKDROPDROP_ALLSWAP_OFFHAND placeAllClick StorageClickType SHIFT_LEFT Click to place ALL items from cursor into the storage slotValues:LEFTRIGHTSHIFT_LEFTSHIFT_RIGHTMIDDLEDOUBLE_CLICKDROPDROP_ALLSWAP_OFFHAND takeOneClick StorageClickType RIGHT Click to take ONE item from the storage slot onto cursorValues:LEFTRIGHTSHIFT_LEFTSHIFT_RIGHTMIDDLEDOUBLE_CLICKDROPDROP_ALLSWAP_OFFHAND takeAllClick StorageClickType LEFT Click to take ALL items from the storage slot onto cursorValues:LEFTRIGHTSHIFT_LEFTSHIFT_RIGHTMIDDLEDOUBLE_CLICKDROPDROP_ALLSWAP_OFFHAND takeStackClick StorageClickType SHIFT_RIGHT Click to take a full STACK (64) from the storage slot into inventoryValues:LEFTRIGHTSHIFT_LEFTSHIFT_RIGHTMIDDLEDOUBLE_CLICKDROPDROP_ALLSWAP_OFFHAND fillFromInvClick StorageClickType SWAP_OFFHAND Click to FILL the storage slot from the player inventoryValues:LEFTRIGHTSHIFT_LEFTSHIFT_RIGHTMIDDLEDOUBLE_CLICKDROPDROP_ALLSWAP_OFFHAND dropAllClick StorageClickType DROP Click to DROP all items from the storage slot onto the groundValues:LEFTRIGHTSHIFT_LEFTSHIFT_RIGHTMIDDLEDOUBLE_CLICKDROPDROP_ALLSWAP_OFFHAND
nodeDefaults	List<NodeConnectorConfig>	empty	Skill Tree connector items. Add only the state and direction combinations that need a custom item. NodeConnectorConfig (3) Field Type Default Description state NodeState UNLOCKED Skill Tree node state.Values:UNLOCKEDUNLOCKABLELOCKEDFULLY_LOCKED direction NodeDirection NONE Neighbour directions represented by this connector.Values:NONEUPDOWNLEFTRIGHTUP_DOWNUP_LEFTUP_RIGHTDOWN_LEFTDOWN_RIGHTLEFT_RIGHTUP_DOWN_LEFTUP_DOWN_RIGHTUP_LEFT_RIGHTDOWN_LEFT_RIGHTUP_DOWN_LEFT_RIGHTNO_PATH item Item — Item displayed for this state and direction.
texts	GuiTextSettings	—	Default texts the extension itself shows to players: the buttons of its dialogs and the progress line of storage slots that collect a required amount. GuiTextSettings (7) Field Type Default Description inputConfirmLabel String Confirm Label of the button that validates an input dialog (the dialog with a text field). MiniMessage and PlaceholderAPI supported.Colors confirmLabel String <green>Confirm Label of the confirm button of a yes/no dialog. MiniMessage and PlaceholderAPI supported.Colors cancelLabel String <red>Cancel Label of the cancel button of a yes/no dialog. MiniMessage and PlaceholderAPI supported.Colors storageProgressLine String <gray>Progress: <white>{current}/{required} {bar} Lore line of a storage slot that collects a required amount, shown once something was collected. Tokens: {current} (amount collected), {required} (amount to reach) and {bar} (the progress bar below). MiniMessage and PlaceholderAPI supported.Colors progressBarFilled String <green>■ One filled segment of the progress bar (MiniMessage). It is repeated once per filled step.Colors progressBarEmpty String <gray>■ One empty segment of the progress bar (MiniMessage). It is repeated once per remaining step.Colors progressBarLength Int 10 Number of segments of the progress bar.

How to use it

Create at most one of these entries; GUI reads the first one it finds.

• storageInteraction maps a click to each storage action. Defaults: place one LEFT, place all SHIFT_LEFT, take one RIGHT, take all LEFT, take a stack SHIFT_RIGHT, fill from inventory SWAP_OFFHAND, drop all DROP. A shift-right click with a matching item on the cursor always deposits.

• nodeDefaults lists connector items for skill tree nodes, by state and direction.

• audioDefaults is the fallback for every Open GUI: a sound left empty in the action's audio (open, close, scroll, click) is taken from here, sound by sound. A sound set on the action wins. A sound field that is present on the action but has no sound chosen counts as set, so the fallback does not play; leave the field unset to use the default.

• texts holds what GUI shows by itself, outside the menus you build. inputConfirmLabel (Confirm) is the button of a dialog with a text field; confirmLabel (<green>Confirm) and cancelLabel (<red>Cancel) are the buttons of a yes/no dialog. storageProgressLine (<gray>Progress: <white>{current}/{required} {bar}) is the lore line of a storage slot that collects a required amount, where {current} is the amount collected, {required} the amount to reach and {bar} the progress bar. The bar is progressBarLength segments (10): progressBarFilled (<green>■) for each filled step and progressBarEmpty (<gray>■) for the rest. All of them accept MiniMessage and PlaceholderAPI.

• scrollArrows customizes the default arrows of scrollable layouts (those with showDefaultButtons on). Add only the directions to change: each entry has a direction, an optional item, name (MiniMessage), x and y. What an entry leaves empty keeps the default (a plain arrow item named ▲ ▼ ◀ ▶, in column 8 for up and down and on the last row for left and right). An arrow never covers another slot: if its cell is taken, it is not shown.