Configuration

The configuration file for Nexal Spawn. Located at plugins/Nexal Spawn/config.yml.

config.yml

# ═══════════════════════════════════════════════════════════
#                   NEXAL SPAWN CONFIGURATION
# ═══════════════════════════════════════════════════════════

# ───────────────────────────────────────────────────────────
#                     SERVER IDENTITY
# ───────────────────────────────────────────────────────────

server:
  # This server's name in the network. Used by the cross-server system.
  # Examples: "hub", "smp1", "smp2", "survival", "creative"
  name: "default"

# ───────────────────────────────────────────────────────────
#                     SPAWN ROUTING
# ───────────────────────────────────────────────────────────

# Where does /spawn send players?
# "this" = use local spawn (same server, same world)
# "hub" = send player to the "hub" server's spawn
# "smp1" = send player to the "smp1" server's spawn
# Any value other than "this" requires cross-server to be enabled.
spawn-server: "this"

# ───────────────────────────────────────────────────────────
#                   CROSS-SERVER SUPPORT
# ───────────────────────────────────────────────────────────

cross-server:
  # Enable cross-server spawn routing (requires BungeeCord or Velocity proxy)
  enabled: false

  # Messaging adapter: "bungee", "redis", or "sql"
  # - bungee: Uses BungeeCord plugin messaging channels (simplest, no extra dependencies)
  # - redis: Uses Redis pub/sub for fast real-time messaging (requires a Redis server)
  # - sql: Uses a shared database table with polling (works with existing SQL setup)
  adapter: bungee

  redis:
    host: localhost
    port: 6379
    password: ""
    channel: nexalspawn
    # Connection timeout in milliseconds
    timeout: 2000

  sql:
    # How often to poll for new messages (in ticks, 20 = 1 second)
    poll-interval: 20
    # Table name for cross-server messages
    table: nexalspawn_messages
    # How long to keep processed messages (in seconds)
    cleanup-age: 60

# ───────────────────────────────────────────────────────────
#                     SPAWN BEHAVIOR
# ───────────────────────────────────────────────────────────

first-join:
  # Teleport new players to the first-join spawn on their first login
  enabled: true
  # The first-join spawn is set via /spawn admin setfirstjoin
  # Falls back to global spawn if not set

# Teleport players to spawn when they respawn after death
respawn-at-spawn: true

# Teleport players to spawn every time they log in
teleport-on-join: false

# Use separate spawn points per world
# When false, only the "global" spawn is used for all worlds
per-world-spawn: true

# ───────────────────────────────────────────────────────────
#                     TELEPORT SETTINGS
# ───────────────────────────────────────────────────────────

warmup:
  # Enable warmup delay before teleporting
  enabled: true
  # Warmup duration in seconds (0 for instant)
  seconds: 3
  # Cancel warmup if player moves
  cancel-on-move: true
  # Show particle effects during warmup
  particles: true
  # Cancel warmup if player takes damage
  cancel-on-damage: true
  # Default warmup effect when no per-spawn effect is set
  # Options: CIRCLE, HELIX, RINGS, FLAME_PILLAR, SPARKLE, PORTAL_SWIRL, ENCHANT, DUST_ORBIT
  default-effect: CIRCLE

# Arrival effect when landing at spawn
arrival:
  enabled: true
  # Default arrival effect for spawns without a per-spawn effect
  # Options: NONE, BURST, FIREWORK, PILLAR, RING_EXPAND, DUST_CLOUD, HELIX_UP, GROUND_RUNES
  default-effect: BURST

cooldown:
  # Enable cooldown between spawn teleports
  enabled: true
  # Cooldown duration in seconds
  seconds: 30

economy:
  # Enable economy cost for spawn teleports (requires Vault)
  enabled: false
  # Cost to teleport to spawn (0 = free)
  cost: 0.0

# ───────────────────────────────────────────────────────────
#                   SPAWN PROTECTION
# ───────────────────────────────────────────────────────────

protection:
  # Enable spawn protection zone
  enabled: false
  # Protection radius around each spawn point (in blocks)
  radius: 10
  # Prevent PvP inside the protection zone
  no-pvp: true
  # Prevent block breaking inside the protection zone
  no-block-break: true
  # Prevent block placing inside the protection zone
  no-block-place: true
  # Whether ops bypass protection
  ops-bypass: true

# ───────────────────────────────────────────────────────────
#                        GUI
# ───────────────────────────────────────────────────────────

gui:
  # Show spawn selection GUI when multiple spawns are available
  enabled: true
  title: "&b&lSpawn Selection"

# ───────────────────────────────────────────────────────────
#                       STORAGE
# ───────────────────────────────────────────────────────────

storage:
  # Storage type: "json" or "sql"
  type: json

  # SQL settings (used when type is "sql")
  # Also used by the SQL cross-server messaging adapter
  sql:
    host: localhost
    port: 3306
    database: minecraft
    username: root
    password: ""

Configuration Options

Below is a reference of the main configuration sections:

server

This server's name in the network. Used by the cross-server system. Examples: "hub", "smp1", "smp2", "survival", "creative"

spawn-server

─────────────────────────────────────────────────────────── SPAWN ROUTING ───────────────────────────────────────────────────────────

Where does /spawn send players? "this" = use local spawn (same server, same world) "hub" = send player to the "hub" server's spawn "smp1" = send player to the "smp1" server's spawn Any value other than "this" requires cross-server to be enabled.

cross-server

─────────────────────────────────────────────────────────── CROSS-SERVER SUPPORT ───────────────────────────────────────────────────────────

first-join

─────────────────────────────────────────────────────────── SPAWN BEHAVIOR ───────────────────────────────────────────────────────────

respawn-at-spawn

teleport-on-join

Teleport players to spawn every time they log in

per-world-spawn

Use separate spawn points per world When false, only the "global" spawn is used for all worlds

warmup

─────────────────────────────────────────────────────────── TELEPORT SETTINGS ───────────────────────────────────────────────────────────

arrival

Arrival effect when landing at spawn

cooldown

Enable cooldown between spawn teleports

economy

Enable economy cost for spawn teleports (requires Vault)

protection

─────────────────────────────────────────────────────────── SPAWN PROTECTION ───────────────────────────────────────────────────────────

gui

─────────────────────────────────────────────────────────── GUI ───────────────────────────────────────────────────────────

storage

─────────────────────────────────────────────────────────── STORAGE ───────────────────────────────────────────────────────────