Configuration
The configuration file for Nexal KOTL. Located at plugins/Nexal KOTL/config.yml.
# Configuration for Nexal KOTL Plugin (King of the Ladder)
# Most settings can also be changed in game: /kotl admin > Configuration.
# Changes apply without a restart and do not stop running matches;
# a storage change needs a restart.
# ============================================
# Storage Settings
# ============================================
storage:
# Storage type: "json" or "sql"
type: json
# SQL settings (only used when type is "sql")
sql:
host: localhost
port: 3306
database: minecraft
username: root
password: ""
# ============================================
# History Settings
# ============================================
# Every match is kept with each player's zone entries and exits. To keep data.json or the
# database from growing forever, old matches can be removed with their zone entries and exits.
# Player stats and leaderboards (wins, matches played, time in the zone) are kept either way.
# Matches are removed on startup and after each match ends. Running matches are never removed,
# and deleting an arena does not remove its history.
history:
# Remove matches that ended more than this many days ago. 0 keeps them forever.
max-age-days: 0
# Keep at most this many matches, across all arenas; the oldest go first. 0 for no limit.
max-entries: 0
# Default match duration in seconds
# Each arena can override it in /kotl admin > Arenas > (arena) > Duration
default-duration: 300
# allow-multiple-winners: Determines behavior when multiple players tie for first place.
# If true, all tied players are declared winners and win commands run for each.
# If false, a random winner is selected from the tied players.
allow-multiple-winners: false
# ============================================
# Boss Bar Settings
# ============================================
bossbar:
# Enable boss bar display during matches
enabled: true
# Color: RED, BLUE, GREEN, YELLOW, PURPLE, PINK, WHITE
color: YELLOW
# Style: SOLID, SEGMENTED_6, SEGMENTED_10, SEGMENTED_12, SEGMENTED_20
style: SOLID
# Title template (MiniMessage or & colour codes)
# Placeholders: %arena%, %players% (names, see display-mode), %count% (players in the zone), %time% (seconds left)
title: "<gradient:#FF6B00:#FF8C00><bold>KOTL</bold></gradient> <gray>|</gray> <white>%players%</white> <gray>|</gray> <white>%count% in zone</white> <gray>|</gray> <white>%time%s</white>"
# Display mode for %players% placeholder:
# - "leader": Shows player(s) with most cumulative zone time
# - "current": Shows player(s) currently in the zone
display-mode: leader
# Text shown when no players qualify
no-one-text: "No one"
# ============================================
# Countdown Settings
# ============================================
countdown:
# Enable countdown warnings and final countdown
enabled: true
# Warning intervals (seconds) - uses message key "countdown-{X}s"
# Add or remove as you like - just add matching message keys
warnings:
- 60
- 30
- 10
# Final countdown (seconds) - uses message key "countdown-final-{X}"
# Add or remove as you like - just add matching message keys
final:
- 5
- 4
- 3
- 2
- 1
Configuration Options
Below is a reference of the main configuration sections:
storage
Configuration for Nexal KOTL Plugin (King of the Ladder) Most settings can also be changed in game: /kotl admin > Configuration. Changes apply without a restart and do not stop running matches; a storage change needs a restart.
============================================ Storage Settings
history
============================================ History Settings
Every match is kept with each player's zone entries and exits. To keep data.json or the database from growing forever, old matches can be removed with their zone entries and exits. Player stats and leaderboards (wins, matches played, time in the zone) are kept either way. Matches are removed on startup and after each match ends. Running matches are never removed, and deleting an arena does not remove its history.
default-duration
Default match duration in seconds Each arena can override it in /kotl admin > Arenas > (arena) > Duration
allow-multiple-winners
allow-multiple-winners: Determines behavior when multiple players tie for first place. If true, all tied players are declared winners and win commands run for each. If false, a random winner is selected from the tied players.