Skip to content

Configuration

Version: 1.0.0

Events is configured in mods/kyuubisoft_events/config.json. The file is written with the default values on the first start.

  • Most options are also in the admin window (/kseventadmin, pages Rules and Build field). Changes there apply at once and are written to the file shortly after.
  • Edit the file while the server is stopped, or use /kseventadmin reload after editing it.
  • Values out of range are repaired when the file is read (an unknown time zone becomes the server clock), so a hand-edited file never stops the mod. The ranges are listed below.
  • There are no economy values here. Rewards belong to each event and are empty for new events.

{
"configVersion": 1,
"timezone": "system",
"reminders": { "minutesBefore": [60, 10, 1], "toast": true, "chat": true, "raven": true },
"announce": { "startToAll": true },
"contest": { "buildMinutes": 60, "voteMinutes": 20, "ceremonyMinutes": 5, "lateSignupMinutes": 10, "minParticipants": 2 },
"meeting": { "durationMinutes": 60 },
"travel": { "opensMinutesBefore": 10, "warmupSeconds": 3, "cancelDistance": 1.0, "returnWindowMinutes": 30 },
"fields": { "plotSize": 24, "pathWidth": 4, "resetBeforeNext": true, "resetLeadMinutes": 5 },
"voting": { "minVotes": 3, "anonymous": true, "voters": "PARTICIPANTS_AND_PRESENT", "releaseOnSuspicious": false, "newAccountHours": 24 },
"attendance": { "radius": 32, "afkMinutes": 2, "graceMinutes": 5 },
"hud": { "countdownMinutesBefore": 10 },
"history": { "keepDays": 90 }
}

configVersion is managed by the mod; leave it as it is.


In the admin window: Rules → Time and reminders and Channels.

OptionDefaultRangeMeaning
timezone"system"system or a time zone idThe time zone of all event times. "system" is the server clock; otherwise an id such as Europe/Berlin. Changing it moves the planned dates to the new zone
reminders.minutesBefore[60, 10, 1]each 1–1440; the admin window takes up to 5Reminder times for new events. Each event keeps its own times, set on the Plan page
reminders.toasttrueReminders as a card at the top of the screen
reminders.chattrueReminders as a chat line
reminders.raventrueReminders as a note on the whisper stone, also for players who are offline. Only with KyuubiSoft Whisperstone
announce.startToAlltrueThe start and the ceremony are announced to everyone online. Off: only to those taking part (signed up, rating on the field, or present at a meeting)

Players choose which dates remind them: all events, only events they joined (default) or off. Cancellations reach everyone signed up through the same channels.


In the admin window: Rules → Flow.

OptionDefaultRangeMeaning
contest.buildMinutes601–1440Build time of new build contests
contest.voteMinutes201–1440Voting time of new build contests
contest.ceremonyMinutes50–120Ceremony time of new build contests
contest.lateSignupMinutes100–1440Players can still join a contest this many minutes after its start, while plots are free
contest.minParticipants21–100A contest with fewer sign-ups at its start is cancelled, and everyone signed up is told. An admin start ignores it. Meetings always take place
meeting.durationMinutes601–1440Duration of new meetings
hud.countdownMinutesBefore100–1440The event card at the left edge counts down from this many minutes before the start

The phase lengths of an event are set per event on the Plan page; the values here only fill the form of a new event. Only lateSignupMinutes, minParticipants and countdownMinutesBefore are on the Rules page.


In the admin window: Rules → Flow (Travel opens) and Travel.

OptionDefaultRangeMeaning
travel.opensMinutesBefore100–1440Travel there works from this many minutes before the start until the end
travel.warmupSeconds30–60Seconds of standing still before the trip
travel.cancelDistance1.00.1–16Moving further than this many blocks during the warm-up cancels the trip. Only in the file
travel.returnWindowMinutes300–1440Back where I was works until this many minutes after the end

Taking damage during the warm-up also cancels the trip. Trips from dungeon and minigame instances are never possible; the Rules page shows this as Not from instances · always.


These are the defaults for new build fields and the timing of the field reset. Each field keeps its own plot size, path, locked plots, themes and reset switch, set on the Build field page.

OptionDefaultRangeMeaning
fields.plotSize244–128Plot size in blocks (square)
fields.pathWidth40–32Width of the paths between plots, in blocks
fields.resetBeforeNexttrueNew fields are reset to their empty state before the next contest
fields.resetLeadMinutes51–60The reset starts this many minutes before a contest starts. Only in the file

The field is the rectangle of the Claims server zone, made of whole chunks (32 × 32 blocks). Events fits as many plots as possible: columns = (width + path) ÷ (size + path), rows likewise. The rest is spread evenly as a margin around the plots. Plots are numbered row by row from the north (smallest z) and from west to east. Only plots that lie fully inside the zone count.

Example: a zone of 4 × 3 chunks (128 × 96 blocks) with plots of 24 and paths of 4 gives 4 × 3 = 12 plots.

A new size or path applies from the next contest on.

  • When a field is created, the empty state is taken from the admin’s height: 4 blocks below and 60 blocks above. Save empty state stores the blocks of that box.
  • The builds of a contest stay on the field as an exhibition. 5 minutes before the next contest on that field (and only once it has enough sign-ups), Events puts the saved empty state back, spread over a few seconds.
  • Anyone on the field is first taken 6 blocks outside its nearest edge and told why. Nothing is changed while somebody is still on it.
  • The contest waits for the reset for at most 10 minutes. If the reset fails or takes too long, the contest uses the next field of the event’s list, and the failed field’s reset switches off until an admin chooses Retry reset or /kseventadmin field retry <field>.
  • A server stop during the reset does not switch it off; it runs again after the restart.
  • Chest contents and items lying on the ground are not part of the empty state.

In the admin window: Build field → Rating. These rules hold for every build field.

OptionDefaultRangeMeaning
voting.minVotes31–100A plot is only ranked with at least this many votes. The own plot never counts
voting.anonymoustrueBuilders stay anonymous until the ceremony. The build is rated, not the name
voting.votersPARTICIPANTS_AND_PRESENTPARTICIPANTS, PARTICIPANTS_AND_PRESENTWho may rate: those signed up, or also everyone who stands on the field during the voting (switch Everyone on the field may rate)
voting.releaseOnSuspiciousfalseA result with suspicious votes waits until an admin releases it (Result only after release)
voting.newAccountHours240–720A vote counts as suspicious when Events first saw the voter less than this many hours before the vote. Only in the file
  • Ranking: the average of all votes, shown with one decimal. A tie on the shown average goes to the plot with more votes, then to the earlier sign-up.
  • Suspicious votes: votes of new accounts, and votes of players who rated at least 3 plots with only 1s and 5s. Admins see them in the Overview and can strike or restore single votes; the ranking is recalculated.

In the admin window: Rules → Attendance. Used for meetings.

OptionDefaultRangeMeaning
attendance.radius321–512Blocks around the meeting point that count
attendance.afkMinutes21–60A player who did not move for longer than this does not count as present
attendance.graceMinutes50–30Present at the start = within the radius and not idle at any time in the first this many minutes; present at the end = at any time in the last this many minutes. 0 = only the moment of the start and of the end

Only players present at the start and at the end count as present: they get the attendance rewards and take part in the raffle. For a meeting at a vanilla warp, the warp’s position is the meeting point.


In the admin window: Rules → Log.

OptionDefaultRangeMeaning
history.keepDays901–3650Days that finished and cancelled dates are kept, with their sign-ups, votes, results and rewards. Older ones are removed once an hour

The Results tab of the events window always shows the last 30 days.


These values are not in config.json. They belong to each event and are set on the Plan page:

SettingNotes
KindBuild contest (needs KyuubiSoft Claims 2.0) or Meeting point
Name and descriptionName 1–40 characters, description up to 300
Date and timeIn the server’s time zone
Phase lengthsContest: build, rating, ceremony. Meeting: duration
RepeatOnce, or every week on chosen weekdays; single dates can be skipped
PlaceMeeting: your position (Set here) or a vanilla warp (Pick warp). Contest: optional
Build fieldsContest: one or more fields, in order
ThemeContest: fixed, or empty for a random theme from the field’s list
Raffle prizesMeeting: 0–100 winners; 0 = no raffle
RemindersUp to 5 times before the start
RewardsPer slot up to 5 rewards (see below)
Season Pass XP ×2Off by default. Needs KyuubiSoft Season Pass
SlotKind of event
1st place, 2nd place, 3rd placeBuild contest
ParticipationBuild contest: everyone who got a plot
Everyone presentMeeting
RaffleMeeting: each winner
RewardWhat it givesNeeds
ItemAn item id and an amount (1–10,000). What does not fit into the inventory waits in the window to be collectedKyuubiSoft Core
CoinsAn amount of a currency; empty = the main currencyAn economy through KyuubiSoft Core, for example Kronen
CommandA command without /, run as the console; {player} becomes the player’s nameKyuubiSoft Core, and ks.core.admin.dialog.console for the admin who adds it
TitleA hidden achievement of KyuubiSoft Achievements, by its idKyuubiSoft Achievements

Each reward can have a label that players see instead of the id (“Shown to players”).

  • Rewards that cannot be granted right now (the player is offline, or the needed mod is missing) wait for the player. Items are collected with Collect on the Results tab; titles, coins and commands are tried again at the next login.
  • Coins wait while the player is offline, but they are not paid at all when no economy is connected.
  • Each reward is given at most once per player and slot, also after a restart.

With Season Pass XP ×2 during the event on, Events runs Season Pass’s own admin command as the console when the event starts its first active phase: ksseasonpassadmin doublexp <minutes> with the minutes until the planned end (again after +5 min). When the event ends or is cancelled, it runs ksseasonpassadmin stopdoublexp. Season Pass has one boost for the whole server, so this replaces a boost that is already running.


The texts of all windows, commands and messages are in mods/kyuubisoft_events/localization/<area>/<language>.json (areas admin, core, integration, ui; languages en, de, es, fr, it, pl, pt-BR, ru, tr). Missing files are written at the start. When a newer version brings newer texts, the file is replaced and your old one is kept as <language>.json.backup-v<old version>.

Each player’s language comes from /kslang, which all KyuubiSoft mods share. Dates follow the language: 11/14 in English, 14.11. in German.