Skip to content
BattleStudio

Scheduling KOTHs

Start KOTHs automatically on set days and times, with random picks and a minimum player count.

Schedules start KOTHs for you. They live in schedules.yml and run in the timezone set by Settings.Timezone in config.yml. You can always start a KOTH by hand with /kothadmin start <koth> as well.

1. Add a schedule

Section titled “1. Add a schedule”

Each entry under Schedules is one schedule, and the key is its name.

Schedules:
  evening:
    Enabled: true
    Days:
      - MONDAY
      - WEDNESDAY
      - FRIDAY
    Times:
      - "18:00"
      - "21:30"
    Random: false
    Koths:
      - spawn

This starts the spawn KOTH at 18:00 and 21:30 on Mondays, Wednesdays and Fridays.

  • Days - leave it empty (or remove it) to run every day.
  • Times - one or more HH:mm times, 24-hour clock.
  • Koths - the KOTH ids to start.

Full field list: schedules.yml reference.

2. Reload

Section titled “2. Reload”
/kothadmin reload

The {next} and {next-date} tokens, the hologram’s idle lines and the next placeholders update straight away. Run /kothadmin list to see each KOTH’s next start.

One KOTH or many

Section titled “One KOTH or many”

When a schedule fires, every KOTH in Koths that is enabled and not already running is started.

With Random: true only one of them starts, picked at random from those that are enabled and not running. This is how you rotate between several arenas:

Schedules:
  daily-rotation:
    Enabled: true
    Days: []
    Times:
      - "20:00"
    Random: true
    Koths:
      - spawn
      - desert
      - nether

Minimum players

Section titled “Minimum players”

A KOTH’s Settings.Minimum-Players (in its KOTH file) is checked when a schedule starts it. If fewer players are online, the KOTH stays closed and MINIMUM-PLAYERS-NOT-MET is announced instead. Starting a KOTH by command ignores this setting.

Timing rules

Section titled “Timing rules”
  • Schedules are checked once per second, and fire once when the minute matches.
  • A start that was missed (the server was offline, or lagged past the whole minute) is skipped. It does not run later.
  • Two schedules can name the same KOTH. Whichever fires first starts it; the other finds it running and skips it.
  • The next start shown in {next} is the earliest of every enabled schedule that names the KOTH.
  • A schedule naming a KOTH id that does not exist is reported in the console when the file loads and when it fires.