config.yml

Global settings. After editing, run /kothadmin reload (storage changes need a restart). A key you delete from this file falls back to its shipped default.

Settings

Settings:
  Storage:
    Type: SQLITE
    Host: "127.0.0.1"
    Port: 3306
    Database: "minecraft"
    Username: "root"
    Password: ""
  Timezone: SERVER
  Date-Format: "EEE HH:mm"

Key	Default	Description
Storage	SQLite	Where capture history is stored. See Storage.
Timezone	SERVER	The zone schedules run in and {next-date} is shown in. SERVER uses the machine’s own zone; otherwise any zone id (UTC, Europe/Berlin, America/New_York, Asia/Tokyo, …).
Date-Format	EEE HH:mm	Pattern for {next-date} and the next_date placeholders. EEE HH:mm prints Fri 18:00.

Invalid values stop the plugin

An unknown Timezone or an invalid Date-Format pattern throws on load with the bad value in the console. Use a full region id (abbreviations like EST do not work) and standard date pattern letters: EEE day name, dd day, MM month, HH hour, mm minute.

Storage

Key	Default	Description
Type	SQLITE	SQLITE (a local file at data/data.db) or MYSQL.
Host	127.0.0.1	MySQL host.
Port	3306	MySQL port.
Database	minecraft	MySQL database (schema) name.
Username	root	MySQL user.
Password	""	MySQL password.
Properties	none	Optional section of extra MySQL connection properties, for example useSSL: "false".

Host through Properties are ignored with SQLite. Captures go into a koth_captures table, which is created automatically. Changing storage needs a full restart.

Wand

The item /kothadmin wand gives you, and the particle outlines it draws.

Wand:
  Item:
    Material: BLAZE_ROD
    Name: "&d&lKOTH Wand"
    Glow: true
    Lore:
      - "&7Select the capture zone of a KOTH,"
      - "&7then run &f/kothadmin create <koth>&7."
      - ""
      - "&dUsage:"
      - "&5 - &7Left Click: &fPosition 1"
      - "&5 - &7Right Click: &fPosition 2"
      - ""
      - "&e➥ Click a block to set a position!"
  Outline:
    Enabled: true
    Interval: 10
    Spacing: 0.5
    Max-Points: 600
    Range: 64.0
    Selection-Particle: "HAPPY_VILLAGER"
    Koth-Particle: "FLAME"

Item

A standard item definition. The wand is recognised by a hidden tag, not by its look, so you can change anything here and old wands keep working.

Field	Default	Description
Material	BLAZE_ROD	Any material name.
Name	&d&lKOTH Wand	Display name.
Lore	(see above)	Lore lines.
Glow	true	Adds an enchant glint.
Amount	1	Stack size.
Custom-Model-Data	0	0 leaves it unset.
Item-Flags	[]	Bukkit item flags such as HIDE_ATTRIBUTES.

Outline

Particle outlines are only visible to the admin they belong to: your own wand selection, and the zone you toggled with /kothadmin outline <koth>.

Key	Default	Description
Enabled	true	false turns every outline off.
Interval	10	Ticks between redraws (20 ticks = 1 second). At least 1.
Spacing	0.5	Blocks between particles along each edge. Above 0.
Max-Points	600	Rough cap on particles per redraw. Big zones space their particles out to stay under it.
Range	64.0	You only see an outline while within this many blocks of the box.
Selection-Particle	HAPPY_VILLAGER	Particle for your current wand selection.
Koth-Particle	FLAME	Particle for /kothadmin outline.

Particle names are XSeries names, so legacy and modern names both work. Particles that need extra data (like DUST) cannot be used and fail the load.

Koth-Format

Text used by the tokens and placeholders when there is no real value to show.

Koth-Format:
  No-Capturer: "None"
  No-Winner: "None"
  No-Schedule: "Not Scheduled"
  Unlimited: "Unlimited"
  Status:
    Active: "&a&lACTIVE"
    Idle: "&c&lINACTIVE"

Key	Default	Shown as
No-Capturer	None	{capturer} while nobody holds the hill.
No-Winner	None	{last-winner} for a KOTH that was never captured.
No-Schedule	Not Scheduled	{next}, {next-date} and the next placeholders when no enabled schedule names the KOTH.
Unlimited	Unlimited	{ends-in} when Max-Duration is 0.
Status.Active	&a&lACTIVE	{status} while the KOTH runs.
Status.Idle	&c&lINACTIVE	{status} otherwise.

Inventories-Sounds

Named sounds in "NAME;volume;pitch" form. Names are XSound names, which stay stable across Minecraft versions. Set a key to "" to silence it.

Inventories-Sounds:
  "WAND-SELECT": "BLOCK_NOTE_BLOCK_HAT;1;1.5"
  "KOTH-STARTED": "ENTITY_ENDER_DRAGON_GROWL;0.5;1.5"
  "CAPTURE-STARTED": "BLOCK_NOTE_BLOCK_BELL;1;1.5"
  "CAPTURE-LOST": "BLOCK_NOTE_BLOCK_BASS;1;0.5"
  "KOTH-CAPTURED": "UI_TOAST_CHALLENGE_COMPLETE;1;1"
  "KOTH-ENDED": "BLOCK_BEACON_DEACTIVATE;1;1"

Key	Played when	To
WAND-SELECT	You set a wand position.	the admin
KOTH-STARTED	A KOTH starts (KOTH-STARTED).	every online player
CAPTURE-STARTED	Someone takes the hill (HILL-TAKEN).	every online player
CAPTURE-LOST	The capturer drops the hill (HILL-DROPPED).	every online player
KOTH-CAPTURED	A KOTH is won (KOTH-WON).	every online player
KOTH-ENDED	A KOTH times out or is stopped (KOTH-TIMED-OUT, KOTH-STOPPED).	every online player

HILL-PROGRESS and MINIMUM-PLAYERS-NOT-MET play no sound. Individual KOTHs can play extra sounds to the winner with a [sound] reward.