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

SettingDefaultDescription
wand-materialBLAZE_RODItem used as the zone selection wand
reset-on-leavetrueReset capture progress when the capturing player leaves the zone
contested-pausestruePause capture progress while two sides are in the zone
ignore-spectatorstruePlayers in spectator mode are not counted in events
ignore-vanishedtrueVanished players are not counted in events
require-free-slottrueQueue a reward for /koth claim when the inventory is full
leaderboard-cache-seconds60How long leaderboards are cached before refreshing

Destroy the Core and Payload

SettingDefaultDescription
dtc-core-materialOBSIDIANBlock the core is made of
dtc-regen-materialBEDROCKBlock shown while the core is regenerating
dtc-hit-damage1Core health removed per hit
dtc-hit-cooldown-ms150Minimum time between hits from one player, in milliseconds
payload-step0.5Distance between generated payload path points, in blocks
payload-ground-search4How 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

SettingDefaultDescription
typeSQLITESQLITE, H2, MYSQL, MARIADB or POSTGRESQL
filekothDatabase file name for SQLite and H2
hostlocalhostDatabase host
port3306Database port
databasekothDatabase name
userrootDatabase user
password""Database password
pool-size6Maximum connections in the pool
table-prefixkoth_Prefix for the table names
jdbc-params""Extra JDBC URL parameters

Clans

SettingDefaultDescription
enabledtrueTurns clan detection on or off
empty-values"", none, None, N/A, -, WildernessPlaceholder results that count as having no clan
providersSimpleClans, Factions, Towny, Lands, HuskTowns, BetterTeams, KingdomsPlugin 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

SettingDefaultDescription
enabledtrueTurns the scheduler on or off
timezoneAmerica/New_YorkTime zone the schedule times are read in
announce-minutes10How 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.

SettingDefaultDescription
capture-time300Seconds to hold the zone (KOTH, Capture Points, Conquest)
points-rate1Points earned per second (KOTH Points, Conquest)
points-goal100Points needed to win
duration1800Maximum event length in seconds
min-players1Players needed before the event can start
infinitefalseKOTH keeps running after a capture
points-modeEXCLUSIVEKOTH Points scoring, EXCLUSIVE or MULTI
release-delay5Seconds the point stays held after the holder leaves (Capture Points)
core-health25Core hits needed to break it (DTC)
points-per-break5Points for breaking the core (DTC)
core-regen10Seconds before the core regenerates (DTC)
core-broadcast30Seconds between core status broadcasts (DTC)
payload-speed10Cart speed in tenths of a block per second
payload-radius4Radius around the cart that counts, in blocks
return-delay10Seconds before an abandoned cart rolls back
return-speed20Rollback speed in tenths of a block per second
bounty-duration120Seconds each target lasts
bounty-points5Points for killing the target
survive-points2Points for the target surviving
reveal-interval30Seconds 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.

FileControls
menus/arenas.ymlThe arena list opened by /koth editor
menus/editor.ymlThe editor for a single arena
menus/settings.ymlThe arena settings page and which settings it shows
menus/zones.ymlThe zone list and zone tools
menus/rewards.ymlThe reward editor with its rank tabs
menus/schedule.ymlThe weekly schedule
menus/schedule-entry.ymlA single schedule entry
menus/stats.ymlPlayer and clan stats
menus/top.ymlThe player and clan leaderboards
menus/confirm.ymlThe confirmation shown before deleting
KeyDescription
titleInventory title. Supports the placeholders listed at the top of each file
rowsNumber of rows, 1 to 6
filler.materialItem used to fill empty slots
filler.nameName of the filler item
items.<name>.slotSlot the button sits in
items.<name>.materialAny Minecraft material
items.<name>.nameDisplay name
items.<name>.loreLore lines
arena-slotsSlots the arenas are placed in (arenas.yml)
type-materials.<TYPE>Icon used for each event type (arenas.yml)
setting-slotsSlots the settings are placed in (settings.yml)
entry-slotsSlots 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

SettingDefaultDescription
enabledtrueTurns the scoreboard on or off (hud/scoreboard.yml)
title&#FFAA00&lKOTHScoreboard title
max-events4How many events show at once before the scoreboard switches to the compact layout
lines.<type>per typeScoreboard lines for each event type, default is the fallback
enabledtrueTurns the bossbar on or off (hud/bossbar.yml)
stylePROGRESSBossbar style
color.<state>WHITE, GREEN, RED, YELLOWBossbar color for neutral, capturing, contested and returning. color.<type>.<state> overrides it
text.<type>per typeBossbar text for each event type, default is the fallback

Progress Bar and Status Text

SettingDefaultDescription
bar-length10Number of characters in the bar
bar-char█Character the bar is drawn with
bar-filled&#FFAA00Colour of the filled part
bar-empty&8Colour of the empty part
noneNoneText shown when a placeholder has no value
status.neutral&7NeutralText for the neutral state
status.capturing&aCapturingText for the capturing state
status.contested&cContestedText for the contested state
status.returning&eReturningText for the returning state
status.idle&8IdleText for the idle state

Holograms

SettingDefaultDescription
enabledtrueTurns holograms on or off
auto-anchortruePlaces the hologram above the arena automatically
height2.5Height above the anchor, in blocks
see-throughfalseWhether the text can be seen through blocks
shadowtrueText shadow
background#66000000Background color of the text, with alpha
view-range48Distance it is visible from, in blocks
lines.inactive{name}, {type}, InactiveLines 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 typeLines 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.

SettingDefaultDescription
<effect>.sound.enabledtruePlays the sound for that effect
<effect>.sound.nameper effectVanilla sound id
<effect>.sound.volumeper effectSound volume
<effect>.sound.pitchper effectSound pitch
<effect>.title.enabledtrueShows the title for start, win and bounty-target
<effect>.actionbar.textper effectAction bar text for capture, contested, dtc-hit and others
win.firework.enabledtrueLaunches a firework when an event is won
win.firework.colors#FFAA00, #FFFFFFFirework colors
zone-particles.enabledtrueDraws the zone border with particles
zone-particles.interval10Ticks between particle updates
zone-particles.view-distance64Distance particles are shown from, in blocks
zone-particles.spacing1.0Distance between particles along the border
zone-particles.max-points300Maximum particles drawn per zone
zone-particles.show-idlefalseDraws the border when the event is not running
zone-particles.<state>.color#888888, #FFAA00, #55FF55, #FF5555Border color for idle, neutral, capturing and contested

Effect names

EffectPlays when
startAn event starts
winAn event is won
capture-startA player starts capturing
contestedA zone becomes contested
captureA side scores a capture point
dtc-hitA player hits the core
dtc-immuneA player hits the core while it is regenerating
dtc-breakThe core is broken
payload-checkpointThe cart reaches a checkpoint
bounty-targetA player becomes the target
bounty-killThe target is killed

Messages

KeyDefault
prefix&#FFAA00&lKOTH &8» &7
no-permission&cYou do not have permission.
startedStarted &f{arena}&7.
stoppedStopped &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-eventNext event: &#FFAA00{name} &7on &f{time} &7(in &f{in}&7)
reward-queuedYour 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

PlaceholderReplaced 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