Admin Tools

Every command, the admin panel, the zone editor, the settings menu, and how permissions work in oxide-weather.

Commands Overview

There is one chat command, /weather, with subcommands. Everything is admin-only, and the server console always counts as an admin.

If you type a subcommand that does not exist, the reply lists all of them.

If you run oxide-chat, typing /weather in chat shows the subcommands with their help text as you type.

Separately, oxide-weather:mapmode <value> switches which map the zone editor and radar draw on. Run it from the server console, or prefix it with / in game as an admin. See Configuration → Shared map mode.

Command Details

/weather

Opens the admin panel. This is the same as /weather admin.

/weather

Output:

• Success: a full-screen panel opens with a map of your regions.
• From the server console: a message telling you to open it in game. The panel is an in-game window.
• Not an admin: "You do not have permission to use this command."

/weather set

Sets the weather. With no arguments, it tells you what the weather is where you are standing.

/weather set                     -- report the weather where you stand
/weather set <type>              -- set the weather everywhere
/weather set <zone>              -- report the weather in one region
/weather set <zone> <type>       -- set the weather in one region

Parameters:

Weather types:

CLEAR, EXTRASUNNY, CLOUDS, OVERCAST, RAIN, CLEARING, THUNDER, SMOG, FOGGY, XMAS, SNOWLIGHT, BLIZZARD, SNOW, NEUTRAL, HALLOWEEN

Capitalisation does not matter. rain and RAIN both work.

Examples:

/weather set thunder            -- storm everywhere
/weather set paleto rain        -- rain in Paleto Bay only
/weather set chiliad            -- what is the weather on Mount Chiliad?

Output:

• Success: "Weather set to THUNDER", or "paleto: RAIN" for a region.
• If storms are active, the reply adds a note that fronts still override the weather where they are. Use /weather front list to see them.
• Failure: Usage: /weather set [zone] [type]; /weather set rain sets every zone, or "Unknown weather zone".

/weather time

Reads or sets the clock. This is the global clock, so it changes for everyone.

/weather time                    -- report the current time
/weather time <hour> [minute]    -- set the time

Parameters:

Examples:

/weather time            -- "Current time: 14:37"
/weather time 6          -- 06:00
/weather time 2 30       -- 02:30

Output:

• Success: "Time set to 02:30".
• Failure: Usage: /weather time [hour 0-23] [minute 0-59].

/weather freeze

Stops or starts the clock for everyone. Weather still changes while time is frozen.

/weather freeze          -- toggle
/weather freeze on
/weather freeze off

Output:

• Success: "Time freeze enabled" or "Time freeze disabled".
• Failure: Usage: /weather freeze [on|off].

/weather dynamic

Turns automatic weather on or off in every region at once. Off means the weather stays exactly where you put it until you change it.

/weather dynamic         -- toggle
/weather dynamic on
/weather dynamic off

Output:

• Success: "Dynamic weather enabled" or "Dynamic weather disabled".
• Failure: Usage: /weather dynamic [on|off].

/weather forecast

Prints the upcoming weather, with countdowns in real minutes, the in-game time each change lands at, and the temperature.

/weather forecast          -- for the region you are standing in
/weather forecast <zone>   -- for a specific region

Examples:

/weather forecast
/weather forecast sandy

Output:

• Success: the current conditions, then one line per upcoming change.
• If automatic weather is off: "Dynamic weather is disabled; no changes are scheduled".
• Failure: "Unknown weather zone".

/weather front

Manages moving storm cells. Only works when fronts are enabled.

/weather front list
/weather front spawn [type] [bearing] [speed] [radius] [minutes] [x] [y]
/weather front remove <id>

Parameters for spawn:

Examples:

/weather front list
/weather front spawn                                -- a 20 minute thunderstorm at your feet
/weather front spawn rain 270 20 1500 30            -- a fast, wide rain cell heading west, 30 minutes
/weather front spawn thunder 90 12 900 20 -500 -800 -- at a specific spot on the map
/weather front remove front-3

Output:

• list: one line per front with its id, weather, position, bearing, speed and seconds remaining. Or "No active weather fronts". /weather front on its own does the same.
• spawn: "Front spawned: <id>". Note the id, you need it to remove it.
• remove: "Front removed".
• Failure: "Weather fronts are disabled", "Front lifetime must be between 1/6 and 120 real minutes", "Invalid front coordinates", "Maximum active front count reached", "Console spawning requires X Y coordinates", "Turn off the holiday preset before spawning fronts", "Turn off real-world weather before spawning fronts.", or a usage line.

/weather blackout

Manages power cuts.

/weather blackout                              -- toggle the global blackout
/weather blackout on
/weather blackout off
/weather blackout list                         -- show everything currently set
/weather blackout <zone>                       -- report one region's power state
/weather blackout <zone> on|off [seconds]      -- set one region, optionally timed
/weather blackout schedule <zone> <delay> <duration>
/weather blackout cancel <id>

Parameters:

Examples:

/weather blackout on                        -- lights out everywhere
/weather blackout paleto on 300             -- Paleto Bay dark for 5 minutes
/weather blackout schedule city 600 1800    -- Los Santos goes dark in 10 minutes, for 30
/weather blackout list
/weather blackout cancel blackout-2

Output:

• list: the global state, then any regional overrides, then any scheduled outages with countdowns.
• Success: "Global blackout enabled", "Zone blackout updated" (followed by the outage id, such as "blackout-2", when you gave a duration), "Blackout scheduled: blackout-2", "Blackout schedule cancelled".
• Failure: a usage line.

/weather zones

Opens the region editor. See The zone editor.

/weather zones

Output:

• Success: the editor opens with your regions drawn on a map.
• From the server console: "Open the zone editor in-game with /weather zones".

/weather season

Reads or sets the season. Only works when seasons are enabled.

/weather season                  -- report
/weather season <value>

Values:

Examples:

/weather season             -- "Season: winter | game | day 3 of 7"
/weather season summer
/weather season auto

Output:

• Success: "Season: winter".
• Failure: "Seasonal weather is disabled", "Turn off the holiday preset before changing season", or a usage line.

/weather christmas and /weather halloween

Toggle a holiday preset. Christmas forces winter, XMAS weather and full snow cover. Halloween forces autumn and HALLOWEEN weather.

/weather christmas       -- toggle
/weather christmas on
/weather christmas off
/weather halloween on

Output:

• Success: "christmas preset enabled" or "christmas preset disabled".
• Failure: "Seasonal weather is disabled", or a usage line.

/weather admin

Opens the admin panel. Identical to running /weather with nothing after it.

/weather settings

Opens the settings editor. See The settings menu.

/weather settings

Output:

• Success: the settings editor opens on your screen.
• From the server console: "Open /weather settings in-game".

/weather lock and /weather unlock

Freezes the world for a scene: weather, time, wind, blackout state and snow cover all hold still.

/weather lock <global|playerId> <seconds>
/weather unlock <global|playerId>

Parameters:

Examples:

/weather lock global 600     -- hold the world still for 10 minutes
/weather lock 42 120         -- hold it for player 42 only, for 2 minutes
/weather unlock global
/weather unlock 42

Output:

• Success: "Scene lock applied" or "Scene lock released".
• Failure: "Player is not online", "Scene lock duration must be 1-7200 seconds", "Release the existing scene lock first", or a usage line.

/weather timescale

Sets how fast time passes. Higher means faster.

/weather timescale <day> [night]

Parameters:

Examples:

/weather timescale 30          -- the default: a full day in 48 real minutes
/weather timescale 60          -- twice as fast
/weather timescale 30 120      -- normal days, nights over in a few minutes
/weather timescale 1           -- near real time, without switching clock mode

Output:

• Success: "Timescale updated".
• Failure: Usage: /weather timescale [day] [night].

/weather clock

Switches between the game's own clock and a real-time mirror.

/weather clock <game|realtime> [offset]

Parameters:

Examples:

/weather clock game
/weather clock realtime          -- mirror UTC
/weather clock realtime -300     -- mirror UTC-5
/weather clock realtime 60       -- mirror UTC+1

Output:

• Success: "Clock mode updated".
• Failure: Usage: /weather clock [game|realtime] [UTC offset minutes], "Clock mode must be game or realtime", or "Invalid clock setting: utcOffset" when the offset is out of range.

/weather realworld

Mirrors the weather of a real place through Open-Meteo, or reports how the mirror is doing.

/weather realworld
/weather realworld status
/weather realworld on
/weather realworld off
/weather realworld <city name or latitude, longitude>

Parameters:

Examples:

/weather realworld Paris, FR
/weather realworld 51.5, -0.12
/weather realworld status
/weather realworld off

Output:

• Location set: "Real-world location set to Paris, FR", then a console line once the place is found and the first update arrives.
• on or off: "Real-world weather enabled" or "Real-world weather disabled".
• Status while off: "Real-world weather is off. Use /weather realworld <city> to turn it on."
• Status before the first update: "Real-world weather: Paris, FR | waiting for the first update", followed by the last error if there was one.
• Status: the place, the current weather type, the temperature, the wind and how many minutes ago the last update came in. STALE is appended when updates are overdue, and cached forecast ran out when the mirror has stopped driving the weather.
• Failure: the reason the location was refused, for example a name shorter than two characters.

/weather inspect

Prints everything the resource knows about the exact spot you are standing on. This is the fastest way to check that a feature is working.

/weather inspect

Output:

One line with your region, the weather, the rain amount (0 to 1), the temperature in Celsius, whether you are under cover, and the road wetness and ice at your feet. For example:

city | RAIN | rain 1.00 | 12.4 C | cover false | wet 0.62 | ice 0.00

• Failure: "Use /weather inspect in-game" from the console, or "Weather data is unavailable here" if you are outside the simulated area.

The Admin Panel

/weather opens a full-screen panel with a map of your regions down the middle. Click a region to control it, or leave it on Global to control everything at once.

The panel refreshes every two seconds while it is open, so two admins working at the same time see each other's changes. Press escape or the close button to leave.

The Settings and Edit zones buttons in the header open the settings menu and the zone editor in place, and the zone editor has a Control panel button to come back.

Everything in the panel goes through the same permission check as the commands, and every change is written to your server log with the admin's id.

The Zone Editor

/weather zones opens a map where you build your own weather regions.

To draw a new region:

If you would rather walk the shape out in the world, click Draw in world. The map closes, you place a point at each corner where you stand, and you are returned to the map with the shape filled in.

For each region you can set:

Limits: up to 32 regions, up to 64 corners each, and a shape may not cross over itself.

Changes apply live. Nobody has to reconnect. Your saved regions replace the ones that shipped.

If a region will not save, the error tells you why — see Troubleshooting → My region will not save.

The Settings Menu

/weather settings opens a searchable settings editor with Basic and Advanced tabs. Anything you change is written straight to the database and takes effect immediately, unless the field is marked as needing a restart.

• Fields you have altered show a Changed badge, and fields that only apply after a restart show a Restart required badge.
• Each field has a reset button that puts it back to the value that shipped.
• Saving several fields at once reports which ones went through and, if any failed, exactly why.
• Region boundaries are not here. The menu points you at /weather zones instead.

Full details of every setting are in Configuration.

When a Command Is Refused

Some refusals are deliberate. If a command comes back with one of these, nothing is broken:

Permissions

Admin here is a server permission, called an ACE, checked by the server itself. On QBCore and QBX your existing admin group already passes, and on ESX the framework's own admin check is accepted too. The details are below.

The two lines you need

Add these to your server.cfg:

add_principal identifier.license:YOUR_LICENSE_HERE group.admin
add_ace       group.admin                          admin allow

• The first line puts a person in the admin group.
• The second line gives that group the admin permission.

Repeat the first line for each admin. Groups that inherit from group.admin, such as group.superadmin, are covered automatically.

To find someone's license identifier, have them join and run status in the live server console, or read the connection line printed when they join. It looks like license:1a2b3c4d5e6f.... Paste the whole thing after identifier..

If you already have QBCore or QBX admins

Stock QBCore and QBX ship this line:

add_ace group.admin command allow

The check also accepts the command permission, so your existing admins already pass and you do not have to change anything.

If you run ESX

ESX group admins pass automatically. Anyone ESX itself treats as an admin (the admin and superadmin groups on a stock install) can use /weather with no extra configuration. The ACE lines above work as well, and are the fix if your ESX group is not being picked up.

The server console

The console is always treated as an admin. That means you can run every command from txAdmin's live console or from your host's console window, even before you have set anything up.

A few subcommands need to be run in game because they open a window or read your position: /weather, /weather admin, /weather settings, /weather zones and /weather inspect. From the console they tell you so.

What is not enough

• On QBCore or QBX, your framework's admin group only counts because the stock add_ace group.admin command allow line is in your server.cfg. If you removed that line, add the two lines above.
• Being a member of group.admin without the add_ace line is not enough. Being in a group and having a permission are two different things, and you need both lines.

Next Steps