# GuestMode configuration
# If you remove any section, the plugin may not work as intended.
# Use https://yamlvalidator.com/ to check for syntax errors after editing.
# For editing messages, use https://webui.advntr.dev/

# MAIN CONFIG SECTIONS
# ==================

#EXPERIMENTAL FIXES: -> Enable this to fix players being able to accidentally trigger pressureplates on logout/login
AlwaysReturnGuestToFallback: true
ForceSafeLogin: true

# Effects and visuals applied to guests
guest-effects:
  night-vision: true
  speed: true
  glow: true

# Quick-Nav settings (guest-only short teleport via compass)
quick-nav:
  enabled: true
  item-name: "Quick-Nav Item"
  max-distance: 100
  cooldown-seconds: 4
  # Lore lines support {distance} and {cooldown}, with '&' color codes
  lore:
    - "&7Sneak + Right-Click to short-teleport."
    - "&7Aim at a solid block within range."
    - "&8Range: &f{distance}  &8Cooldown: &f{cooldown}s"

# WORLD AND REGION RESTRICTIONS
# Movement restrictions for guests
restrict:
  # Block changing worlds entirely while guest
  world-change: true

  # Optional WorldGuard region restriction; leave blank to disable
  region:
    world: "world"
    id: "spawn"

  # Fallback teleport location if a guest repeatedly hits a region boundary
  fallback:
    world: "world"        # leave empty to use player's current world
    x: -421.5
    y: -22.0
    z: -237.5
    yaw: -180.0
    pitch: 1.0

# NEW-PLAYER ITEMS (Given upon acceptance, like starter items/starter kit)
# Give default items when a player is accepted (no longer a guest)
default-items:
  enabled: true
  clear-inventory: true

  # HOW TO CREATE ITEMS (PLEASE READ CAREFULLY):
  # Each entry in the list can either be a simple format or a custom Item format.
  # SIMPLE format: "material[:amount][@slot]"
  # CUSTOM format: material, amount, slot, name, lore(list), enchants(map)
  #
  # Default values:
  items:
    # Examples (remove, edit or add your own, but follow the format!)
    - "stone:16@0"         # 16 stone in slot 0
    - "bread:8"            # 8 bread in next free slot
    - "iron_pickaxe@1"     # iron pickaxe in slot 1
    - material: "compass"  # Starter compass in slot 8 with custom name, lore and enchant
      amount: 1
      slot: 8
      name: "&bStarter Compass"
      lore:
        - "&7A handy tool to get started."
        - "&8Given upon acceptance."
      enchants:
        unbreaking: 3

# MESSAGE SECTION
messages:
  players-only: "<red>Players only.</red>"
  no-permission: "<red>No permission.</red>"

  guestmode:
    usage: "<yellow>Usage:</yellow> <white>/guestmode editor [page]</white> | <white>/guestmode review</white> | <white>/guestmode request</white>"
    info: "<yellow>You are currently in guestmode.</yellow>"

  guest-actionbar: "<green>Guest Mode</green>"

  guest-join-info:
    - "<b><red>INFORMATION</red></b> | <i>You are in GuestMode</i>\n\n<gray>Until you are accepted as a regular player, you cannot:\n</gray>\n<red>◆</red> Break, place or alter any block\n<red>◆</red> Interact with any item/entity\n<red>◆</red> Take damage, deal damage or get targeted\n<red>◆</red> Leave the defined spawn region/world\n\n<gray>Request normal access with</gray> <b><i><yellow>/guestmode request</yellow></i></b>"

  pending-requests-join: "<red><b>ADMIN ALERT</b></red> | <yellow>There are new pending whitelist requests for your server.</yellow>\n\n<gray>Open review GUI with</gray> <b><aqua>/guestmode review</aqua></b>"

  region-exit-denied: "<red>You cannot exit the defined spawn-region as a guest.</red>"

  quicknav:
    cooldown: "<red>Please wait <white><seconds></white> seconds before using Quick-Nav again.</red>"
    blocked-region: "<red>You cannot teleport outside the allowed region.</red>"
    invalid-target: "<red>Look at a valid solid block within range.</red>"

  request:
    not-guest: "<red>You are not in guestmode.</red>"
    already: "<yellow>You already have a pending request.</yellow>"
    submitted: "<green>Your whitelist request has been submitted. Please wait for a staff member.</green>"
    notify-editor: "<red><b>ADMIN ALERT</b></red> | <yellow>There are new pending whitelist requests for your server.</yellow>\n\n<gray>Open review GUI with</gray> <b><aqua>/guestmode review</aqua></b>"
    accept:
      notfound: "<red>Player not found. Please try again once they are online.</red>"
      already: "<yellow><player></yellow> is already whitelisted."
      success-admin: "<green>Accepted whitelist request for</green> <white><player></white><green>.</green>"
      success-player: "<green>Your whitelist request has been accepted. Enjoy!</green>"

  stuck:
    teleported: "<green>Teleported to a safe location.</green>"
    failed: "<red>Teleport failed. Try again.</red>"

# Players that should never be put into guestmode.
# Add player names or UUIDs. Names are case-insensitive.
ignoreByDefault:
  - "Notch"
  - "examplePlayerName"
  # - "f84c6a79-2a5f-4d2a-a1a4-000000000000"