Vanity Plates - Configuration

All of the configuration files for Vanity Plates are located in the <game_directory>/config/vanity_plates directory.

Configuration files:

• server.toml - Server side configuration options for Vanity Plates.
• gui.toml - GUI configuration options for Vanity Plates.

Server Configuration Options

server.toml

#Vanity Plates Server Config
[vanity_plates]
  prefixPriority = 1000
  [[vanity_plates.availablePlates]]
    label = "Demo"
    requiredPermission = "demo.plate"
    displayItem = "minecraft:paper"
    prefix = "[Demo]"

prefixPriority

The priority of the prefix when displayed in chat.

• Type: Integer
• Default: 1000
• Range: Greater than -2147483648

availablePlates

A list of available vanity plates that users can assign to themselves.

Each entry should be a config object with the following fields:

• displayItem: The item to display in the GUI (string, e.g., ‘minecraft:paper’)
• label: The label to display in the GUI (string)
• requiredPermission: The permission required to use this plate (string)
• prefix: The prefix to display in chat (string)
• customModelData: Optional custom model data for the display item (integer, optional)

GUI Configuration Options

gui.toml

#GUI Configuration
[gui]

  #GUI Text
  [gui.text]
    displayTitle = "Vanity Plates"
    clearPrefix = "Clear Prefix"
    exit = "Exit"
    previousPage = "Previous Page"
    nextPage = "Next Page"
    pageIndicator = "Page %current%/%length%"

  #GUI Display Items
  [gui.displayItems]
    frameItemId = "minecraft:gray_stained_glass_pane"
    prevNavigationItemId = "minecraft:arrow"
    nextNavigationItemId = "minecraft:arrow"
    clearItemId = "minecraft:name_tag"
    pageItemId = "minecraft:book"
    exitItemId = "minecraft:barrier"

  #GUI Colors
  [gui.colors]
    titleColor = "GOLD"
    navigationItemColor = "AQUA"
    clearItemColor = "RED"
    pageItemColor = "GOLD"
    exitItemColor = "RED"

  #GUI Back button Configuration
  [gui.backButton]
    enabled = false
    itemId = "minecraft:recovery_compass"
    label = "Back to Previous Menu"
    color = "RED"
    command = "gui open example-main %player%"

  #GUI Permissions
  [gui.permissions]
    clearPrefixUiButtonPermission = ""

GUI Text Configuration

Allows configuration of the text displayed in the Vanity Plates GUI.

displayTitle

The title of the Vanity Plates GUI.

• Type: String
• Default: "Vanity Plates"

clearPrefix

The text for the ‘Clear Prefix’ button in the GUI.

• Type: String
• Default: "Clear Prefix"

exit

The text for the ‘Exit’ button in the GUI.

• Type: String
• Default: "Exit"

previousPage

The text for the ‘Previous Page’ button in the GUI.

• Type: String
• Default: "Previous Page"

nextPage

The text for the ‘Next Page’ button in the GUI.

• Type: String
• Default: "Next Page"

pageIndicator

The text for the page indicator in the GUI. Use %current% and %length% as placeholders for the current page and total pages.

• Type: String
• Default: "Page %current%/%length%"

GUI Display Items Configuration

Allows configuration of the items used in the Vanity Plates GUI.

frameItemId

The item ID for the frame item in the GUI.

• Type: String
• Default: "minecraft:gray_stained_glass_pane"

prevNavigationItemId

The item ID for the ‘Previous Page’ button in the GUI.

• Type: String
• Default: "minecraft:arrow"

nextNavigationItemId

The item ID for the ‘Next Page’ button in the GUI.

• Type: String
• Default: "minecraft:arrow"

clearItemId

The item ID for the ‘Clear Prefix’ button in the GUI.

• Type: String
• Default: "minecraft:name_tag"

pageItemId

The item ID for the page indicator in the GUI.

• Type: String
• Default: "minecraft:book"

exitItemId

The item ID for the ‘Exit’ button in the GUI.

• Type: String
• Default: "minecraft:barrier"

GUI Colors Configuration

Allows configuration of the colors used in the Vanity Plates GUI.

Allowed Values for Colors:

• BLACK
• DARK_BLUE
• DARK_GREEN
• DARK_AQUA
• DARK_RED
• DARK_PURPLE
• GOLD
• GRAY
• DARK_GRAY
• BLUE
• GREEN
• AQUA
• RED
• LIGHT_PURPLE
• YELLOW
• WHITE

titleColor

The color of the GUI title.

• Default: "GOLD"

navigationItemColor

The color of the navigation items in the GUI.

• Default: "AQUA"

clearItemColor

The color of the ‘Clear Prefix’ button in the GUI.

• Default: "RED"

pageItemColor

The color of the page indicator in the GUI.

• Default: "GOLD"

exitItemColor

The color of the ‘Exit’ button in the GUI.

• Default: "RED"

GUI Back Button Configuration

Configuration for the back button in the Vanity Plates GUI.

enabled

Whether the back button is enabled in the GUI.

• Type: Boolean
• Default: false

itemId

The item ID for the back button in the GUI.

• Type: String
• Default: "minecraft:recovery_compass"

label

The label for the back button in the GUI.

• Type: String
• Default: "Back to Previous Menu"

color

The color of the back button in the GUI.

• Default: "RED"

command

The command to execute when the back button is pressed in the GUI.

• Type: String
• Default: "gui open example-main %player%"

GUI Permissions Configuration

Permissions related to the Vanity Plates GUI.

clearPrefixUiButtonPermission

The permission required to see the ‘Clear Prefix’ button in the GUI.

• Type: String
• Default: "" (no permission required)