Skip to main content

GUI Settings

The GUI Settings entry defines global defaults for all GUIs: lifecycle audio, storage click behaviors, and skill tree node connector items. Type: Manifest Entry Entry ID: gui_settings

Configuration

Audio Defaults

FieldTypeDefaultDescription
onOpenSound?nullSound played when any GUI opens
onCloseSound?nullSound played when any GUI closes
onScrollSound?nullSound played on scroll events
onClickSound?nullSound played on any click
Each sound accepts:
  • sound — Bukkit Sound enum value (e.g., block.chest.open)
  • volume — Float (0.0 to 1.0+)
  • pitch — Float (0.5 to 2.0)

Storage Interaction Configuration

Controls which click types perform each storage action. All values are optional and fall back to sensible defaults.
FieldTypeDefaultDescription
placeOneClickStorageClickTypeLEFTPlace one item from cursor
placeAllClickStorageClickTypeSHIFT_LEFTPlace all items from cursor
takeOneClickStorageClickTypeRIGHTTake one item from slot
takeAllClickStorageClickTypeSHIFT_RIGHTTake all items from slot
takeStackClickStorageClickTypeSWAP_OFFHANDTake one full stack (64)
fillFromInvClickStorageClickTypeDOUBLE_CLICKFill slot from player inventory
dropAllClickStorageClickTypeDROPDrop all items from slot on ground

StorageClickType Values

ValueBukkit Equivalent
LEFTLeft click
RIGHTRight click
SHIFT_LEFTSneak + left click
SHIFT_RIGHTSneak + right click
MIDDLEMiddle click (scroll wheel press)
DOUBLE_CLICKDouble click
DROPDrop key (Q)
DROP_ALLCtrl + Drop (Ctrl+Q)
SWAP_OFFHANDSwap to offhand (F)

Node Defaults

FieldTypeDefaultDescription
connectorLinesGuiItemData?nullDefault item for skill tree connector lines

Example

manifest:
  type: gui_settings
  id: "global_gui_settings"
  audioDefaults:
    onOpen:
      sound: "block.chest.open"
      volume: 1.0
      pitch: 1.0
    onClose:
      sound: "block.chest.close"
      volume: 1.0
      pitch: 1.0
    onScroll:
      sound: "ui.button.click"
      volume: 0.5
      pitch: 1.5
    onClick:
      sound: "ui.button.click"
      volume: 1.0
      pitch: 1.0
  storageInteraction:
    placeOneClick: LEFT
    placeAllClick: SHIFT_LEFT
    takeOneClick: RIGHT
    takeAllClick: SHIFT_RIGHT
    takeStackClick: SWAP_OFFHAND
    fillFromInvClick: DOUBLE_CLICK
    dropAllClick: DROP