Configuration

All configuration is done in the config/ folder. These files are open (not encrypted), so you can edit them freely. Most settings can also be changed in game from /hzpanel (hz_lib): a value saved in the panel wins over the file.

General

Config.Debug = false
Config.Locale = 'en'
Config.AdminPermission = 'admin'
Config.TemperatureUnit = 'C'

Notifications

Config.Notifications = {
    Season = true,
    SeasonTitle = nil,
    Temperature = false,
}

Weather

Config.DynamicWeather = true
Config.TransitionDuration = 25.0
Config.ZoneTransitionDistance = 800.0
Config.FreezeWeather = false

Weather Influence (Zone Blending)

Config.WeatherInfluence = {
    enabled = true,
    maxDiff = 2,
}

Weather Outside Zones (config/weather.lua)

This list is only used outside the climate zones when the seasons are off (Config.SeasonsEnabled = false or cycleMode = 'disabled'). With the seasons on, the season presets drive the weather and this list is not used, decemberSnow included. useScheduledWeather applies in every case.

Time

Config.DayLengthMinutes = 0
Config.NightLengthMinutes = 0
Config.TimeScale = 1.0
Config.FreezeTime = false
Config.StartTime = { hour = 8, minute = 0 }
Config.NightSpeedMultiplier = 1.0
Config.UseRealTime = false
Config.NightTime = { beginning = 22, ending = 6 }

Clock Pace (config/time.lua)

Temperature

Config.TemperatureEnabled = true
Config.TemperatureMode = 'hybrid'
Config.TemperatureUpdateInterval = 5
Config.TemperatureRandomVariation = 2.0

• 'zone': based only on the zone's min/max range
• 'weather': based only on the current weather type
• 'hybrid': combines both (recommended)

Hour Modifiers (Day/Night Curve)

Config.TemperatureHourModifiers = {
    [0]  = -8,    -- Midnight
    [4]  = -10,   -- 4 AM (coldest)
    [8]  = -3,    -- 8 AM (sunrise)
    [12] = 3,     -- Noon
    [14] = 5,     -- 2 PM (peak)
    [20] = 1      -- 8 PM (evening)
}

Values are added to the base temperature. Hours in between are interpolated automatically. This curve is used when the seasons are off and for ignoreSeason zones; with the seasons on, each season's temperatureModifiers set the day/night curve.

Weather Modifiers (config/temperature.lua)

Seasons

Config.SeasonsEnabled = true

Gameplay Effects

All effects are configured under Config.Effects:

Vehicle Traction

vehicleTraction = {
    enabled = false,
    rainModifier = 0.7,
    snowModifier = 0.5,
    blizzardModifier = 0.3,
}

Reduced Visibility

reducedVisibility = {
    enabled = true,
}

Player Effects (Cold / Heat)

playerEffects = {
    enabled = true,
    notifications = true,
    freezing = true,
    heatStroke = true,
    coldThreshold = 10,
    heatThreshold = 30,
    screenFx = true,
}

Speed Reduction

speedReduction = {
    enabled = false,
    blizzardModifier = 0.85,
}

When enabled, players sprint at 85% speed during blizzard conditions.

NPC Population After a Disaster

Config.RestorePopulationBudget = 3

NPC population budget (0-3) given back after a tsunami or a tornado. Set it to your server's value if another script lowers it.

Wind

Config.WindEnabled = true
Config.WindUpdateInterval = 10
Config.WindGustsEnabled = true
Config.WindGustsProbability = 0.2
Config.WindGustsMultiplier = 1.5

Blackout

Config.BlackoutEnabled = true
Config.BlackoutAffectsVehicles = false
Config.BlackoutExceptions = {}

Tornado

Config.Tornado = { ... }

General

Movement

Visual (Particle System)

Physics (3-Force Vortex Model)

Debris Props

Visual Effects (Tornado.Effects)

Notification Messages

Tsunami

Config.Tsunami = { ... }

General

Aftermath Mode

Visual Effects (Tsunami.Effects)

Sirens and Voice (Tsunami.Sounds)

Notification Messages

Database

Config.SaveConfigToDB = true

Compatibility

Config.EnableQBCompat = true

Cayo Perico

Config.CayoPerico = true

HUD

Config.HUD = {
    Enabled = true,
    UpdateInterval = 5000,
}

Performance

Config.MaxHistoryDays = 30
Config.CleanHistoryOnStart = true

Climate Zones (config/zones.lua)

The 10 shipped zones: paleto, mont_josiah, sandy_shores, banham_canyon, vinewood_hills, vinewood, tataviam_mountains, palomino_highlands, los_santos and cayo_perico (circle, ignoreSeason = true). Zone names are the ones exports, commands and BlackoutExceptions use.

Weather set by an admin (panel or command) is locked and survives restarts until it is unlocked: lock badge on the panel map, or /weatherunlock <zone|all>.

Season Presets (config/seasons.lua)

This file defines the cycle, the 4 season presets and the transitions.

Cycle Mode

cycleMode = 'auto'  -- 'disabled', 'auto', 'realtime'

• disabled: no season cycle (manual weather)
• auto: the seasons rotate automatically, in seasonOrder, starting from startingSeason
• realtime: the seasons follow the server's real calendar (realtimeMapping: December to February = winter, March to May = spring, June to August = summer, September to November = autumn)

Season Length and Starting Season

cycleDuration = 120         -- Length of ONE season in real minutes ('auto' mode)
startingSeason = 'spring'   -- 'spring', 'summer', 'autumn', 'winter'

120 = each season lasts 2 real hours (8 h for the 4). The season changes when the weather entry running at that time ends.

Preset Structure

Each season defines a weather sequence and temperature modifiers:

spring = {
    label = { fr = "Printemps", en = "Spring", es = "Primavera", de = "Frühling" },
    icon = "...",

    -- Played in order. Durations are REAL minutes
    weatherSequence = {
        { weather = 'CLEAR',    duration = 80 },
        { weather = 'CLOUDS',   duration = 60 },
        { weather = 'OVERCAST', duration = 45 },
        { weather = 'CLEARING', duration = 35 },
        { weather = 'RAIN',     duration = 50 },
        { weather = 'CLEARING', duration = 40 },
    },

    temperatureModifiers = {
        base = 16.0,
        morning = -3,
        afternoon = 5,
        night = -6,
    },
}

Season Transitions

transitions = {
    enabled = true,
    duration = 2,  -- Transition duration (real minutes)
    transitionWeather = {
        ['spring_to_summer'] = 'CLEAR',
        ['summer_to_autumn'] = 'CLOUDS',
        ['autumn_to_winter'] = 'OVERCAST',
        ['winter_to_spring'] = 'CLEARING',
    },
}

Advanced

Locales (config/locales/)

12 languages are included: en, fr, es, de, pt, it, tr, ru, pl, zh, ja, ko. Set the active one in config/config.lua (or in /hzpanel), then restart the resource:

Config.Locale = 'en'

An unknown locale falls back to English.

Adding a New Language

1. Copy config/locales/en.lua to config/locales/xx.lua
2. Translate all string values
3. Set Config.Locale = 'xx' in config/config.lua (the panel only lists the 12 included languages)

return {
    ['key_name'] = 'Translated string',
    ['weather_changed'] = 'Weather changed to %s',
}