Skip to content

koths

One file per KOTH in koths/ - capture settings, the zone, hologram, boss bar and rewards.

Every KOTH is one file in koths/, and the file name is its id (koths/spawn.yml is the KOTH spawn). After editing, run /kothadmin reload.

No KOTHs ship. Files are created by /kothadmin create <koth> from a built-in template, see Creating KOTHs. This page is the full field reference.

  • Ids are 1 to 32 lower-case letters, digits or dashes. A file with any other name is skipped with a console error.
  • Files whose name starts with _ are ignored.
  • A file that fails to load is skipped and the console names the file and the problem. The other KOTHs still load.

This is the file /kothadmin create spawn writes (with your selection in Region):

Settings:
Enabled: true
Display-Name: "&d&lSpawn"
Capture-Time: 180
Max-Duration: 1800
Reset-On-Leave: true
Minimum-Players: 0
Progress-Announcement-Interval: 30
Region:
World: "world"
Min:
X: -10
Y: 64
Z: -10
Max:
X: 10
Y: 70
Z: 10
Hologram:
Enabled: true
Height: 2.0
Line-Spacing: 0.3
View-Distance: 48
Lines:
- "{koth}"
- "&7Capturer: &f{capturer}"
- "&7Time Left: &f{time-left}"
Idle-Lines:
- "{koth}"
- "{status}"
- "&7Next Start: &f{next}"
- "&7Last Winner: &f{last-winner}"
Boss-Bar:
Enabled: true
Show-To: EVERYONE
View-Distance: 64
Title: "{koth} &8| &7Capturer: &f{capturer} &8| &7Time Left: &f{time-left}"
Color: PINK
Style: NOTCHED_20
Rewards:
- "[message] &5[&d&lKOTH&5] &7You won {koth} &7and received your rewards!"
- "eco give {player} 10000"
Key Required Default Description
Enabled no true false makes the KOTH impossible to start, skips it in schedules and hides its hologram.
Display-Name yes &d&l<Id> The {koth} token, used in every message, the hologram and the boss bar.
Capture-Time yes 180 Seconds a player must hold the hill without leaving to win. At least 1.
Max-Duration yes 1800 Seconds after the start before the KOTH ends without a winner. 0 runs until someone captures it.
Reset-On-Leave no true true: the held time goes back to zero when the capturer leaves. false: the next capturer continues from the held time.
Minimum-Players no 0 Players that must be online for a schedule to start it. Ignored by /kothadmin start.
Progress-Announcement-Interval no 30 Announce HILL-PROGRESS every this many held seconds. 0 (or removing the key) turns it off.

The Default column is what the template writes. For optional keys removed from the file, the plugin uses Enabled: true, Reset-On-Leave: true, Minimum-Players: 0 and no progress announcements. Negative numbers fail the load.

The capture zone, a box between two corners (both included).

Key Description
World World name. Required.
Min.X, Min.Y, Min.Z One corner.
Max.X, Max.Y, Max.Z The opposite corner.

The corners can be written in any order. A player is inside when the block their feet are in lies inside the box. {x}, {y} and {z} show the centre block of the box.

Changing the Region of a running KOTH stops it on reload.

A floating hologram above the zone, visible whether the KOTH is running or not.

Key Default Description
Enabled true false removes the hologram.
Height 2.0 Blocks above the top of the zone.
Line-Spacing 0.3 Blocks between lines.
View-Distance 48 Players within this many blocks see it. Must be above 0.
Lines (see above) Lines while the KOTH is running. Required when enabled.
Idle-Lines (see above) Lines while it is not running. Required when enabled.

The hologram is centred above the zone and refreshes once a second, so {capturer}, {time-left} and {next} tick live. It switches between Lines and Idle-Lines within a second of the KOTH starting or ending. Every KOTH token works in both lists.

A boss bar shown while the KOTH runs. It fills up as the capturer holds the hill and is removed when the KOTH ends.

Key Required Default Description
Enabled yes true false hides the boss bar for this KOTH.
Show-To yes EVERYONE EVERYONE (every online player) or NEARBY (players within View-Distance of the zone centre).
View-Distance with NEARBY 64 Blocks, for Show-To: NEARBY. Must be above 0 then. Ignored with EVERYONE.
Title yes (see above) Boss bar text. Every KOTH token works.
Color yes PINK PINK, BLUE, RED, GREEN, YELLOW, PURPLE or WHITE.
Style yes NOTCHED_20 PROGRESS (solid), NOTCHED_6, NOTCHED_10, NOTCHED_12 or NOTCHED_20. SOLID and SEGMENTED_* are accepted as aliases.

The progress of the bar is the held time divided by Capture-Time, so it drops back when the hill is lost with Reset-On-Leave: true.

Action lines run for the winner when the KOTH is captured, in order. A line without a [tag] is a console command.

Rewards:
- "[message] &7You won {koth}&7!"
- "[broadcast] &f{player} &7captured {koth}&7!"
- "[title] &6&lVICTORY;&7You won {koth};10;60;10"
- "[actionbar] &aRewards received"
- "[sound] UI_TOAST_CHALLENGE_COMPLETE;1;1"
- "[player] spawn"
- "crates key give {player} koth 1"
- "eco give {player} 10000"
Action Does
(untagged), [console] Run the command from console.
[command], [player] Run the command as the winner.
[message] Send a chat message to the winner.
[broadcast] Send a chat message to every player.
[actionbar] Show text above the winner’s hotbar.
[title] Show a title to the winner: title;subtitle;fade-in;stay;fade-out. Only the title is required; times are in ticks (defaults 10;60;10).
[sound] Play a sound to the winner: NAME;volume;pitch.

Any other tag fails the file load, naming the line. Every KOTH token works in rewards, plus {player} (the winner’s name) and {uuid} (their UUID). With PlaceholderAPI, %...% placeholders are resolved for the winner.

An empty or missing Rewards list is allowed: the KOTH is still won and announced, but nothing is given.