Vanity Plates - Configuration

The configuration files will be located at <game_directory>/config/vanity_plates/

The Main Configuration File

The main configuration file is config.json, which contains the following fields:

{
  "prefixPriority": 1000,
  "availablePlates": [
    {
      "displayItem": "minecraft:paper",
      "customModelData": null,
      "label": "Demo",
      "requiredPermission": "demo.plate",
      "prefix": "[Demo]"
    }
  ]
}

prefixPriority

The prefixPriority field determines the priority of the vanity plate prefixes compared to other prefixes in the chat. A higher value means that the vanity plate prefix will be displayed before other prefixes with a lower priority.

availablePlates

The availablePlates field is an array of objects, each representing a vanity plate that users can assign to themselves. Each object has the following properties:

displayItem: The item that will be displayed in the GUI for this vanity plate. This should be a valid Minecraft item ID.
customModelData: (Optional) The custom model data value for the display item, if applicable. This can be used to differentiate between different variants of the same item.
label: The label that will be shown in the GUI for this vanity plate.
requiredPermission: The permission node that a user must have to be able to assign this vanity plate to themselves. This should be configured in your permissions plugin (e.g., LuckPerms).
prefix: The actual prefix that will be displayed in the chat when a user has this vanity plate assigned. This can include formatting codes (e.g., color codes) if desired.

UI Configuration

The UI configuration file is ui.json, which contains the following fields:

{
  "text": {
    "displayTitle": "Vanity Plates",
    "clearPrefix": "Clear Prefix",
    "exit": "Exit",
    "previousPage": "Previous Page",
    "nextPage": "Next Page",
    "pageIndicator": "Page %current%/%length%"
  },
  "displayItems": {
    "frameItemId": "minecraft:gray_stained_glass_pane",
    "prevNavigationItemId": "minecraft:arrow",
    "nextNavigationItemId": "minecraft:arrow",
    "clearItemId": "minecraft:name_tag",
    "pageItemId": "minecraft:book",
    "exitItemId": "minecraft:barrier"
  },
  "colors": {
    "title": "GOLD",
    "navigationItem": "AQUA",
    "clearItem": "RED",
    "pageItem": "GOLD",
    "exitItem": "RED"
  },
  "backButton": {
    "enabled": false,
    "itemId": "minecraft:recovery_compass",
    "label": "Back to Previous Menu",
    "textColor": "RED",
    "command": "gui open example-main %player%"
  },
  "permissions": {
    "clearPrefixUiButton": ""
  }
}

Text

The text section of the UI configuration file contains the following fields:

displayTitle: The title that will be displayed at the top of the vanity plates GUI.
clearPrefix: The label for the button that allows users to clear their assigned vanity plate prefix.
exit: The label for the button that allows users to exit the vanity plates GUI.
previousPage: The label for the button that allows users to navigate to the previous page of vanity plates in the GUI.
nextPage: The label for the button that allows users to navigate to the next page of vanity plates in the GUI.
pageIndicator: The format for the page indicator that shows the current page number and total number of pages in the vanity plates GUI. The placeholders %current% and %length% will be replaced with the current page number and total number of pages, respectively.

Display Items

The displayItems section of the UI configuration file contains the following fields:

frameItemId: The item that will be used as the frame for the vanity plates GUI. This should be a valid Minecraft item ID.
prevNavigationItemId: The item that will be used for the previous page navigation button in the vanity plates GUI. This should be a valid Minecraft item ID.
nextNavigationItemId: The item that will be used for the next page navigation button in the vanity plates GUI. This should be a valid Minecraft item ID.
clearItemId: The item that will be used for the button that allows users to clear their assigned vanity plate prefix. This should be a valid Minecraft item ID.
pageItemId: The item that will be used for the page indicator in the vanity plates GUI. This should be a valid Minecraft item ID.
exitItemId: The item that will be used for the button that allows users to exit the vanity plates GUI. This should be a valid Minecraft item ID.

Colors

The colors section of the UI configuration file contains the following fields:

title: The color of the title text in the vanity plates GUI. This should be a valid Minecraft color name (e.g., “GOLD”, “AQUA”).
navigationItem: The color of the navigation buttons (previous and next page) in the vanity plates GUI. This should be a valid Minecraft color name.
clearItem: The color of the button that allows users to clear their assigned vanity plate prefix in the vanity plates GUI. This should be a valid Minecraft color name.
pageItem: The color of the page indicator in the vanity plates GUI. This should be a valid Minecraft color name.
exitItem: The color of the button that allows users to exit the vanity plates GUI. This should be a valid Minecraft color name.

Back Button

The backButton section allows you to configure an optional back button in the vanity plates GUI that can take users to a previous menu. The fields are as follows:

enabled: A boolean value that determines whether the back button is enabled or not. Set to true to enable the back button, or false to disable it.
itemId: The item that will be used for the back button in the vanity plates GUI. This should be a valid Minecraft item ID.
label: The label for the back button in the vanity plates GUI.
textColor: The color of the back button label text in the vanity plates GUI. This should be a valid Minecraft color name.
command: The command that will be executed when a user clicks the back button in the vanity plates GUI. You can use %player% as a placeholder for the player’s name in the command. (you can also use %uuid% as a placeholder for the player’s UUID)

Permissions

The permissions section allows you to configure permissions for certain UI elements in the vanity plates GUI. The fields are as follows:

clearPrefixUiButton: The permission node required for a user to see and use the button that allows them to clear their assigned vanity plate prefix in the vanity plates GUI. If left empty, all users will be able to see and use the button.