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).

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

Keybind that opens the admin weather menu. When Enabled, registered through the ox_lib keybind system on the key in Key.

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

Season used when the cycle is disabled, or the initial season at first start. One of 'SPRING', 'SUMMER', 'FALL', 'WINTER'.

In-game days per season when Realtime.Enabled is false.

Minutes after a restart before the first seasonal event can roll.

When true, season follows the real-world month (see Realtime.MonthMap) instead of DurationDays.

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.

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

Minutes between weather tick evaluations on the server.

Minimum random weather duration (minutes).

Maximum random weather duration (minutes).

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

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

Number of days included in the forecast.

Minutes between forecast regenerations.

Calculate and broadcast ambient temperature. Required for the forecast temperature, heatwave effects, and the exposure system.

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

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

At or above this, heatwave effects apply.

Hard temperature floor in Celsius.

Hard temperature cap in Celsius.

Broadcast in-world weather warnings during severe weather. Distinct from Config.Exposure.Warnings, which governs body-temperature notifications.

Play the warning sound FX alongside the text warning.

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

Render the small weather HUD panel. Also required for the body-temperature thermometer (see Config.Exposure.Hud).

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'.

Master switch for the entire body-temperature feature: the felt-temp model, all cold and heat FX, every body-temperature warning, the thermometer HUD, and the gameplay consequences. false removes all of it. Ambient temperature, forecast, weather, and snow are unaffected.

Gameplay penalties at danger tiers: stamina drain, reduced sprint, and aim shake. false leaves cosmetic FX and warnings only. Never drains health.

Client accumulator and server report cadence in milliseconds.

Degrees of felt-temperature offset per point of worn clothing warmth (see shared/clothing_warmth.lua).

Felt temperature (Celsius) at or below which the first cold tier triggers.

Felt temperature for the second cold tier.

Felt temperature for the severe cold tier.

Felt temperature at or above which the first heat tier triggers.

Felt temperature for the second heat tier.

Felt temperature for the severe heat tier.

Comfort midpoint (Celsius). Climate-controlled spaces such as vehicles and interiors pull felt temperature toward this.

Cold-side warming from clothing, fire, and shelter may raise felt temperature up to here but never above it, so bundling up can never cause heatstroke.

Degrees the summer heatwave seasonal event adds to the base temperature while active, so heat danger is reachable.

Heat-load model. SunHeatC is direct midday sun while unsheltered. HeavyClothingHeatScale is the fraction of clothing warmth that becomes heat load when hot. ShadeReliefC is relief under cover. WetCoolingC is evaporative cooling when wet.

Thermal inertia. Body temperature lags the instantaneous felt temperature. CoolSeconds is the time constant while cooling, WarmSeconds while warming.

Being soaked lowers felt temperature by up to this many degrees when cold.

Nearby prop heat sources. Models is a list of prop names hashed at runtime (patio heater, barrel fire, beach fire, BBQ, fire logs). FireBonusC and HeaterBonusC are the warmth added within Radius.

Throttled synchronous roof probe that detects being outdoors under cover.

Tuning for the danger-tier penalties. Applied only when Consequences is true.

Show on-screen body-temperature notifications as tiers escalate. Sub-toggle, active only while Enabled.

Legibility helpers. Enabled toggles the warmer/colder transition nudge. StepDeltaC is the minimum felt jump to fire a cue, CooldownMs the minimum interval. HysteresisMarginC is always-on anti-spam that keeps a warning tier from re-firing on a boundary, independent of Enabled.

Optional felt-temperature thermometer on the weather HUD. Shows only when this and Config.UI.EnableWeatherHud are both true and the player is in a cold or heat tier. Cosmetic: it never changes the model or its consequences.

Log danger episodes to the player_weather_effects table. Off by default: the table has no in-repo reader. Enable only if an external resource consumes it.

Degrees lost per 1000 m of elevation.

World Z treated as the sea-level baseline.

Cap on the altitude-cooling magnitude in degrees, so high ground cannot stack into instant severe cold.

Maximum tracked depth in metres.

Depth gained per minute at full snow intensity.

Snow melts when the ambient temperature is above this.

Depth lost per minute while melting.

Depth at or above which deep-snow effects apply.

On-foot move-rate floor at MaxDepth.

Wheel snow-spray particle FX on vehicles.

Optional random slip-and-fall while sprinting in deep snow. Off by default.

Traction reduction during RAIN. Range 0.0 to 1.0.

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.

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).

Account stakes are debited from and payouts credited to.

Maximum total stake wagered per forecast slot across all players. 0 is unlimited. Bounds bank liability per round.

Fraction shaved off fair odds. Range 0.0 to 1.0.

Minimum offered odds. Keep at or below about 1.07: a higher floor lifts the near-certain favourite back to positive expected value, which becomes a money-printing exploit.

Per-player cooldown between placed bets.

Track per-player betting stats.

Forecast webhook URL, or set the convar nxfs_forecast_webhook.

Warning webhook URL, or set the convar nxfs_warning_webhook.

Betting-payout audit webhook URL, or set the convar nxfs_betting_webhook.

Only post warnings at or above this level. 3 is SEVERE.

Only log betting payouts at or above this amount.

Embed colors per category as decimal integers.

Register the read exports, the GlobalState writer, and the public on* events.

Allow other resources to request or lock the weather through the control exports.

Minimum interval between GlobalState weather rebuilds, in milliseconds.

Per-season spawn weights (relative and auto-normalized — they need not sum to 1.0; set a type to 0 to disable it that season). Config.Weather.ChanceMultipliers and Config.InertWeather still apply on top. Partial edits work: Config.WeatherChances = { SUMMER = { RAIN = 0.15 } } only changes summer rain. Shipped weights cover SUMMER, WINTER, SPRING, and FALL.

Transition chains. The next weather is drawn from the current weather's list (first entry = itself, the most likely follow-on); omitted types fall back to a CLEAR/CLOUDS/OVERCAST chain. The betting kiosk prices its odds off these lists, so keep each chain to plausible, reachable transitions.

Per-weather strength range (0.0 to 1.0, picked uniformly). Higher means stronger storm FX, blackouts, ocean swell, grip loss, and snow build-up. Unlisted types use the default entry.

Minimum fog visibility distance in metres.

Spawn weights merged into the per-season weather chances. Shipped: SPRING (FOGGY 0.06, SMOG 0.02), SUMMER (SMOG 0.05, FOGGY 0.02), FALL (FOGGY 0.08, SMOG 0.03), WINTER (XMAS 0.05).

Window in which FOGGY may roll.

Window in which SMOG may roll.

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.