Content generated with AI — it may contain mistakes.

ExyliaEvents/How it worksUpdated in v1.11.0

Control how events start and run

The five states of an event, countdowns, limits, cooldowns, world rules and automatic starts.

Page 11 of 258 min read
     - "exyliaevents.cooldown.vip:300"  - "exyliaevents.cooldown.vip+:120"  - "exyliaevents.cooldown.staff:0"   

By the end of this page you decide how many events may run, how long players wait, who may start one and when events start by themselves. Every value has a default, so a server works without touching any of it.

Before you start#

You need at least one working event; see Your first event. Values live in config.yml, and most of them also have a screen: run /eventsadmin, click Settings, then Limits or Random events. Run /eventsadmin reload after editing the file by hand.

Steps#

Cap the events

Click Settings, then Limits. Events per player, Events in total and Events waiting keep the server from filling with half-empty lobbies. See Limits.

Choose the waits

In Limits set Start cooldown (how long a player waits before starting another) and Waiting time (how long an event waits without filling before it gives up).

Choose how events start on their own

Turn on random events in Settings, Random events, or give an event a timetable from its own setup screen. See Automatic events.

Check that it works#

Start an event with /events start <id>, then try to start a second one as the same player: with the default max-events-per-player: 1 you are refused. Wait for the countdown and you see the five states below in order.

Going further#

The five states#

StateWhat it means
WAITINGOpen, collecting players.
STARTINGEnough players; the countdown is running.
PLAYINGThe game itself.
ENDINGWinners announced, rewards handed out, arena restored.
DISABLEDNot running.

Players may join in WAITING and STARTING. PLAYING is spectate-only, and an event can only be started from WAITING.

Outside PLAYING nothing in an event hurts its players. One who falls into the void while waiting or counting down is put back on the lobby spawn, and one who falls while the event is ending goes to the spectator spawn.

The timers#

Keys and defaults
config.yml
yaml
settings:
  broadcast-interval: 30
  waiting-timeout: 300
  broadcast-countdown-times: [30, 15, 10, 5]
KeyDefaultWhat it does
broadcast-interval30Seconds between "an event is waiting for players" announcements.
waiting-timeout300Seconds an event waits without filling before it gives up.
broadcast-countdown-times30, 15, 10, 5Which countdown seconds are announced server-wide.

Per configuration, countdown — 30 seconds by default — is how long STARTING lasts once min-players is reached. Dropping back below the minimum cancels it.

Inside the countdown, players are told at every second from 10 down and at each multiple of ten. The server-wide announcement only fires at the times listed above.

Grace period#

Most types start with a grace-period — 5 seconds as a rule, 15 in Survival Games — during which nobody can be damaged. It exists so a game does not end while players are still landing.

Limits#

Keys and defaults
config.yml
yaml
settings:
  max-events-per-player: 1
  max-events-total: -1
  max-events-waiting: 3
KeyDefaultWhat it does
max-events-per-player1Active events one player may have started at once. -1 is unlimited.
max-events-total-1Active events across the server.
max-events-waiting3Events sitting in WAITING at once.

max-events-waiting is the one that keeps a server from filling with half-empty lobbies nobody joins.

A rank can get its own per-player limit with exyliaevents.max-events.<n>, such as exyliaevents.max-events.3: the highest one a player holds replaces max-events-per-player, and 0 is unlimited.

Holding the start#

A player who starts an event with /events start becomes its host. While it is joinable they get a clock in the lobby (event-items.host) and can run /events hold: the countdown does not start, and one already running goes back to waiting, until they click the clock again or run /events begin. Players keep joining meanwhile.

Start cooldowns#

Keys and defaults
config.yml
yaml
settings:
  start-cooldown: 0
  start-cooldown-permissions: []

start-cooldown is the seconds a player must wait before starting another event; 0 disables it. Per-rank overrides go in start-cooldown-permissions as permission:seconds:

yaml
start-cooldown-permissions:
  - "exyliaevents.cooldown.vip:300"
  - "exyliaevents.cooldown.vip+:120"
  - "exyliaevents.cooldown.staff:0"

Numeric nodes work too, with no entry in the list: exyliaevents.cooldown.60 is a 60-second cooldown. A player matching several entries or nodes gets the lowest of them. exyliaevents.cooldown.bypass skips the cooldown entirely.

Where players may join from#

Keys and defaults
config.yml
yaml
world-restrictions:
  mode: NONE
  worlds: []
  force-join-all-skip-worlds: []
ModeMeaning
NONENo restriction. The default.
BLACKLISTPlayers standing in a listed world cannot join any event.
WHITELISTPlayers can only join while standing in a listed world.

World names are case-insensitive, and exyliaevents.world.bypass ignores the rule. force-join-all-skip-worlds lists worlds, such as an AFK area, whose players /eventsadmin forcejoinall leaves where they are; joining by themselves is still up to mode.

Commands inside an event#

Keys and defaults
config.yml
yaml
command-whitelist:
  enabled: true
  commands: [msg, message, tell, w, whisper, reply, r, respond, events, e, eventsadmin, event]

With enabled on, anything not on the list is refused while a player is inside an event. Matching is by prefix, and exyliaevents.bypass.blocked-commands skips it.

One activity at a time#

Joining an event takes a claim on the player, and the claim is shared with the rest of the Exylia plugins. A player already in a practice queue, an FFA arena or the sandbox cannot be pulled into an event, and a player in an event cannot be pulled elsewhere.

The claim is re-entrant: moving from the event's lobby into the game, or from playing to spectating, keeps one continuous claim rather than dropping and racing to retake it.

Automatic events#

Two independent mechanisms can start an event with no admin.

Random events#

Keys and defaults
config.yml
yaml
random-events:
  enabled: false
  interval-minutes: 30
  min-players-online: 2
  allow-concurrent: false
  excluded-types: []
KeyDefaultWhat it does
enabledfalseWhether the timer runs at all.
interval-minutes30How often it tries.
min-players-online2Players needed for a try to go ahead.
allow-concurrentfalseWhether it may start one while another is already running.
excluded-typesemptyType ids it will never pick.

Each tick it picks a random startable configuration — enabled, valid and not already running — and starts it.

Scheduled events#

An event starts at set times from a schedule saved on the event itself.

Open the event

Run /eventsadmin, click Configurations, open the category and your event.

Open Schedules

Click Schedules. It shows how many lines the event has and when the next one fires.

Add a line

Add a line with the days and times it fires, or a repeat inside a time window, and save. It takes effect at once; no reload.

What a schedule line can say

Schedules come from ExyliaLib's schedule module and are stored in the event configuration in the database, not in a file.

FieldWhat it means
nameWhat you call the line.
enabledWhether it may fire at all.
daysWhich days. Empty means every day.
timesThe clock times it fires at.
every, from, toRepeat this often inside a window instead of fixed times.
min / max playersHow many players must be online.
conditionAn Exylia comparison such as %server_tps% >= 18.
requiresGates this plugin offers: event-inactive (this event is not already running) and nothing-running (no event is running).
cooldownThe shortest gap between two fires of the line.

The time zone is ExyliaLib's. A fire stopped by a gate, or skipped because the event is already at full capacity, is not retried: the next fire is the next time on the timetable. A fire more than two minutes late is skipped. Only the server that owns an arena runs its schedule.

scheduled-events.yml is retired

Older versions kept one shared scheduled-events.yml. On start the plugin moves each entry onto the event it names and renames the file to scheduled-events.yml.migrated. An entry with target RANDOM-EVENT, or naming an event that does not exist, cannot be moved: the console warns Could not place "<name>", and you add it from the event's own Schedules screen. A random pick on a timetable is now what random events does.

Both count as automatic

Events started by random events or by a schedule are marked as scheduler-started, which is what reward-commands.only-on-random-events keys off.

Something missing on this page? Tell us on Discord