Configuration

Everything is in config.lua. Framework hooks (who is staff, names, logs, notifications) are in bridge/, covered in Custom servers.

General

Commands and keys

Set a command to false to turn it off. Keys are defaults players can rebind in Settings > Key Bindings > FiveM. '' means no default key.

Time

Weather

Each type has a label, an average temperature temp in C, a swing between the night low and the afternoon high, and a wind range in m/s picked when the weather changes with wind on auto.

Dynamic weather

Each weather lasts a random number of real minutes between Duration[1] and Duration[2]. Then the next one is picked by weight from the list under the current weather. A weather can only follow one listed under it, so clear skies never jump straight to a thunderstorm.

Config.Dynamic.Sequences = {
    EXTRASUNNY = { EXTRASUNNY = 3, CLEAR = 4, CLOUDS = 2, SMOG = 1 },
    CLEAR      = { CLEAR = 3, EXTRASUNNY = 3, CLOUDS = 3, SMOG = 1, FOGGY = 1 },
    NEUTRAL    = { CLEAR = 2, CLOUDS = 2 },
    SMOG       = { CLEAR = 3, CLOUDS = 2, FOGGY = 1, EXTRASUNNY = 1 },
    FOGGY      = { CLEAR = 2, CLOUDS = 3, OVERCAST = 2 },
    CLOUDS     = { CLEAR = 3, CLOUDS = 2, OVERCAST = 3, EXTRASUNNY = 1 },
    OVERCAST   = { CLOUDS = 3, OVERCAST = 2, RAIN = 2, FOGGY = 1, CLEARING = 1 },
    CLEARING   = { CLOUDS = 3, CLEAR = 3, OVERCAST = 1 },
    RAIN       = { CLEARING = 3, RAIN = 1, OVERCAST = 2, THUNDER = 1 },
    THUNDER    = { RAIN = 3, CLEARING = 2 },
}

Config.Dynamic.Winter = {
    XMAS      = { XMAS = 2, SNOWLIGHT = 3, FOGGY = 1 },
    SNOWLIGHT = { SNOWLIGHT = 2, XMAS = 2, SNOW = 2, CLOUDS = 1 },
    SNOW      = { SNOW = 1, SNOWLIGHT = 3, BLIZZARD = 1 },
    BLIZZARD  = { SNOW = 3, SNOWLIGHT = 1 },
    FOGGY     = { XMAS = 2, SNOWLIGHT = 2, CLOUDS = 1 },
    CLOUDS    = { SNOWLIGHT = 3, XMAS = 2, FOGGY = 1 },
}

A higher number makes that weather likelier. RAIN = { CLEARING = 3, THUNDER = 1 } means rain clears three times as often as it turns into a storm.

Snow, blackout and temperature

Presets

Config.Presets are the one-click setups in the panel. Leave a field out to keep what's there now.

Presets that ship: Clear noon, Foggy morning, Golden hour, Grey afternoon, Rainy commute, Storm night, City blackout and White Christmas.

{ id = 'storm_night', label = 'Storm night', time = '23:30', weather = 'THUNDER', rain = 1.0,
  wind = { 11, 250 }, dynamic = false },

Sync and saving

Rate limit

Limits for the panel and staff events, per player.

Forecast card