Configuration

# ============================================================
#  SnVanishRegion - configuration
#  Managed by SnLib: new keys are auto-merged on boot; your values and
#  comments are preserved. Do NOT add a config-version key (retired).
#  Set update-configs: false to freeze this file (SnLib only warns about
#  missing keys instead of inserting them).
#  Sections marked "# sn:extensible" are yours: entries you delete there
#  stay deleted.
# ============================================================

# Active language code; loads lang/messages_<code>.yml (falls back to en).
lang: en

# Master switch of the SnLib auto-updater for this plugin's managed files.
update-configs: true

# Runtime debug output.
debug:
  # Master toggle of the debug output.
  enabled: false
  # Verbosity threshold: OFF, INFO, DEBUG or TRACE.
  level: DEBUG
  # Category filter; an empty list lets every category through.
  categories: []

# ------------------------------------------------------------
#  Main command.
# ------------------------------------------------------------
command:
  # Aliases of /vanishregion. Re-read on /vanishregion reload.
  aliases: [vr, svr]

# ------------------------------------------------------------
#  Update checker.
# ------------------------------------------------------------
update-check:
  # Read-only GitHub token for the releases feed; empty uses anonymous access.
  token: ""

# ------------------------------------------------------------
#  Public developer API.
# ------------------------------------------------------------
api-events:
  # Dispatches the events other plugins can listen to (region create and delete, bypass toggle,
  # visibility refresh). When false, no API event is dispatched (zero cost) and cancellable hooks
  # report "not cancelled" so gameplay proceeds; the query facade stays available either way.
  # Re-read on /vanishregion reload.
  enabled: true

# ------------------------------------------------------------
#  Vanish.
# ------------------------------------------------------------
vanish:
  # false: two players inside vanish regions hide from each other only when they share a region
  # (an internal region, or a WorldGuard region whose own flag is allow).
  # true: any two players who each stand in any vanish region hide from each other, even in
  # different regions. Applied to everyone online on /vanishregion reload.
  cross-region: false

# ------------------------------------------------------------
#  Selection wand.
# ------------------------------------------------------------
wand:
  # Item material of the wand that /vanishregion wand hands out; an invalid or non-item
  # material uses GOLDEN_AXE and logs one warning. Re-read on /vanishregion reload.
  material: GOLDEN_AXE

# ------------------------------------------------------------
#  Limits.
# ------------------------------------------------------------
cooldowns:
  # Seconds a player waits between two /vanishregion toggle uses; 0 disables the limit.
  # Re-read on /vanishregion reload.
  toggle: 3

# ------------------------------------------------------------
#  Integrations.
# ------------------------------------------------------------
# WorldGuard. The flag is registered while the server loads plugins, so
# changing enabled or flag-name needs a server restart (/vanishregion reload does not apply it).
worldguard:
  # Registers the WorldGuard flag that turns a region into a vanish region; false runs with internal regions only. Needs a server restart.
  enabled: true
  # Name of that WorldGuard flag; set a region to allow with /rg flag <region> <flag-name> allow. Needs a server restart.
  flag-name: vanish-region
  # Ticks between two re-reads of the WorldGuard vanish state of every online player where they
  # stand (20 ticks = 1 second), so a region or flag edited around players who do not move applies
  # without waiting for them to walk. Each re-read is one WorldGuard query per online player.
  # 0 turns the re-read off. The same timer turns off the /vanishregion toggle bypass of a player
  # who lost vanishregion.toggle; that check keeps running (every 20 ticks when this is 0, and also
  # without WorldGuard). Re-read on /vanishregion reload.
  recheck-ticks: 20

# ============================================================
#  SnVanishRegion - language file (English)
#  Managed by SnLib: new keys merge in on boot, your values are kept.
#  Restyle any line freely; your edits survive updates.
# ============================================================

# Prefix prepended to every single-line message sent via sn.lang().send(...)
prefix: "&#8354f2&lSnVanishRegion &8| &7"

# snlib.* is SnLib's shared command contract (14 keys; the two help.group-*
# keys exist since SnLib 1.36.0). Every Sn plugin ships
# this block UNCHANGED: SnLib bundles NEUTRAL defaults for any key you omit and
# merges them in on boot, so an incomplete block leaks unbranded lines. Shipping
# the FULL block is what keeps the whole fleet visually identical. Placeholders
# {plugin} {usage} {description} {page} {total} {min} {max} {value} {command}
# {group} {path} are filled by SnLib. NEVER put {prefix} here (it is auto-prepended).
snlib:
  no-permission: "&cYou do not have permission to use this command."
  usage: "&cUsage: &e{usage}"
  invalid-number: "&cInvalid number: &e{value}"
  invalid-value: "&cInvalid value: &e{value}"
  out-of-range: "&cValue must be between &e{min} &cand &e{max}&c: &e{value}"
  number-too-small: "&cValue must be at least &e{min}&c: &e{value}"
  player-not-found: "&cPlayer not found: &e{value}"
  unknown-subcommand: "&cUnknown subcommand: &e{value}"
  reload-done: "&aConfiguration reloaded."
  help:
    header: "&8&m----------&r &#8354f2&l{plugin} &8&m----------"
    # Branded no-separator form. SnLib's neutral default is "&e{usage} &7{description}".
    entry: "&#8354f2{usage} &7{description}"
    footer: "&7Page &f{page}&7/&f{total} &8- &#8354f2/{command} help <page>"
    # Own help of a groupHelp() command group (/<cmd> admin <module> help).
    group-header: "&8&m----------&r &#8354f2&l{group} &8&m----------"
    group-footer: "&7Page &f{page}&7/&f{total} &8- &#8354f2{path} help <page>"
  # Messages of the selection wand (SnLib's cuboid selection module).
  selection:
    pos1-set: "&aPos1 set: &#8354f2{x}, {y}, {z} &7({world})"
    pos2-set: "&aPos2 set: &#8354f2{x}, {y}, {z} &7({world})"
    different-worlds: "&cBoth positions must be in the same world."
    too-big: "&cSelection too big: &#8354f2{volume} &7(max {max})"
    no-permission: "&cYou cannot use this wand."
    timeout: "&7Selection expired."

# Errors of the region commands.
errors:
  # A non-player sender ran create, wand or toggle.
  players-only: "&cThis command can only be used by players."
  # {name} is the region name as typed.
  region-not-found: "&cRegion &f{name} &cnot found."
  region-exists: "&cRegion &f{name} &calready exists."
  # A name carried a character used for tags, placeholders or color codes. The characters are
  # spelled out in words on purpose: a literal angle or square bracket here would render as a tag.
  region-name-invalid: "&cA region name cannot contain angle brackets, square brackets, percent signs, braces, ampersands or section signs."
  # {seconds} is the time left on the /vanishregion toggle cooldown.
  toggle-cooldown: "&cWait &f{seconds}s &cbefore toggling again."
  # Sent when a player's bypass is turned off because they no longer have vanishregion.toggle.
  toggle-revoked: "&cYour vanish bypass was turned off: you no longer have permission to use it."
  # create or delete refused: regions.yml holds content the plugin could not read and could not
  # copy aside, so nothing changed. {label} is the command label the sender typed.
  region-not-saved: "&cNothing changed: regions.yml could not be saved safely (see the console). Fix or move the file, then run &f/{label} reload&c."
  # {label} is the command label the sender typed.
  no-selection: "&cMake a selection first (WorldEdit) or use &f/{label} wand&c."
  selection-incomplete: "&cIncomplete selection. Select pos1 and pos2 first."
  selection-cross-world: "&cBoth selection points must be in the same world."

# Confirmations of the region commands. {name} is the region name.
success:
  region-created: "&aRegion &f{name} &acreated."
  region-deleted: "&aRegion &f{name} &adeleted."
  wand-given: "&aSelection wand given. Left-click pos1, right-click pos2."
  # /vanishregion toggle: personal bypass turned on or off.
  toggle-on: "&aBypass enabled. You see everyone and everyone sees you."
  toggle-off: "&7Bypass disabled."

# /vanishregion list. Header and entries carry no prefix. Entry placeholders:
# {name}, {world}, {min} and {max} (corners as x,y,z).
list:
  header: "[noprefix]&8&m----------&r &#8354f2&lVanish Regions &8&m----------"
  empty: "&7No regions defined."
  entry: "[noprefix]&8- &#8354f2{name} &8(&7{world}&8) &7{min} &8-> &7{max}"

# Name and lore of the selection wand item. Write each as ONE line; a \n in the lore starts a new
# lore line, and a YAML list keeps only its first line.
wand:
  name: "&#8354f2&lVanishRegion Selector"
  lore: "&7Left-click: pos1 &8| &7Right-click: pos2"