World API

vMenu decides what the sky is doing. It picks the weather, it runs the clock, and it works out the date and the moon phase from that clock. All of that lives inside the game, which is a problem the moment you want something outside the game to know about it. A Discord bot that posts "rain in twenty minutes", a website that shows the in-game time, a companion app that says whether tonight is a full moon: none of them can see any of it.

The World API is a small web address on your server that answers exactly that question. You ask it, and it hands back a single block of data describing the time, the date, the moon, the current weather and what is coming next.

It only ever reads. Nothing you send to it can change the weather, the time, or anything else.

Switching it onCopy Anchor Link

The endpoint is off until you give it a password. That password is called a token, and it is just a long piece of random text that only you and your tools know.

Add this to your server config, replacing the text between the quotes with your own random string:

set vMenu.Enhanced.WorldApi.Token "a-long-random-string-nobody-can-guess"

Then restart the resource.

Leave the token empty, or leave the line out entirely, and the endpoint answers every request with a polite refusal instead. That is the default.

Where it livesCopy Anchor Link

http://your-server-address:30120/vMenu.Enhanced/world

It runs on the same port your game server already uses, so there is nothing new to open in your firewall and nothing new to forward on your router. 30120 is the usual FiveM port. If you changed yours, use that number instead.

Asking it somethingCopy Anchor Link

Send the token in a header called X-vMenu-Token:

curl -H "X-vMenu-Token: a-long-random-string-nobody-can-guess" \
  http://your-server-address:30120/vMenu.Enhanced/world

Some tools make headers awkward. If yours is one of them, you can put the token in the address instead:

curl "http://your-server-address:30120/vMenu.Enhanced/world?token=a-long-random-string-nobody-can-guess"

The header is the better of the two, because addresses tend to end up written down in logs and browser history while headers usually do not.

Asking for a longer forecastCopy Anchor Link

By default you get the next 10 weather changes. Add forecast to the address to ask for a different number, anywhere from 0 to 48:

http://your-server-address:30120/vMenu.Enhanced/world?forecast=24

What comes backCopy Anchor Link

A block of JSON, which is a plain text format that essentially every programming language can read without any extra work. It looks like this:

{
  "utc": 1756800000,
  "sync": { "weather": true, "time": true },
  "clock": {
    "speed": 1.0,
    "frozen": false,
    "frozenAtUnix": null,
    "offsetSeconds": 0,
    "secondOfDay": 43200,
    "hour": 12,
    "minute": 0,
    "second": 0,
    "realSecondsPerGameHour": 120.0
  },
  "date": {
    "dayOfLoop": 12,
    "loopDays": 385,
    "year": 2000,
    "month": 1,
    "day": 13,
    "weekday": "Thursday"
  },
  "moon": {
    "dayOfCycle": 12.5,
    "cycleDays": 55.0,
    "phase": "waxing crescent",
    "illumination": 0.43,
    "angleDegrees": -95.4
  },
  "weather": {
    "override": null,
    "scheduled": "EXTRASUNNY",
    "current": "EXTRASUNNY",
    "next": "CLOUDS",
    "gameHoursUntilNext": 2.5,
    "realSecondsUntilNext": 300.0,
    "cycleGameHours": 123.45,
    "cycleLengthGameHours": 384.0,
    "cycle": "default",
    "cycleMode": "default",
    "cycleEntries": [
      { "gameHour": 0.0, "type": "EXTRASUNNY" },
      { "gameHour": 2.0, "type": "CLEAR" }
    ],
    "snowPass": false,
    "blackout": "off",
    "blackoutMode": "dynamic",
    "snow": "auto",
    "snowFalling": false,
    "temperatureCelsius": 30.0,
    "temperatureFahrenheit": 86.0
  },
  "forecast": [
    {
      "type": "CLOUDS",
      "gameHoursUntilStart": 2.5,
      "realSecondsUntilStart": 300.0,
      "gameHoursLong": 4.0,
      "realSecondsLong": 480.0
    }
  ],
  "temperatureOutlook": [
    {
      "gameHoursAhead": 0.75,
      "realSecondsAhead": 90.0,
      "hour": 13,
      "minute": 0,
      "weather": "EXTRASUNNY",
      "celsius": 31.3,
      "fahrenheit": 88.3
    }
  ],
  "temperatures": {
    "sampleHours": [0, 5, 6, 7, 10, 12, 16, 17, 18, 19, 20, 21, 22],
    "sampleHolds": [4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
    "rows": [
      { "type": "CLEAR", "celsius": [14.5, 14, 14, 16, 19.5, 27, 31, 31.5, 23, 19, 15, 14, 14.5] }
    ]
  }
}

The top levelCopy Anchor Link

clockCopy Anchor Link

dateCopy Anchor Link

The in-game calendar. GTA does not really have one, so vMenu keeps its own: a 385 day loop that always leaves the weekday and the moon phase lining up when it wraps around.

moonCopy Anchor Link

weatherCopy Anchor Link

forecastCopy Anchor Link

A list of the weather changes still to come, in order. Each entry says what the weather turns into, how long until it starts, and how long it lasts. Every one of those is given twice, once in in-game hours and once in real seconds, so you never have to do the clock speed maths yourself.

temperatureOutlookCopy Anchor Link

A rough temperature for each of the next 48 whole in-game hours, so you can draw a little temperature chart or say "it will be cold tonight". The entries always land exactly on the hour, so at 14

temperaturesCopy Anchor Link

The table every temperature on this page is worked out from, for the weather schedule the server is running right now. Use it if you want to show temperatures further ahead than temperatureOutlook goes, together with cycleEntries.

TemperaturesCopy Anchor Link

GTA works out a temperature for its world all the time, it just never shows it to anyone. vMenu works out its own version of it. Every weather type has its own temperature for each part of the day, so a sunny afternoon is hot and a rainy night is chilly. While the weather is changing from one type to another, the temperature slides between the two.

A few things to know about these numbers:

1. They are the temperature outside, at sea level. Players high up in the hills or flying feel it colder, because the game drops the temperature by up to 15°C between 200 and 1000 metres up. The forecast on a player's screen does take their height into account. This endpoint cannot, because it does not know where anybody is standing.
2. They are the weather temperature, not the temperature inside a building.
3. The game's own data for a couple of the snowy weather types was clearly typed in wrong (it had a snowy noon at 20°C, for example). vMenu smooths those out to sensible values.
4. While the snowy weather schedule is on, or a custom one with snowPass turned on, every weather type switches to its own winter temperatures. A foggy or cloudy day in the middle of winter is still freezing.

When something goes wrongCopy Anchor Link

Wrong tokens are noted in your server console, at most one line every ten seconds so somebody poking at it cannot bury everything else.