Configuration

All configuration is done in the config/ folder. Changes made via the admin panel are saved to the database and take priority over file values.

General

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

Weather

Config.DefaultWeather = 'CLEAR'
Config.DynamicWeather = true
Config.WeatherChangeInterval = 600
Config.TransitionDuration = 25.0
Config.ZoneTransitionDistance = 800.0
Config.ZoneCheckInterval = 500
Config.PredictiveLoadDistance = 500.0
Config.FreezeWeather = false

Weather Influence (Zone Blending)

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

Time

Config.TimeScale = 1.0
Config.FreezeTime = false
Config.StartTime = { hour = 8, minute = 0 }
Config.NightSpeedMultiplier = 2.0
Config.UseNightSpeedMultiplier = false
Config.SyncInterval = 60
Config.UseRealTime = false
Config.NightTime = { beginning = 22, ending = 6 }

Temperature

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

• 'zone' — Based only on zone min/max settings
• 'weather' — Based only on the current weather type modifier
• 'hybrid' — Combines zone base + weather modifier + time-of-day curve (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.

Seasons

Config.SeasonsEnabled = true
Config.SeasonAutoStart = true
Config.DefaultSeasonPreset = 'summer'
Config.SyncRealWorldSeasons = false

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,
    fogDensity = 0.5,
    rainDensity = 0.2,
    blizzardDensity = 0.6,
}

Auto Wipers

autoWipers = { enabled = true }

Automatically activates vehicle wipers during rain and snow.

Auto Headlights

autoLights = {
    enabled = false,
    nightStart = 20,
    nightEnd = 6,
}

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,
}

Players sprint at 85% speed during blizzard conditions.

Ambient Sounds

ambientSounds = {
    enabled = true,
    sounds = {
        RAIN = 'rain_loop',
        THUNDER = 'thunder_loop',
        WIND = 'wind_loop',
    },
}

Weather-specific ambient sounds with automatic indoor attenuation.

Synced Lightning

syncedLightning = {
    enabled = true,
    flashDuration = 0.5,
    thunderDelay = 2.0,
    minInterval = 5,
    maxInterval = 15,
}

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.BlackoutAutoThunder = true
Config.BlackoutThunderProbability = 0.3
Config.BlackoutMinDuration = 5
Config.BlackoutMaxDuration = 10
Config.BlackoutExceptions = { 'Pillbox Hospital', 'Mission Row PD' }

Tornado

Config.Tornado = { ... }

General

Movement

Visual (Particle System)

Physics (3-Force Vortex Model)

Debris Props

Tsunami

Config.Tsunami = { ... }

General

Visual Effects

Notification Messages

Database

Config.DatabasePrefix = 'hz_weather'
Config.UseDatabaseConfig = true
Config.SaveConfigToDB = true

Compatibility

Config.EnableQBCompat = true
Config.EnableCDCompat = true

HUD

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

Performance

Config.MaxZones = 50
Config.MaxHistoryDays = 30
Config.CleanHistoryOnStart = true

Season Presets (config/seasons.lua)

This file defines the 4 season presets and the cycle behavior.

Cycle Mode

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

• disabled — No automatic season cycle. Use admin panel or commands.
• auto — Rotate through seasons based on cycleDuration.
• realtime — Map real calendar months to seasons (January = Winter, etc.).

Cycle Duration

cycleDuration = 120  -- Minutes for a full 4-season cycle (30 min per season)

Preset Structure

Each season defines a weather sequence, temperature modifiers, wind profile, and effects:

spring = {
    label = { fr = "Printemps", en = "Spring" },
    icon = "...",

weatherSequence = {
        { weather = 'CLEAR',    duration = 8 },
        { weather = 'CLOUDS',   duration = 6 },
        { weather = 'RAIN',     duration = 4 },
        { weather = 'CLEARING', duration = 3 },
    },

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

windModifiers = {
        base = 15.0,
        gusts = 25.0,
    },

effects = {
        roadWetness = 0.3,
        snowOnGround = false,
        visibility = 0.95,
    },
}

Season Transitions

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

Locales (config/locales/)

Set the active locale in config/config.lua:

Config.Locale = 'en'  -- or 'fr'

Adding a New Language

1. Copy config/locales/en.lua to config/locales/xx.lua (e.g. de.lua)
2. Translate all string values
3. Set Config.Locale = 'xx'

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