NexusKOTH splits its settings across several files, all generated automatically on first launch. config.yml holds the general settings, messages.yml holds every chat message, database.yml sets where stats are saved, clans.yml sets clan detection, schedule.yml holds the weekly schedule, holograms.yml styles the arena holograms, effects.yml controls sounds, titles and particles, and the hud/ and menus/ folders style the scoreboard, bossbar and every menu (see the GUI Configuration section). Each arena is saved in its own file under arenas/.
General Settings
| Setting | Default | Description |
|---|
wand-material | BLAZE_ROD | Item used as the zone selection wand |
reset-on-leave | true | Reset capture progress when the capturing player leaves the zone |
contested-pauses | true | Pause capture progress while two sides are in the zone |
ignore-spectators | true | Players in spectator mode are not counted in events |
ignore-vanished | true | Vanished players are not counted in events |
require-free-slot | true | Queue a reward for /koth claim when the inventory is full |
leaderboard-cache-seconds | 60 | How long leaderboards are cached before refreshing |
Destroy the Core and Payload
| Setting | Default | Description |
|---|
dtc-core-material | OBSIDIAN | Block the core is made of |
dtc-regen-material | BEDROCK | Block shown while the core is regenerating |
dtc-hit-damage | 1 | Core health removed per hit |
dtc-hit-cooldown-ms | 150 | Minimum time between hits from one player, in milliseconds |
payload-step | 0.5 | Distance between generated payload path points, in blocks |
payload-ground-search | 4 | How many blocks up and down the path snaps to the ground |
Raise dtc-hit-cooldown-ms if players are breaking cores too fast with autoclickers. Lower payload-step for a smoother cart, at the cost of more path points.
Default Config File
wand-material: BLAZE_ROD
reset-on-leave: true
contested-pauses: true
ignore-spectators: true
ignore-vanished: true
require-free-slot: true
leaderboard-cache-seconds: 60
dtc-core-material: OBSIDIAN
dtc-regen-material: BEDROCK
dtc-hit-damage: 1
dtc-hit-cooldown-ms: 150
payload-step: 0.5
payload-ground-search: 4
Run /koth reload after editing any file. No restart is needed, except when you change the database type.
Database
| Setting | Default | Description |
|---|
type | SQLITE | SQLITE, H2, MYSQL, MARIADB or POSTGRESQL |
file | koth | Database file name for SQLite and H2 |
host | localhost | Database host |
port | 3306 | Database port |
database | koth | Database name |
user | root | Database user |
password | "" | Database password |
pool-size | 6 | Maximum connections in the pool |
table-prefix | koth_ | Prefix for the table names |
jdbc-params | "" | Extra JDBC URL parameters |
Clans
| Setting | Default | Description |
|---|
enabled | true | Turns clan detection on or off |
empty-values | "", none, None, N/A, -, Wilderness | Placeholder results that count as having no clan |
providers | SimpleClans, Factions, Towny, Lands, HuskTowns, BetterTeams, Kingdoms | Plugin and PlaceholderAPI placeholder pairs, the first installed plugin is used |
Clan detection reads a PlaceholderAPI placeholder, so the placeholder in clans.yml has to return the clan name. Check each one in game with /papi parse me <placeholder> and correct it if it comes back empty.
Schedule
| Setting | Default | Description |
|---|
enabled | true | Turns the scheduler on or off |
timezone | America/New_York | Time zone the schedule times are read in |
announce-minutes | 10 | How far ahead a scheduled event shows on holograms and /koth next |
warn-minutes | [10, 5, 1] | Minutes before the start when the warning is broadcast |
entries | {} | Scheduled events, managed by the schedule GUI |
Arena Settings
Each arena is saved in arenas/<name>.yml. Change these in the editor, or with /koth set <arena> <setting> <value>. A setting only applies to the event types in brackets.
| Setting | Default | Description |
|---|
capture-time | 300 | Seconds to hold the zone (KOTH, Capture Points, Conquest) |
points-rate | 1 | Points earned per second (KOTH Points, Conquest) |
points-goal | 100 | Points needed to win |
duration | 1800 | Maximum event length in seconds |
min-players | 1 | Players needed before the event can start |
infinite | false | KOTH keeps running after a capture |
points-mode | EXCLUSIVE | KOTH Points scoring, EXCLUSIVE or MULTI |
release-delay | 5 | Seconds the point stays held after the holder leaves (Capture Points) |
core-health | 25 | Core hits needed to break it (DTC) |
points-per-break | 5 | Points for breaking the core (DTC) |
core-regen | 10 | Seconds before the core regenerates (DTC) |
core-broadcast | 30 | Seconds between core status broadcasts (DTC) |
payload-speed | 10 | Cart speed in tenths of a block per second |
payload-radius | 4 | Radius around the cart that counts, in blocks |
return-delay | 10 | Seconds before an abandoned cart rolls back |
return-speed | 20 | Rollback speed in tenths of a block per second |
bounty-duration | 120 | Seconds each target lasts |
bounty-points | 5 | Points for killing the target |
survive-points | 2 | Points for the target surviving |
reveal-interval | 30 | Seconds between location reveals of the target |
GUI Configuration
Every menu is built from its own file in the menus/ folder. Titles, rows, slots, materials, names and lore can all be changed. Text uses & colour codes and hex colours written as &#RRGGBB, for example &#FFAA00.
| File | Controls |
|---|
menus/arenas.yml | The arena list opened by /koth editor |
menus/editor.yml | The editor for a single arena |
menus/settings.yml | The arena settings page and which settings it shows |
menus/zones.yml | The zone list and zone tools |
menus/rewards.yml | The reward editor with its rank tabs |
menus/schedule.yml | The weekly schedule |
menus/schedule-entry.yml | A single schedule entry |
menus/stats.yml | Player and clan stats |
menus/top.yml | The player and clan leaderboards |
menus/confirm.yml | The confirmation shown before deleting |
| Key | Description |
|---|
title | Inventory title. Supports the placeholders listed at the top of each file |
rows | Number of rows, 1 to 6 |
filler.material | Item used to fill empty slots |
filler.name | Name of the filler item |
items.<name>.slot | Slot the button sits in |
items.<name>.material | Any Minecraft material |
items.<name>.name | Display name |
items.<name>.lore | Lore lines |
arena-slots | Slots the arenas are placed in (arenas.yml) |
type-materials.<TYPE> | Icon used for each event type (arenas.yml) |
setting-slots | Slots the settings are placed in (settings.yml) |
entry-slots | Slots the leaderboard entries use (top.yml) |
Each menu lists its own placeholders in a comment at the top of the file. Only the keys you want to change need to stay in the file if you prefer a short config.
Scoreboard and Bossbar
| Setting | Default | Description |
|---|
enabled | true | Turns the scoreboard on or off (hud/scoreboard.yml) |
title | &#FFAA00&lKOTH | Scoreboard title |
max-events | 4 | How many events show at once before the scoreboard switches to the compact layout |
lines.<type> | per type | Scoreboard lines for each event type, default is the fallback |
enabled | true | Turns the bossbar on or off (hud/bossbar.yml) |
style | PROGRESS | Bossbar style |
color.<state> | WHITE, GREEN, RED, YELLOW | Bossbar color for neutral, capturing, contested and returning. color.<type>.<state> overrides it |
text.<type> | per type | Bossbar text for each event type, default is the fallback |
Progress Bar and Status Text
| Setting | Default | Description |
|---|
bar-length | 10 | Number of characters in the bar |
bar-char | █ | Character the bar is drawn with |
bar-filled | &#FFAA00 | Colour of the filled part |
bar-empty | &8 | Colour of the empty part |
none | None | Text shown when a placeholder has no value |
status.neutral | &7Neutral | Text for the neutral state |
status.capturing | &aCapturing | Text for the capturing state |
status.contested | &cContested | Text for the contested state |
status.returning | &eReturning | Text for the returning state |
status.idle | &8Idle | Text for the idle state |
Holograms
| Setting | Default | Description |
|---|
enabled | true | Turns holograms on or off |
auto-anchor | true | Places the hologram above the arena automatically |
height | 2.5 | Height above the anchor, in blocks |
see-through | false | Whether the text can be seen through blocks |
shadow | true | Text shadow |
background | #66000000 | Background color of the text, with alpha |
view-range | 48 | Distance it is visible from, in blocks |
lines.inactive | {name}, {type}, Inactive | Lines shown when the arena is idle |
lines.scheduled | {name}, {type}, Starts in {next-in} | Lines shown when an event is scheduled |
lines.running.<type> | per type | Lines shown while an event of that type runs |
Effects
Each sound is written as a vanilla sound id, a volume and a pitch. Set enabled: false on a sound, title or action bar to turn it off.
| Setting | Default | Description |
|---|
<effect>.sound.enabled | true | Plays the sound for that effect |
<effect>.sound.name | per effect | Vanilla sound id |
<effect>.sound.volume | per effect | Sound volume |
<effect>.sound.pitch | per effect | Sound pitch |
<effect>.title.enabled | true | Shows the title for start, win and bounty-target |
<effect>.actionbar.text | per effect | Action bar text for capture, contested, dtc-hit and others |
win.firework.enabled | true | Launches a firework when an event is won |
win.firework.colors | #FFAA00, #FFFFFF | Firework colors |
zone-particles.enabled | true | Draws the zone border with particles |
zone-particles.interval | 10 | Ticks between particle updates |
zone-particles.view-distance | 64 | Distance particles are shown from, in blocks |
zone-particles.spacing | 1.0 | Distance between particles along the border |
zone-particles.max-points | 300 | Maximum particles drawn per zone |
zone-particles.show-idle | false | Draws the border when the event is not running |
zone-particles.<state>.color | #888888, #FFAA00, #55FF55, #FF5555 | Border color for idle, neutral, capturing and contested |
Effect names
| Effect | Plays when |
|---|
start | An event starts |
win | An event is won |
capture-start | A player starts capturing |
contested | A zone becomes contested |
capture | A side scores a capture point |
dtc-hit | A player hits the core |
dtc-immune | A player hits the core while it is regenerating |
dtc-break | The core is broken |
payload-checkpoint | The cart reaches a checkpoint |
bounty-target | A player becomes the target |
bounty-kill | The target is killed |
Messages
| Key | Default |
|---|
prefix | &#FFAA00&lKOTH &8» &7 |
no-permission | &cYou do not have permission. |
started | Started &f{arena}&7. |
stopped | Stopped &f{arena}&7. |
winner | &#FFAA00{winner} &7won &#FFAA00{name}&7. |
timeout | &#FFAA00{name} &7ended with no winner. |
capture-point | &#FFAA00{winner} &7captured &#FFAA00{name} &8(&f{points}&7/&f{goal}&8) |
conquest-captured | &#FFAA00{winner} &7captured zone &f{zone} &7in &#FFAA00{name}&7. |
dtc-broken | &#FFAA00{player} &7broke the core of &#FFAA00{name} &8(&f{winner} {points}&7/&f{goal}&8) |
payload-checkpoint | &#FFAA00{name} &7cart reached checkpoint &f{number}&7/&f{total} |
bounty-target | &#FFAA00{name} &7New target: &c{player}&7. Kill them to score. |
schedule-warning | &#FFAA00{name} &7starts in &f{minutes} &7minutes. |
next-event | Next event: &#FFAA00{name} &7on &f{time} &7(in &f{in}&7) |
reward-queued | Your reward was queued. Use &f/koth claim &7when you have inventory space. |
The Messages table shows the main ones. messages.yml has every message, including one start announcement per event type (event-start-koth, event-start-dtc and so on) and one wizard hint per event type (wizard-koth, wizard-payload and so on).
Message placeholders
| Placeholder | Replaced With |
|---|
{arena} | Arena name |
{name} | Arena display name |
{type} | Event type |
{winner} | Winning player or clan |
{player} | Player the message is about |
{target} | Bounty target |
{zone} | Zone name in Conquest |
{points} and {goal} | Current points and the points needed to win |
{number} and {total} | Checkpoint number and total checkpoints |
{minutes} | Minutes until a scheduled event |
{time} and {in} | Day and time of the next event, and how long until it |
{amount} | Number of rewards claimed |
{rank} | Leaderboard or result rank |
{side} | Player or clan name in a result line |
{score} | Score in a result line |