Skip to main content

Nameplate Menu Config

Type: nameplate_menu_config The main configuration for the Nameplate Selection Menu. This defines the layout, look, and feel of the GUI.
FieldTypeDefaultDescription
idString""Unique identifier.
titleString”Nameplates”Menu title. Supports placeholders.
rowsInt6Total rows (1-6).
fillItemItemGray PaneFiller item for empty slots.
nameplateSlotsList<Int>[10..16, 19..25, …]Slots to populate with nameplates.

Templates

Defines how nameplates look in different states.
FieldTypeDescription
lockedTemplateTemplateAppearance when player lacks permission.
unlockedTemplateTemplateAppearance when available but not equipped.
equippedTemplateTemplateAppearance when equipped.
emptySlotTemplateTemplateAppearance for unused nameplate slots.

Item Template

A structure containing:
  • item: Base item (Material, Model Data).
  • name: Display name.
  • lore: Lore lines.
  • glowing: Enchantment glint (boolean).

Buttons

Configuration for navigation/utility buttons.
FieldTypeDescription
closeButtonButton ConfigCloses the menu.
previousPageButtonButton ConfigGo to previous page.
nextPageButtonButton ConfigGo to next page.
unequipButtonButton ConfigButton to unequip current nameplate.

Button Config

A structure containing:
  • enabled: Boolean.
  • slot: Position index.
  • item: Display item.
  • name: Display name.
  • lore: Lore lines.

Sounds

FieldTypeDescription
openSoundSoundSound on menu open.
equipSoundSoundSound on equip.
previewSoundSoundSound on preview.
errorSoundSoundSound on error.

Nameplates List

The nameplates field is a list of objects defining each available nameplate:
FieldTypeDescription
nameplateIdStringID from CustomNameplates.
permissionStringCustom permission (optional).
itemItemCustom icon (overrides template).
lockedLoreOverrideList<String>Custom lore when locked.
unlockedLoreOverrideList<String>Custom lore when unlocked.
equippedLoreOverrideList<String>Custom lore when equipped.
orderIntSort order.