Skip to content
Retro Docs

Retro Weather

Config Files

Section titled “Config Files”
FilePurpose
config.luaPrimary configuration
shared/defaults.luaAdvanced defaults (fallback values)

Permissions

Section titled “Permissions”
SettingDescription
Config.AdminAcePermissionACE permission for admin access (default: rsweather.admin)
Config.DebugAllowAllAdminsAllow all players admin access (testing only)

Modules

Section titled “Modules”
SettingDescription
Config.EnableWeatherModuleEnable/disable weather system
Config.EnableTimeModuleEnable/disable time system

Weather Settings

Section titled “Weather Settings”
SettingDescription
Config.WeatherPrimaryRegionPrimary weather region
Config.WeatherRegionOrderOrder of weather regions
Config.RegionalWeatherPer-region weather configuration
Config.WeatherFrontsEnabledEnable weather fronts between regions
Config.WeatherMovementModeDefaultDefault weather movement mode

Time Settings

Section titled “Time Settings”
SettingDescription
Config.TimeUse24HourUse 24-hour time format
Config.TimeStartHourStarting hour
Config.TimeStartMinuteStarting minute
Config.TimeScaleTime scale multiplier
Config.TimeFrozenStart with time frozen
Config.TimeSetTransitionSecondsTransition duration for time changes

Realtime Mode

Section titled “Realtime Mode”
SettingDescription
Config.TimeRealtimeEnable realtime clock mode
Config.TimeRealtimeZoneIANA timezone string (e.g., America/Los_Angeles)
Config.TimeRealtimeUpdateSecHow often realtime is refreshed

Debug/Tracing

Section titled “Debug/Tracing”
SettingDescription
Config.TraceWeatherEnable weather tracing
Config.TraceTimeEnable time tracing
Config.TraceZonesEnable zone tracing

Data Files

Section titled “Data Files”
FilePurpose
data/weather_patterns.jsonPer-region weather sequences and durations
data/zones.jsonMap polygons for regions

Important Behavior

Section titled “Important Behavior”
  • shared/defaults.lua applies fallback values when keys are missing.
  • Realtime mode ignores admin set/freeze/scale time actions while enabled.