DUXPLIMA Documentation

Events and runs

Starting, pausing, ending, changing and deleting an event.

An event is started, played and ended as a run. Only one event runs at a time, and everything below can be done from the menus or with commands.

Starting

WayHow
Command/sr start <key>
Manage menuStart Event
Event listRight-click the event
ScheduleA weekly slot in auto-start.yml

An event needs at least one item before it can start. Starting a draft or a completed event begins a new run with empty scores; starting a paused event resumes it. While another event is running or paused, the start is refused: finish or pause that one first.

A start sends the event's start-broadcast, and a resume its resume-broadcast. Both are written in the event file.

Pausing

/sr pause, a right-click in the event list, or Pause in the stop question pauses the running event. Scores and the remaining time are kept, deposits are refused, and starting it again picks up where it stopped.

Ending

A run ends by itself when its time is up. Players are warned before that, at each time listed in end-warnings (one hour and ten minutes before, by default).

To end it early, type /sr stop (or /sr complete, /sr finish). Chat asks what to do, with clickable buttons that work once, for 60 seconds:

ButtonResult
Finish + PayEnds the run now and pays the rewards
Stop UnpaidEnds the run now and pays nothing
PausePauses the run instead
CancelLeaves it running

When a run ends, the event file's complete-broadcast announces the results. A run stopped unpaid sends unpaid-broadcast instead, and a run with nobody to reward sends no-reward-broadcast. A run is never paid twice.

Changing an event

ChangeHowEffect on a running event
NameRename EventImmediate
LengthSet Duration, or /sr duration <time> [id]The current run's length changes too
Items and pointsThe manage menuImmediate
Rewards and announcementsThe event file, then /sr reloadImmediate

A duration changed in the event file instead applies from the next run; the current run keeps its end time.

Removing an item from a running event raises a question for the points already earned with it. freeze-removed-item-scores: true (the default) keeps them; false takes them away. Set it in general-settings.yml.

Deleting

/sr delete [id] deletes an event after asking for confirmation. A running or paused event must be finished first. Its finished runs stay in the history.

Related: Depositing, Rewards, Commands