Guide

Event schedule

When events spawn, how many, and when they get cleaned up. The same settings in every event mod.

The idea

All the spawning events use one shared schedule. Each mod's settings file has the same 8 settings, so once you know them you know them for every event.

The 8 schedule settings

SettingDefaultWhat it does
firstSpawnSeconds2700How many seconds after the server starts the first spawn happens.
repeatEverySeconds2700After that, a new spawn every this many seconds until the restart. 0 means it only happens once.
minEventsPerSpawn1Minimum number of events each time.
maxEventsPerSpawn1Maximum number of events each time. It picks a random number between minimum and maximum.
maxActive0Maximum number of this event up at the same time. 0 means no limit.
maxPerRestart4Maximum number of this event in total per restart. 0 means no limit.
randomDelaySeconds0Makes each spawn come a bit late, up to this many seconds, at random. 0 means always on time.
minPlayers1Minimum players online. With fewer players, that spawn is skipped.

So out of the box: one event every 45 minutes, up to 4 per restart, as long as someone is online. If a setting is missing from your file, the default is used.

What happens at each spawn time

  1. 1Fewer players online than minPlayers? Then this spawn is skipped and it waits for the next one.
  2. 2It picks how many events to spawn: a random number between minEventsPerSpawn and maxEventsPerSpawn.
  3. 3That number gets cut down if it would go over maxActive (too many up right now) or maxPerRestart (too many this restart).
  4. 4It looks at the spots: a spot is skipped if an event of this mod is already there, if its own minimum players isn't met, or if its chance is 0.
  5. 5It picks that many spots from the ones left, using their chance (see below), and spawns the events there.

The spawn times are counted from the server start (first spawn, then every repeatEverySeconds), so they don't slowly drift later and later. randomDelaySeconds is added on top of each one.

Some events send a warning first. In those mods, delayBetweenEarlyNotificationAndSpawn is how many seconds between the warning and the event really showing up.

Spots and their chance

Each event has a list of spots (zones, positions). Every spot has a chance. The chance isn't a %: it's how often the spot gets picked compared with the other spots.

  • A spot with 2 gets picked twice as often as a spot with 1.
  • A spot with 1.0 gets picked 10 times as often as a spot with 0.1.
  • A spot with 0 is never used. Handy to turn a spot off without deleting it.

Some spots also have their own minimum players: that spot is only used when at least that many players are online.

The setting names are a bit different per mod, but they work the same:

Spot settingName in the mods
ChancechanceToSpawn, spawnChance or zoneSpawnChance
Minimum playersminimumPlayers or minimumPlayersToSpawn

A spot stays busy while its event is up. When the event ends (looted, timed out, deleted by an admin) the spot is free again. If an event fails to spawn (for example a typo in a classname), the spot is freed and it doesn't count towards maxPerRestart.

Cleanup: waiting for players nearby

Every event has a delete timer (deleteTimer, or a similar name like deleteCrateTimer). When it runs out, the event is removed with its zombies, AI, marker and PvE zone. But if players are still right there, it waits a bit:

SettingDefaultWhat it does
delayDeleteIfPlayersWithin100If living players are this close (in meters) when the timer runs out, the event waits. 0 means never wait: it's removed on time.
delayDeleteMaxSeconds600Maximum extra seconds it waits. It can't be less than 60.
  1. 1The timer runs out and someone is within delayDeleteIfPlayersWithin meters.
  2. 2Those players get a message right away telling them how long they have left, then a new one every 60 seconds.
  3. 3The event goes as soon as nobody is near any more, or when delayDeleteMaxSeconds is over, whichever comes first.

Loot Containers use the same two settings (default 30 meters there), but they wait quietly, without messages, so a town full of containers doesn't spam players.

Examples

2 ambulances every 20 minutes, until the restart:

HM_Settings_Ambulance.json8 lines
"firstSpawnSeconds": 1200,
"repeatEverySeconds": 1200,
"minEventsPerSpawn": 2,
"maxEventsPerSpawn": 2,
"maxActive": 0,
"maxPerRestart": 0,
"randomDelaySeconds": 0,
"minPlayers": 1

Just one air drop, 10 minutes after the server starts:

HM_Settings_AirDropPlus.json4 lines
"firstSpawnSeconds": 600,
"repeatEverySeconds": 0,
"minEventsPerSpawn": 1,
"maxEventsPerSpawn": 1

1 to 3 toxic zones every hour, never more than 3 at once, only with 10 or more players, and not always on the hour:

HM_Settings_Toxic_Barrel.json8 lines
"firstSpawnSeconds": 3600,
"repeatEverySeconds": 3600,
"minEventsPerSpawn": 1,
"maxEventsPerSpawn": 3,
"maxActive": 3,
"maxPerRestart": 0,
"randomDelaySeconds": 600,
"minPlayers": 10