Flags

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

  1. material: Defines the material used to represent the flag in the menu. For example, you can use BOOK, DIAMOND_SWORD, RED_BANNER, etc.

  2. amount: Specifies the number of items to display. Default is 1.

  3. glowing: If set to true, the item will have a glowing effect. Useful to highlight certain flags.

  4. item_flags: You can add various item flags here like HIDE_ATTRIBUTES or HIDE_ENCHANTMENTS to hide attributes or enchantments in the menu item.

  5. model_data: If you are using custom models, this field specifies the model ID.

  6. display_name: Allows you to customize the name displayed in the flags menu. If not set, the default flag name will be used.

  7. 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.

<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:

Depending on the protection's current flag value:

  • ALLOW → Displays as: ✔ Allowed (green)

  • DENY → Displays as: ❌ Forbidden (red)

  • NONE → Displays as: ❓Undefined (gray)

<group>

The <group> placeholder displays to which group of players the flag rule is applied.

Group names are defined in the config.yml file under default-flag-groups, for example:

Meaning:

  • all → Everyone

  • members → Players listed as protection members

  • owners → Players listed as protection owners

  • nonmembers → Players who are NOT members

  • nonowners → Players who are NOT owners

Configuring click_type for Flag Items

This section explains how the click_type configuration works for flag items in the flags menu.

What is click_type?

click_type defines how players interact with a flag item inside the menu, depending on the mouse button or key they press.

Each interaction is linked to an action, allowing players to:

  • Edit the flag's group (who the rule applies to)

  • Toggle the flag's state (allow/deny)

Format

Each entry in click_type follows this format: <click_action>;<target_action>

  • click_action: The mouse or key event.

  • target_action: The behavior to trigger.

Available click actions:

Action
Description

left

Left mouse click

right

Right mouse click

both

Left and Right click

drop

Drop key (usually 'Q' on keyboard)

Available target actions:

Action
Description

groups

Opens or toggles the flag group selector (e.g., Members, Owners)

flag

Toggles the flag's state (Allow, Deny, None)

Meaning:

  • Left-click → Open or toggle the group selection.

  • Right-click → Toggle the flag between Allowed / Denied / Undefined.

Full Flags Configuration

PreviousPlugin´s FilesNextFAQ

Last updated