Schedule events
Start events by time of day, weekday or interval, with player count gates.
By the end of this page an event starts by itself: at fixed times, on certain days, or every few hours, and only when enough players are online. Each event has its own list of schedules, so a weekday KOTH and a Saturday Conquest never get in each other's way.
Before you start#
You need an event that is ENABLED and has its zone set (see Your first event). A disabled event never starts, scheduled or not. If your server is on another timezone than your players, read Timezone first.
Steps#
Open the schedules
Run /captureadmin, click Configurations, left-click your event, then click Schedules. The button shows how many it has.
Add one
Click the add button. The form already knows which event it starts, so it does not ask for an id.
Choose when it runs
Under When it runs pick At set times and type the times in 24-hour form, for example 20:00, 22:30. Or pick On a repeating timer and fill Every (2h, 90m) with an optional From and Until window.
Choose the days
Tick the days it may run. With every day ticked, or none, it runs daily.
Save
Leave Enabled ticked and submit. The entry appears in the list. A line with no time shows a barrier and "Set a time before it can run".
Check that it works#
Add a schedule a couple of minutes from now, wait, and the event should start and be announced. /captureadmin list shows it running. To see when the next one comes, use %exyliacapture_<id>_time_until_start% (see Placeholders). A schedule that does not fire is almost always one of the skips listed under How firing works.
Going further#
Only when enough players are online#
In the form tick Edit conditions next. The second screen, Schedule conditions, has:
- Minimum players online and Maximum players online (
0is no limit). - Wait between runs, the shortest gap between two fires of this entry, such as
1h. - Only if ... boxes, one for each named check the plugin offers (see below).
- Custom condition, for example
%server_tps% >= 18to skip while the server lags.
Several schedules for one event#
An event can have as many entries as you like: three times on weekdays and one on Saturday is two entries, one holding three times and one holding one. A repeat is anchored to its window's opening, not to when the server started. Every two hours from 10:00 fires at 10:00, 12:00 and 14:00 whatever time the server restarted.
How firing works#
When an entry is due, every check runs and the start is skipped (not retried later) if any fails:
- That event is already running. This is always checked.
- Fewer than the minimum or more than the maximum players are online.
- The custom condition does not hold, or the wait between runs has not passed.
- A named check you ticked does not pass.
A fire more than two minutes late, after a frozen server for example, is skipped too. Skips go to the console debug log rather than being silent.
| Named check | Passes when |
|---|---|
event-inactive | The event this entry starts is not running. |
nothing-running | No capture event at all is running on the server. |
nothing-running is the one to tick for "start this one, but never while another event is on".
Timezone#
Every schedule is read against one clock:
scheduler:
timezone: ""Empty, which is the default, uses ExyliaLib's own timezone setting, where a network sets it once for every plugin. Otherwise use a zone id such as America/New_York or Europe/Madrid, which overrides it for this plugin only. In game, /captureadmin then Settings then General edits it.
A value that is not a real zone id, such as an abbreviation like CET or a typo, is logged as an error on load and ExyliaLib's timezone is used instead. Check the console after changing it.
Show the time until the next one#
The time until an event's next fire, across all its entries, feeds:
%exyliacapture_<id>_time_until_start%for one event.%exyliacapture_next_event_time_until_start%for the soonest event on the whole server.- The
SCHEDULEDstate a hologram shows when an event is not running but has an upcoming schedule.
An event with no schedules reports nothing rather than zero, which is how a hologram tells "not running, but coming" apart from "not running at all".
Starting by hand#
A schedule is optional. /captureadmin start <id> starts an event at once, and it also refuses to start one that is already running.
Technical details: schedule fields
The timetable is ExyliaLib's schedule module: the same editor, fields and rules as every other Exylia plugin that starts things on a clock.
| Field | Meaning |
|---|---|
name | A label for the entry. Blank shows the times instead. |
enabled | Whether it may fire at all. On by default. |
days | Weekday names, or * for every day. An empty list also means every day. |
times | The HH:mm clock times it fires at, as a list. A single time is still read. |
every | Repeat this often instead of at fixed times, such as 2h or 90m. |
from / to | The window a repeat runs inside, as HH:mm. |
min-players | Players who must be online. 0 by default. |
max-players | The most players that may be online. 0 is no limit. |
condition | An Exylia comparison that must hold, such as %server_tps% >= 18. |
cooldown | The shortest gap between two fires of this entry. |
requires | Named checks: event-inactive, nothing-running. A name the plugin does not offer never passes, so a typo stops the entry from firing. |
Something missing on this page? Tell us on Discord