Dungeon Party Menu - BornToCraft STUDIO

Global action entry for the dungeon party lobby selection menu. This entry is not linked to a specific dungeon instance — the instance is passed at runtime. Uses the GUI layout system via layoutPool and mainLayoutId. Use the buttons field to configure which interactive buttons appear and at which virtual coordinates.

Layout System

The menu uses the GUI extension’s layout engine exclusively. The parsed layout defines the visual structure, and dungeon-specific dynamic items (lobby slots, ready, leave, auto-fill, info buttons) are automatically composed on top via CompositeLayout. Buttons use virtual coordinates (x, y) instead of raw slot indices, making them compatible with all layout types including scrollable and composite layouts. (0, 0) is top-left, (8, 5) is bottom-right for a 6-row inventory.

Buttons System

Use the buttons list to configure interactive buttons. Each entry defines a type (enum), optional x/y position, and optional visual overrides (item, name, lore). If a button type is present in buttons, it overrides the per-field defaults. If absent, the individual fields are used as fallback with their default position converted to (x, y).

Available Button Types

Type	Description	Default Position
`INFO`	Information button	(8, 5)
`READY`	Ready / Not Ready toggle (dual-state)	(3, 5)
`LEAVE`	Leave lobby button	(0, 5)
`AUTO_FILL`	Auto-join first available lobby	(5, 5)

Configuration

Configuration for the dungeon party menu.

Show Properties

lobbyItem

Item

Item used for lobby slots.

fillItem

Item

Item used to fill empty slots.

inventoryTitle

Var<String>

Title of the inventory. Supports placeholders.

lobbyName

Var<String>

Name format for lobby slots. Supports {index}, {players}, {max}, {available}, {status}, {ready}, {time}.

lobbyLore

List<Var<String>>

Lore format for lobby slots. Supports {index}, {players}, {max}, {available}, {status}, {ready}, {time}, {player_names}, {ready_players}, {not_ready_players}.

joinMessage

Var<String>

Message sent to the lobby when a player joins. Supports {player}.

quitMessage

Var<String>

Message sent to the lobby when a player leaves. Supports {player}.

fillName

Var<String>

Name for filler items.

fillLore

List<Var<String>>

Lore for filler items.

readyItem

Item

Item used when player is ready.

notReadyItem

Item

Item used when player is not ready.

readyName

Var<String>

Name when player is ready.

readyLore

List<Var<String>>

Lore when player is ready.

notReadyName

Var<String>

Name when player is not ready.

notReadyLore

List<Var<String>>

Lore when player is not ready.

leaveItem

Item

Item used to leave the lobby.

leaveName

Var<String>

Name for the leave item.

leaveLore

List<Var<String>>

Lore for the leave item.

enableWaitingScoreboard

Boolean

default:"false"

Enable temporary waiting scoreboard.

scoreboardTitle

Var<String>

Title for the waiting scoreboard.

scoreboardCountdown

List<Var<String>>

Line shown while counting down. Supports {time}.

scoreboardWaiting

List<Var<String>>

Line shown when waiting for players. Supports {missing}.

infoItem

Item

Item used for information slot.

infoName

Var<String>

Name for the information item.

infoLore

List<Var<String>>

Lore for the information item.

readyPlayerPrefix

Var<String>

Prefix for ready players in lobby lore.

readyPlayerSuffix

Var<String>

Suffix for ready players in lobby lore.

notReadyPlayerPrefix

Var<String>

Prefix for not-ready players in lobby lore.

notReadyPlayerSuffix

Var<String>

Suffix for not-ready players in lobby lore.

autoFillItem

Item

Item used for auto-fill button.

autoFillName

Var<String>

Name for the auto-fill button.

autoFillLore

List<Var<String>>

Lore for the auto-fill button.

buttons

List<DungeonButtonSlot>

Button configurations. Overrides individual item/name/lore defaults when a type is present. Each type appears at most once.

Show DungeonButtonSlot

type

DungeonButtonType

default:"INFO"

Button type: INFO, READY, LEAVE, or AUTO_FILL.

Optional<Int>

X position in the virtual grid (0-8). If not set, uses the button’s default position converted to x.

Optional<Int>

Y position in the virtual grid (0-5). If not set, uses the button’s default position converted to y.

item

Optional<Item>

Override item. Uses individual field default if not set.

name

Optional<Var<String>>

Override display name.

lore

Optional<List<Var<String>>>

Override lore lines.

guiType

GuiType

default:"CUSTOM"

GUI type (CUSTOM, BOOK, etc.).

layoutPool

List<LayoutData>

Pool of layout definitions. Supports Simple, Flex, Paginated, Scrollable, Frame, and Composite layouts.

mainLayoutId

Optional<String>

ID of the main layout to display from the pool.

globalInteractions

List<InteractionData>

Global interactions (keybinds, clicks).

audio

GuiAudioData

Audio configuration (onOpen, onClose, onScroll, onClick).

​Layout System

​Buttons System

​Available Button Types

​Configuration

Layout System

Buttons System

Available Button Types

Configuration