Installation Guide

Place the resource

Put the oxide-weather folder inside your server's resources folder. Most servers keep all their Oxide resources together in a folder named [oxide], which is fine.

The user interface is already built. You do not need to install anything, run any commands, or build anything. The packaged web files ship inside the resource.

Turn off your old weather and time script

This is the most important step, and skipping it is the number one cause of problems.

Only one resource may control the sky and the clock. If a second one is running, the two fight and you get weather that flips back and forth every few seconds, or a clock that jumps.

Look through your resources folder and your server.cfg for anything that syncs weather or time, and stop it. Common names to look for:

• qb-weathersync
• Renewed-Weathersync (sometimes spelled renewed-weathersync)
• cd_easytime
• vSync or vsync
• night_natural_disasters
• anything else with weather, time or sync in its name

If you start resources one line at a time in server.cfg, delete or comment out the line:

# ensure qb-weathersync

If you start a whole folder at once (for example ensure [qb] or ensure [standalone]), removing a line is not enough. The resource starts because it sits inside that folder. Move the folder out instead:

resources/[qb]/qb-weathersync   ->   resources/[disabled]/qb-weathersync

Do not add ensure [disabled] anywhere. Anything in that folder stays off.

Also check anything else that can change the sky:

• Admin menus. vMenu and similar menus have weather and time options. If an admin uses them, they override oxide-weather for whoever is nearby until the next sync tick. Turn those options off for anyone who should not have them.
• txAdmin. If you use txAdmin's weather or time controls, stop using them. Change weather with /weather instead.

Database (nothing to do)

oxide-weather saves the state of the world. The time, the weather, the season, snow cover, storms and your regions all survive a restart. It keeps that in two database tables, and it creates both of them by itself the first time it starts:

There is nothing to import. The only requirement is that the database user on your mysql_connection_string line is allowed to create tables, which is the case on a normal setup.

If your host does not allow that, run sql/install.sql by hand: open your database manager (HeidiSQL, phpMyAdmin, DBeaver, or the database tab in your hosting panel), select the database your server uses, paste the contents of the file into the query window and run it.

If you genuinely do not want anything saved, you can instead turn Save simulation off (see Configuration → Persistence).

Add it to your server.cfg

Your server.cfg is the text file that tells your server which resources to start, and in what order. Order matters here.

# 1. Database and library first
ensure oxmysql
ensure ox_lib

# 2. Your framework
ensure qb-core            # or qbx_core / es_extended

# 3. o-link - the bridge. After your framework, before any Oxide resource
ensure o-link

# 4. Oxide resources
ensure oxide-tablet       # optional - adds the weather app and widget
ensure oxide-weather

The only hard rule is that o-link starts after your framework and before oxide-weather.

If you keep all your Oxide resources in a folder called [oxide], you can replace the last block with a single ensure [oxide] line.

Save the file.

Make sure you can use the admin tools

Every /weather command is admin-only. Admin here means your account holds a server permission called an ACE, a permission rule your server checks. It is separate from your framework's own admin list.

Two lines in server.cfg set this up. Add them if they are not already there:

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

• The first line puts you in the admin group.
• The second line gives that whole group the admin permission.

To find your license identifier, join your server and look at the console line printed when you connect, or run status in the live server console. It looks like license:1a2b3c4d5e6f.... Paste the whole thing after identifier..

If your server already has add_ace group.admin command allow (stock QBCore and QBX ship with it), your existing admins already pass and you do not need to change anything. On ESX, the framework's own admin and superadmin groups pass automatically.

The server console counts as an admin for every command, so you can always run weather commands from there even before you set this up. Full details are in Admin Tools → Permissions.

Start the server

Start or restart your server and watch the console.

What working looks like:

• No red dependency errors mentioning ox_lib, oxmysql or o-link

• A console line confirming it started:

  [INFO][oxide-weather][lifecycle] Weather synchronization ready

  On a restart you also get:

  [INFO][oxide-weather][persistence] Weather simulation restored from SQL.

• Nothing red or yellow repeating every minute

• Join the server. The in-game clock should be moving, and after a while the weather should change on its own. Each change prints [INFO][oxide-weather][weather] Weather changed

If you never see the lifecycle line, the resource has not finished loading. That almost always means it could not reach the database, or the database user is not allowed to create tables. See Troubleshooting → The weather never loads.

Set it up the way you want it

You have two ways to change settings, and it matters which one you use.

• Before the first start: edit the files in shared/ (see Configuration). Everything in them is copied into the database the first time the resource runs.
• After the first start: run /weather settings in game. The database is now the source of truth, and editing the files does nothing.

For a brand new install, the usual path is:

1. Start the server once with the defaults.
2. Run /weather settings in game and adjust what you want.
3. Run /weather zones if you want to redraw the weather regions on the map.

Full details are in Configuration and Admin Tools.