Configuration — config.yml

The config.yml file is generated automatically at plugins/NXGuard/config.yml the first time the server starts with the plugin. To apply changes use /guard reload or restart the server.

Note: the config.yml generated by the current version ships with its titles and messages in Spanish. The English text below is the translated equivalent — copy it into your config.yml if you want an English GUI and English messages.

---

Full file with comments

# NXGuard — general configuration
# Colors with legacy codes (&a, &c, etc.)

settings:
  # How many regions are shown per page in the main menu.
  # Recommended value: 45 (maximum for a 54-slot inventory with a navigation row).
  regions-per-page: 45

gui:
  # Title of the main regions menu.
  # Placeholders: {page} = current page, {max_page} = total pages.
  main-title: "&8Regions &7— &fPage {page}/{max_page}"

  # Title of a region's flags menu.
  # Placeholder: {region} = region name.
  flags-title: "&8Flags &7— &f{region}"

  # Item that represents each region in the main menu.
  region-item:
    material: WHITE_BANNER
    name: "&e{region}"
    lore:
      - "&7World: &f{world}"
      - "&7Priority: &f{priority}"
      - "&7Active flags: &f{active_flags}"
      - ""
      - "&aLeft click &7→ edit flags"

  # Item for flags in ALLOW state (enabled).
  flag-active:
    material: LIME_DYE
    name: "&a{flag}"

  # Item for flags in DENY state (explicitly disabled).
  flag-deny:
    material: RED_DYE
    name: "&c{flag}"

  # Item for flags in NONE state (no value set, neutral).
  flag-inactive:
    material: GRAY_DYE
    name: "&7{flag}"

  # Navigation buttons
  navigation:
    previous:
      material: ARROW
      name: "&e← Previous page"
    next:
      material: ARROW
      name: "&eNext page →"
    back:
      material: BARRIER
      name: "&cBack to list"

messages:
  prefix: "&8[&6NXGuard&8] &r"
  no-permission: "&cYou don't have permission to do that."
  reload-success: "&aConfiguration and messages reloaded."
  worldguard-missing: "&cWorldGuard is not available."
  player-only: "&cThis command can only be used in-game."
  region-not-found: "&cRegion &f{region}&c was not found in this world."
  no-regions: "&cThere are no regions in this world."

  # Help menu lines (/guard with no arguments).
  help:
    - "&6NXGuard &7— commands:"
    - "&e/guard gui &7— regions menu"
    - "&e/guard info <region> &7— information about a region"
    - "&e/guard reload &7— reload configuration"

  # Format of /guard info <region>
  info-header: "&6Region &e{region}"
  info-world: "&7World: &f{world}"
  info-priority: "&7Priority: &f{priority}"
  info-owners: "&7Owners: &f{owners}"
  info-members: "&7Members: &f{members}"
  info-active-flags: "&7Active flags: &f{count}"
  info-edit-engine: "&7Edit engine: &f{engine}"
  info-flags-list: "&7Flags:"
  info-flag-line: "  &8- &f{flag}&8: &7{value}"

  # Flag action messages
  flag-updated: "&aFlag &f{flag} &aupdated."
  flag-not-editable: "&cThis flag cannot be edited from the GUI."

  # Console messages on startup
  startup-edit-engine: "Edit engine detected: {engine}"
  startup-extra-flags: "WorldGuard Extra Flags detected — additional flags available."
  startup-extra-flags-missing: "WorldGuard Extra Flags not installed (optional)."

---

Section reference

settings

Key	Type	Description
regions-per-page	Integer (1-45)	Regions visible per page in the main menu.

---

gui

Titles

Key	Available placeholders
main-title	{page}, {max_page}
flags-title	{region}

Region items (region-item)

Key	Description
material	Bukkit material name (e.g. WHITE_BANNER, PLAYER_HEAD).
name	Item name. Placeholder: {region}.
lore	List of lines. Placeholders: {world}, {priority}, {active_flags}.

Flag items

Each state has its own section with material and name:

Section	State	Default material
flag-active	ALLOW — enabled	LIME_DYE
flag-deny	DENY — disabled	RED_DYE
flag-inactive	NONE — neutral	GRAY_DYE

The {flag} placeholder in name is replaced with the flag name.

Navigation (navigation)

Key	Description
navigation.previous	Previous page button in the regions menu (slot 45).
navigation.next	Next page button, both in regions (slot 53) and in flags (slot 53).
navigation.back	Back to list button in the flags menu (slot 49).

---

messages

All messages support color codes with &. The prefix is automatically added at the start of every message sent to the player.

Key	Placeholders
no-permission	—
reload-success	—
region-not-found	{region}
info-header	{region}
info-world	{world}
info-priority	{priority}
info-owners	{owners}
info-members	{members}
info-active-flags	{count}
info-edit-engine	{engine}
info-flag-line	{flag}, {value}
flag-updated	{flag}
startup-edit-engine	{engine}

---

Supported color codes

NXGuard uses Bukkit's legacy color system with the & prefix:

Code	Color
&0 - &9	Black to light blue
&a	Light green
&b	Aqua
&c	Light red
&d	Pink
&e	Yellow
&f	White
&l	Bold
&o	Italic
&n	Underline
&m	Strikethrough
&r	Reset