Studio Documentation

Configuration

Last modified: 9 November 2026

Main settings are in plugins/NzKoth/config.yml. Messages, the boss bar and broadcasts are in messages.yml. All texts use MiniMessage.

Storage#

Where wins and leaderboards are saved. Changing it needs a restart.

storage:
  type: YAML          # YAML, MYSQL (also MariaDB) or POSTGRESQL
  host: localhost
  port: 0             # 0 = default port (3306 MySQL, 5432 PostgreSQL)
  database: nzkoth
  username: ''
  password: ''
  table-prefix: 'nzkoth_'
  pool-size: 4
  properties: {}      # extra JDBC options, e.g. useSSL: false

Modules#

Turn off the boss bar, scoreboard or broadcasts for every koth:

modules:
  bossbars: true
  scoreboards: true
  broadcasts: true

Wand and starter items#

wand:
  material: GOLDEN_AXE
  custom-model-data: 0
starter:
  material: NETHER_STAR
  custom-model-data: 0

Teams#

Used when a koth has team-mode: true. The team comes from the PlaceholderAPI placeholder (for example from a clans plugin) or, if empty, from the player's vanilla scoreboard team.

teams:
  display: SUFFIX     # REPLACE (team only), PREFIX ([team] name) or SUFFIX (name [team])
  placeholder: ''     # e.g. '%clans_tag%'
  no-team: ''         # text for players without a team

Discord webhooks#

webhooks:
  enabled: false
  url: ''
  username: 'NzKoth'
  color: 16731469
  events:
    start: '**%koth%** has started (%mode%)'
    stop: '**%koth%** was stopped'
    capture-start: '%player% is capturing **%koth%**'
    capture-stop: '**%koth%** is no longer being captured'
    capture: '%player% has won **%koth%**'
    end: '**%koth%** ended with no winner'

Scoreboard#

There is one list of lines for capture and one for score. See the builtin tags.

scoreboard:
  hide-numbers: true
  title: '<gradient:#ff4d4d:#ffb84d><bold><koth></bold></gradient>'
  lines:
    capture:
      - '<gray>Status: <white><status>'
      - '<gray>Time left: <yellow><time>'
      - '<bar>'

Progress bar#

progress-bar:
  length: 20
  symbol: '|'
  filled: '<green>'
  empty: '<dark_gray>'

Hologram#

A text hologram above the highest block in the center of the koth. The idle lines show while the koth is not running.

OptionDescriptionDefault
enabledShow hologramstrue
update-ticksHow often it updates20
heightBlocks above the highest block1.0
billboardCENTER (faces the player), FIXED, VERTICAL or HORIZONTALCENTER
alignmentText alignmentCENTER
scaleSize1.2
shadowText shadowtrue
see-throughVisible through blocksfalse
backgroundARGB hex like '#40000000', none or defaultnone
line-widthMax line width250
view-rangeMultiplier of the view distance (1.0 = 64 blocks)1.5
full-brightIgnore the light leveltrue
not-scheduledText for <next> when the koth has no schedulerNot scheduled

Resource pack#

The plugin comes with a resource pack for the winner crown. Without it, set another crown item in the koth editor.