settings.yml

settings.yml is the core configuration file for Zentrix Battle Royale. You’ll find it in /plugins/Zentrix/settings.yml.

It controls system behavior, storage backend, a few global gameplay defaults, and some “managed-by-commands” sections like locations.

Where to find it

Generated after the first server start:

• plugins/Zentrix/settings.yml

You can use /zx reload command to make your changes live.

System & License

These are “plugin boots or not” settings.

debug

debug: false

Enables verbose console logs. Use this when troubleshooting.

• false: normal logs (recommended for production).

• true: extra logs (Info/Warning/Debug).

Errors always log, even when debug: false.

license.key (critical)

license:
  key: "YOUR-LICENSE-KEY-HERE"

Zentrix requires a valid license key. Without it, the plugin won’t run correctly.

locale

locale:
  file: en.yml
  small-caps: false

• locale.file: picks a language file from /plugins/Zentrix/locales/.

• locale.small-caps: converts player-facing text to small caps.

Data Storage

Zentrix stores player data (stats, currency, progression) using one backend.

storage.type

storage:
  type: LOCAL

Supported values:

• LOCAL: flatfile/YAML storage on disk. Good for small servers and testing.

• MYSQL: shared database storage. Use this for networks and multiple servers.

• MONGODB: MongoDB storage. Use this if you already run Mongo for your stack.

storage.mysql (required when type: MYSQL)

storage:
  mysql:
    host: "localhost"
    port: 3306
    database: "zentrix"
    username: "root"
    password: ""
    table-prefix: "zentrix_"
    pool-size: 10
    connection-timeout: 5000

Key fields:

• table-prefix: lets you share one database with other plugins.

• pool-size: max open connections. Raise this on busy servers.

• connection-timeout: time in ms before connection fails.

storage.mongodb (required when type: MONGODB)

storage:
  mongodb:
    connection-string: "mongodb://localhost:27017"
    database: "zentrix"

Gameplay Settings

These affect defaults that apply across arenas.

Default Glider

default-glider: common-glider

This is the glider ID assigned to new players. Zentrix expects MatrixGliders to be installed. See: Supported Plugins.

Arena Management

arena-management:
  send-lobby-after-match: 5
  spectator-prefix: "&7[Spectator]"

• send-lobby-after-match: delay before moving players back to lobby. This gives time for end screens and cleanup.

• spectator-prefix: prefix used in spectator chat formatting.

World Time

arena-management:
  world-time:
    game: 6000
    deathmatch: 6000
    waiting-lobby: 6000

Time is in Minecraft ticks:

• 0: sunrise

• 6000: noon

• 13000: sunset

• 18000: midnight

Game Rules

arena-management:
  game-rules:
    game:
      do-weather-cycle: false
      do-daylight-cycle: false
      do-insomnia: false
      announce-advancements: false

These gamerules are applied during world creation and match setup. They help keep matches consistent.

• do-weather-cycle: false: prevents rain/storms.

• do-daylight-cycle: false: keeps time fixed.

• do-insomnia: false: disables phantom spawning.

• announce-advancements: disabled announcement announcements.

Locations

Zentrix stores lobby spawns as Bukkit Location objects. These blocks are mainly here for persistence.

Do not edit locations.* manually. Use in-game commands instead.

Manual edits can break Bukkit’s serialized Location format. That can cause load errors or broken teleports.

Main Lobby (locations.lobby)

• Purpose: where players spawn on join and on elimination.

• Command: /zx setlobby

Waiting Lobby (locations.waiting-lobby)

• Purpose: spawn point for the pre-game waiting area.

• Command: /zx setwaitinglobby

• world: the template folder name.

Lobby Scoreboard

Shown only in the main lobby. Supports PlaceholderAPI.

Title and lines

lobby-scoreboard:
  title: "&#FFD700&lZENTRIX"
  lines:
    - "&7%zentrix_date% &8%zentrix_clock%"

Placeholders

For the full placeholder list, use: Placeholders.

Deathmatch & Corpse

These settings control the end-game deathmatch phase and disconnect corpses.

Deathmatch (deathmatch-settings)

Deathmatch is the late-game “forced fight” phase. It typically uses a copied template world plus a shrinking border. See: Deathmatch.

Key options:

• template-world: folder name of the template to copy.

• spawn-type:

  • RANDOM: Zentrix picks spawns for players.

  • CUSTOM: uses custom-spawns (managed via commands).

• freeze-duration: seconds players are frozen after teleport.

• title / subtitle: displayed when freeze ends.

Managed via commands:

• custom-spawns: edited through admin commands.

• border.pos1 and border.pos2: set via /zx deathmatch setbounds.

Corpse system (corpse-settings)

Spawns a lootable zombie when a player disconnects mid-game. This helps prevent “combat logging” abuse.

Main toggles:

• enabled: master switch for the feature.

• display-name-format: corpse name template. Uses {player} as the player name token.

Despawn behavior:

• despawn-time: seconds before the corpse is removed.

• warning.enabled: enables a near-despawn warning.

• warning.threshold: seconds remaining when warnings start.

Loot mode (corpse-settings.loot-drop.mode):

• KILL_ONLY: drops loot only if the corpse is killed.

• DESPAWN_ONLY: drops loot only when the timer ends.

• BOTH: drops loot in both cases.

Spawn triggers (corpse-settings.spawn-on):

• quit: player disconnects or crashes.

• kick: player is kicked.

• command: player leaves using /leave.

• License key

• Global plugin toggles and defaults

If a setting doesn’t seem to apply, restart the server.

Default Configuration

Expand: default settings.yml

# -----------------------------------------------------------------------------
# Zentrix Battle Royale - Main Configuration
# Developed by Harsh
# -----------------------------------------------------------------------------

# =============================================================================
# SYSTEM SETTINGS
# =============================================================================

# Debug Mode
# Enables verbose logging for troubleshooting (Info, Warning, Debug).
# Error messages are always logged regardless of this setting.
debug: false

# License Configuration
# A valid license is required to use the plugin.
license:
  key: "YOUR-LICENSE-KEY-HERE"

# Locale & Language
locale:
  # The language file to use from the /locales/ folder.
  file: en.yml
  # If enabled, converts all player-facing messages to small caps (e.g., "ᴍᴇssᴀɢᴇ").
  small-caps: false

# =============================================================================
# DATA STORAGE
# =============================================================================
# Configure where player data (stats, currency, etc.) is stored.
# Available Types: LOCAL (Flatfile/YAML), MYSQL, MONGODB
storage:
  type: LOCAL

  # MySQL Connection Settings (Required if type is MYSQL)
  mysql:
    host: "localhost"
    port: 3306
    database: "zentrix"
    username: "root"
    password: ""
    table-prefix: "zentrix_"
    pool-size: 10
    connection-timeout: 5000

  # MongoDB Connection Settings (Required if type is MONGODB)
  mongodb:
    connection-string: "mongodb://localhost:27017"
    database: "zentrix"

# =============================================================================
# GAMEPLAY CONFIGURATION
# =============================================================================

# Default Glider
# The glider identifier assigned to new players.
# Requires Matrix Gliders plugin.
default-glider: common-glider

# Arena Management
arena-management:
  # Delay (in seconds) before sending players to lobby after a match ends.
  send-lobby-after-match: 5

  # Chat prefix for spectators.
  spectator-prefix: "&7[Spectator]"

  # World Time Settings (in ticks)
  # 0 = Sunrise, 6000 = Noon, 13000 = Sunset, 18000 = Midnight
  world-time:
    game: 6000
    deathmatch: 6000
    waiting-lobby: 6000

  # Game Rules (Gamerules applied to world creation)
  game-rules:
    game:
      do-weather-cycle: false
      do-daylight-cycle: false
      do-insomnia: false
      announce-advancements: false
    deathmatch:
      do-weather-cycle: false
      do-daylight-cycle: false
      do-insomnia: false
      announce-advancements: false
    waiting-lobby:
      do-weather-cycle: false
      do-daylight-cycle: false
      do-insomnia: false
      announce-advancements: false

# =============================================================================
# LOCATIONS
# =============================================================================
# NOTE: It is recommended to set these using in-game commands rather than
# editing this file manually to prevent serialization errors.

locations:
  # Main Lobby: Where players spawn on join/elimination.
  # Set via: /zx setlobby
  lobby:
    ==: org.bukkit.Location
    x: 0
    y: 70
    z: 0
    yaw: -100
    pitch: 100
    world: world

  # Waiting Lobby: Template spawn point for pre-game waiting.
  # 'world' refers to the template folder name.
  # Set via: /zx setwaitinglobby
  waiting-lobby:
    ==: org.bukkit.Location
    x: 0
    y: 100
    z: 0
    yaw: 0
    pitch: 0
    world: waiting_lobby

# =============================================================================
# LOBBY SCOREBOARD
# =============================================================================
# Displayed to players in the main lobby (not in-game).
# Supports PlaceholderAPI.
#
# Zentrix Placeholders:
# %zentrix_player%          | %zentrix_displayname%
# %zentrix_online%          | %zentrix_max_players%
# %zentrix_date%            | %zentrix_clock%
# %zentrix_currency%        | %zentrix_currency_raw%
# %zentrix_wins%            | %zentrix_total_kills%

lobby-scoreboard:
  title: "&#FFD700&lZENTRIX"
  lines:
    - "&7%zentrix_date% &8%zentrix_clock%"
    - ""
    - "&fCoins: &a%zentrix_currency%"
    - ""
    - "&fTotal Wins: &a%zentrix_wins%"
    - "&fTotal Kills: &a%zentrix_total_kills%"
    - ""
    - "&fPlayers: &a%zentrix_online%&7/&a%zentrix_max_players%"
    - ""
    - "&#FFD700play.example.net"

# =============================================================================
# DEATHMATCH SYSTEM
# =============================================================================
# Configuration for the end-game shrinking border phase.

deathmatch-settings:
  template-world: "deathmatch_template" # Folder name of the world to copy.
  spawn-type: RANDOM # Options: RANDOM, CUSTOM
  freeze-duration: 5 # Seconds to freeze players on teleport.
  title: "&#FFD700FIGHT" # Title displayed after freeze.
  subtitle: "&7You can move now!"

  # Custom Spawn Points (Managed via commands)
  custom-spawns: []

  # Border Bounds (Managed via /zx deathmatch setbounds)
  border:
    pos1: null
    pos2: null

# =============================================================================
# CORPSE SYSTEM
# =============================================================================
# Spawns a lootable zombie when a player disconnects mid-game.

corpse-settings:
  enabled: true

  # Visuals
  display-name-format: "&c{player}'s Corpse"

  # Despawn Logic
  despawn-time: 120 # Seconds before the corpse is removed.
  warning:
    enabled: true
    threshold: 10 # Seconds remaining to warn nearby players.

  # Loot Distribution Mode
  # KILL_ONLY:    Loot drops only if the corpse is killed.
  # DESPAWN_ONLY: Loot drops only if the timer expires.
  # BOTH:         Loot drops in both scenarios.
  loot-drop:
    mode: BOTH

  # Trigger Conditions
  spawn-on:
    quit: true # Disconnect/Crash
    kick: true # Server Kick
    command: true # /leave command