Saltar al contenido principal

Menu Configuration

The btcsky_menu_config manifest entry allows full visual and functional control over every GUI in the system.

Standard Component: SlotItemConfig​

Every item in every menu uses this structure for deep customization. Replaces the legacy MenuItemTemplate.

item — Item

The base material and properties. Supports Typewriter's Content Editor (HoldingItemContentMode).

name — String

Display name (supports MiniMessage and placeholders).

lore

" default="[]"> Multi-line lore (supports MiniMessage and placeholders).

glowing — Boolean

Adds an enchantment glint effect.

Interactive Button: GuiButtonConfig​

Standard button structure for menus. Replaces the legacy AdvancedMenuButtonConfig.

enabled — Boolean

Enable/disable this button.

template — SlotItemConfig

The item to display.

lockedTemplate — SlotItemConfig?

Visual template shown when click criteria are not met.

criteria

"> Criteria required to see this button.

clickCriteria

"> Criteria required to interact with this button.

clickSound — Sound

Sound played on click.

onClick

"> TypeWriter actions triggered on left-click.

onRightClick

"> TypeWriter actions triggered on right-click.

Base inventory settings shared by all menus. Replaces the legacy AdvancedBaseMenuConfig.

title — String

Menu title (supports MiniMessage and placeholders).

size — InventorySize

Inventory size (must be a multiple of 9, max 54).

audio — MenuAudioConfig

Audio configuration for open/close/click/scroll events.

criteria

"> Criteria required to open this menu.

openActions

"> TypeWriter actions executed when the menu opens.

closeActions

"> TypeWriter actions executed when the menu closes.

Pagination: GuiNavConfig​

List-based menus use a GuiNavConfig for prev/next navigation. Replaces the legacy AdvancedPaginationConfig.

prevButton — GuiButtonConfig

Configuration for the "Previous" button.

nextButton — GuiButtonConfig

Configuration for the "Next" button.

Global Buttons Map​

The buttons field is a Map<String, GuiButtonConfig> providing reusable action buttons keyed by name. Referenced by server-side code via button name.

Available Menus​

Each menu key corresponds to a specialized configuration object:

Core Menus​

  • controlPanel: The primary /is control panel (4|1|4 split layout).
  • dimensions: Dimension selection, travel, and unlocking.
  • upgrades: Progression upgrades list with pagination.
  • upgradeDetail: Single upgrade detail and purchase view.
  • members: Team management (online/offline heads, roles, kicks).
  • settings: Toggle flags (PvP, Fly, Visit, Mob Spawning) with shortcuts.
  • warps: Warp navigation, creation, deletion, and editing.
  • biomes: Biome selector with dimension cycling.

Feature Menus​

  • islandTop: Leaderboards with category sorting (Level, Bank, Rating).
  • blockValues: Island level calculation value display.
  • ratings: Star-based (1-5) rating system with history.
  • border: World border and possession border color customization.
  • visitors: Real-time guest monitoring with public islands shortcut.
  • publicIslands: Public islands browser with search.
  • publicIslandWarps: Public island warp teleport menu.
  • bans: Ban list management with unban functionality.
  • invitations: Pending coop/island invitation management.
  • contracts: Contract creation, applications, requirements, and storage.
  • research: Tech tree with branches, categories, and nodes.
  • researchWorkbench: Furnace-style research workbench (fragments, fuel, output).
  • holograms: Hologram list with create/rename/edit/delete modes.
  • hologramEdit: Per-hologram line editor (uses Minecraft 1.21.6 dialog system).
  • expansion: Interactive chunk purchase grid with dimension cycling.
  • combat: War declaration, history, and target selection.
  • collections: 3-layer collection UI (categories → items → detail).

Utility​

  • dialogs: Text configuration for native dialog prompts (accept, confirm, cancel).
  • confirmations: Reusable confirmation dialogs (disband, kick, ban, leave).
  • creation: Island creation template selection menu.

Placeholder Reference​

Available global placeholders across all menus:

PlaceholderDescription
%btcsky_island_level%Island level
%btcsky_island_worth%Island worth
%btcsky_island_name%Island name
%btcsky_owner_name%Owner name
%btcsky_member_count%Current member count
%btcsky_member_max%Maximum members allowed
%btcsky_dimension_current%Current dimension ID
%btcsky_bank_balance%Bank balance