Configuration

Framework identifier. One of 'ESX', 'QB'.

Target resource identifier. One of 'OX', 'QB'.

Active language for the UI, notifications, and the admin menu. Loads the matching locales/<code>.json file. Shipped: 'en', 'fi', 'de', 'fr', 'pt-br', 'es', 'tr', 'nl', 'it', 'pl', 'zh'. See Localization below.

Notification backend. One of 'ox_lib', 'esx', 'qb', 'custom'.

Optional function invoked when NotificationSystem = 'custom'. Signature: function(title, message, type, duration).

Optional list of raw identifiers (license, steam, discord) treated as admin outside the framework's group system.

Keybind that opens the admin menu. When enabled, registered through lib.addKeybind.

Enables verbose debug logging and unlocks debug-only commands (see Commands page).

When true, the optional analytics tables are created and weather changes are logged.

Master toggle for the seasonal cycle. If false, season stays fixed on Config.DefaultSeason.

Broadcast in-world weather warnings during severe weather.

Play the warning sound FX alongside the text warning.

Apply road traction, visual overlays, and weather-driven FX on clients.

Calculate and broadcast temperature. Required for shivering, cold breath, and heatwave effects.

Season used when EnableSeasons is false, or the initial season at first start.

0.01 to 1.0 multipliers. WetWeather tunes random RAIN/THUNDER frequency. SpringThunderEvent tunes the spring thunderstorm seasonal event.

Minutes after resource start before the first seasonal event roll.

Master toggle for gameplay flooding.

Automatically reset water after the profile duration expires.

Minimum time between gameplay flood triggers.

How often the server checks whether the active flood should expire.

Flood profile definitions keyed by id. Shipped: subtle, moderate, strong. Each profile: { maxFloodHeight, increaseRate, threadWait, durationMinutes }.

Weighted selection when a profile is picked automatically.

Per-season trigger rules. Shipped: SPRING (THUNDER, minIntensity 0.72, triggerChance 0.35) and FALL (RAIN or THUNDER, minIntensity 0.80, triggerChance 0.20).

Master toggle for all storm systems.

Server to client cadence for storm state broadcasts.

Fallback intensity threshold for weather types not listed in EligibleWeather.

Per-weather minimum intensity required for blackout pulses to fire.

Optional weighted duration tiers per weather type. When a weather type has tiers, each blackout pulse picks one at random (weighted) instead of using PulseMin/MaxSeconds. Each tier is { duration = seconds, weight = N } for a fixed value, or { min = seconds, max = seconds, weight = N } for a random range. Durations are clamped to [2, 300] seconds. Leave a weather key absent to keep the default short-pulse behavior. Example for dramatic thunderstorm outages: DurationTiers = { THUNDER = { { duration = 30, weight = 60 }, { duration = 60, weight = 30 }, { duration = 300, weight = 10 } } }.

When false, vehicle lights are disabled during blackout pulses.

Probability of a strike FX broadcast on each sync interval while storm logic is active.

Hard cooldown between strike FX broadcasts.

'coastal' applies only when the player is near water. 'global' always applies.

Named scaler presets usable from the admin menu and the STORM_SET_OCEAN_OVERRIDE event.

Per-weather automatic scaler. Keys mirror GTA weather types (CLEAR, RAIN, THUNDER, SNOW, BLIZZARD, etc.). Values multiply the base wave height.

Optional boat penalties under rough seas. Thresholds are scaler values, multipliers clamp max speed, TurbulenceForce adds periodic impulse.

Enable the /forecast command and the newspaper-stand forecast interaction.

Render the small weather HUD panel.

Notify when temperature changes by more than TempChangeThreshold.

Minimum temperature delta (in degrees) that triggers a notification.

Seconds a warning banner stays on screen.

Display temperature in Celsius. Set false for Fahrenheit.

HUD display format. One of 'icon', 'text', 'both'.

Minutes between weather tick evaluations on the server.

Fallback duration (minutes) when Min/Max are not set.

Minimum random weather duration (minutes).

Maximum random weather duration (minutes).

Number of days included in the forecast.

Minutes between forecast regenerations.

Base temperature in Celsius. Modulated by season, time-of-day, and weather.

At or below this, the player is flagged as 'cold'. Triggers shivering and cold-breath effects.

At or above this, heatwave effects apply.

Real-world minutes per season when UseRealtimeSeason is false.

When true, season follows the real-world month (see RealtimeSeasonMonthMap) instead of SeasonDuration.

Month (1 to 12) to season ('SPRING', 'SUMMER', 'FALL', 'WINTER'). Shipped default maps Dec-Feb to winter, Mar-May to spring, Jun-Aug to summer, Sep-Nov to fall.

Server-authoritative time sync. Ensures all players share the same clock.

Mirror real-world time when true.

Freeze time progression when UseRealTime is false.

Minute progression multiplier when UseRealTime is false.

Server to client time broadcast cadence.

Optional fixed UTC offset (minutes) for realtime mode.

Traction reduction during RAIN. Range 0.0 to 1.0.