Installation

Install in five steps

1. Install ox_lib if you do not have it. It is the only requirement.

2. Drop dzr-environment into your resources folder.

3. Add it to your server.cfg, after ox_lib:

   ensure ox_lib
   ensure dzr-environment
   

4. Give your admins access. Add this to server.cfg (it grants everyone already in group.admin, which is where most frameworks put their staff):

   add_ace group.admin dzr.environment allow
   

5. Start your server. Type env:doctor in the server console to confirm your setup.

That is it. It runs out of the box with sensible defaults; the config is optional.

Note

Testing on your own server and /environment says "Access denied"? That is normal - being the server owner in-game does not put you in group.admin. Add yourself with your FiveM identifier:

add_principal identifier.fivem:YOUR_ID group.admin

Two ways to apply it: paste it in the live server console (works immediately, but is lost on restart) or add the line to server.cfg (permanent; takes effect next restart). Do both if you want it now and forever. Find YOUR_ID in txAdmin: Players, click your name, Identifiers, copy the fivem: value - any identifier type works, identifier.license: too. The server console itself always has access.

One server, one sky

If you already run another time/weather script (vSync, qb-weathersync, Renewed-Weathersync, cd_easytime, and so on), pick ONE. Before you ensure dzr-environment, remove or comment out the ensure line for your old weather or time script - running two makes them fight over the sky.

dzr-environment warns you in the console if it detects another (and env:doctor names it), but it never stops the other script for you.

Tip

On a QBCore server your framework ships qb-weathersync by default - that is the "other script" to stop.

vMenu users

The most common cause of "two weathers" or day-night flicker is vMenu's own sync. If you run vMenu, disable its time and weather sync in server.cfg:

setr vmenu_enable_weather_sync false
setr vmenu_enable_time_sync false

If you use them, also turn off vmenu_enable_dynamic_weather and vmenu_sync_to_machine_time. dzr-environment warns about vMenu sync at boot, and env:doctor reports it.

Updating

Replace the resource folder and restart. Saved time and weather live in FiveM KVP keyed by the resource name, not in the files, so an update keeps your world where it was. Your shared/config.lua is yours - back it up before overwriting if you changed it.

Uninstalling

Remove the ensure dzr-environment line and delete the folder. Nothing is left behind in a database (there is none). The sky simply stops being managed - GTA's default weather and clock take over, or whatever other sync script you re-enable. The KVP entry is tiny and harmless; it is only read if you reinstall.