In this section, you have access to the default yml file. This file contains the standard configuration that is used as a starting point for customization and specific configuration.
General Information
In this section you will be able to customize the flags menu item, since by default RED_BANNER will be used.
DisplayName
If you include the display_name path: , you can modify the name to be displayed in the flags menu.
display_name: "Greetings"
Description format
description: |-
&7The message that appears in
&7chat upon entering the region.
description: "&7The message that appears in \n &7chat upon entering the region."
If the flag appears with a red banner, it indicates that the flag configuration was not found in the flags.yml file. To address this, simply create the configuration section and reload the plugin.
Configuration Section:
flags:
greeting: # Flag name
material: BOOK # Material of the item representing the flag
amount: 1 # Item quantity
glowing: false # Whether the item should glow
item_flags:
- HIDE_ATTRIBUTES # Item flag, you can add others like HIDE_ENCHANTMENTS
model_data: 0 # Model data (if using a custom model)
display_name: "Greetings" # Name to be shown in the flags menu
description: |-
&7The message that appears
&7in chat when entering the region.
Explanation of Each Field
material:
Defines the material used to represent the flag in the menu. For example, you can use BOOK, DIAMOND_SWORD, RED_BANNER, etc.
amount:
Specifies the number of items to display. Default is 1.
glowing:
If set to true, the item will have a glowing effect. Useful to highlight certain flags.
item_flags:
You can add various item flags here like HIDE_ATTRIBUTES or HIDE_ENCHANTMENTS to hide attributes or enchantments in the menu item.
model_data:
If you are using custom models, this field specifies the model ID.
display_name:
Allows you to customize the name displayed in the flags menu. If not set, the default flag name will be used.
description:
The description shown in the item's lore inside the menu. You can use formats like &7 for color and text style. Line breaks can be added using or YAML's |- or | notation for better control.
Placeholders Explanation - Flags Menu
This section explains how the and placeholders work within the flag menu configuration.
flags:
# The title of the inventory.
name: "&8☀ Flags Editor - [<page> / <totalpages>]"
# The size of the inventory.
# Must be a multiple of 9. (9, 18, 27, 36, 45, 54)
size: 54
# In this section you will not be able to add new items to the menu, only edit the current ones.
# If you want to add more items use the custom-items section:
items:
icons:
# These will be the slots in which the flags will be automatically placed.
slot: 10,11,12,13,14,15,16,19,20,21,22,23,24,25,28,29,30,31,32,33,34,37,38,39,40,41,42,43
display_name: '&aEdit Flag <flag>'
click_type:
- left;groups
- right;flag
# - both;groups
# - drop;flag
lore:
- "&8ᴄᴏɴғɪɢᴜʀᴀʙʟᴇ ғʟᴀɢ"
- ""
- "&7 <description>"
- ""
- "&6 ☀ ɪɴғᴏʀᴍᴀᴛɪᴏɴ"
- "&8➞ &fState: &a<state>"
- "&8➞ &fGroup: &a<group>"
- ""
clicked:
textflag: "&e► Click to add a text!"
drop: "&e► Drop - Toggle groups!"
both: "&e► Right click - Activate or deactivate the flag!"
left: "&e► Left Click - Toggle groups!"
right: "&e► Right click - Activate or deactivate the flag!"
noperms: "&c► You do not have permissions"
<state>
The <state> placeholder dynamically displays the current status of a flag (such as PvP, Build, Chest Access, etc.) based on the flag's current value.
Each flag defines how its states look in the flags.yml file under display_states, like this: