Configuration Reference
Every vMenu Enhanced configuration setting, generated from the source.
Every setting below is a server convar (vMenu.Enhanced.*) that vMenu writes into the
generated configuration.cfg example file. Defaults are what vMenu does when the convar is
unset.
About
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.DocumentationUrl | string | https://docs.vespura.com/vmenu/enhanced | The documentation link shown in the About menu. Change this if you'd like to have your own server documentation listed here. |
vMenu.Enhanced.DiscordUrl | string | https://discord.gg/fivem | The Discord invite link shown in the About menu. |
Admin
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.Admin.StaffOnly | bool | false | Makes vMenu staff only. Players without vMenu.Enhanced.Staff cannot open the menu and get none of its features, but staff can still use admin and bully options on them. |
vMenu.Enhanced.Admin.ClearAreaRadius | int | 100 | How far around a player, in metres, the Clear Area button reaches. |
vMenu.Enhanced.Admin.ClosestPlayerRange | int | 3 | How far away, in metres, the freeze and grab buttons will find a nearby player. |
vMenu.Enhanced.Admin.ScheduledAnnouncements | bool | true | Turns the announcement schedule in config/announcements.json on or off. |
vMenu.Enhanced.Admin.AnnouncementSeconds | int | 20 | How long an announcement stays on screen, in seconds. |
Bully
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.Bully.Enabled | bool | false | Enables the Bully menu, a set of mean things staff can do to players, and the electrocuting door option for personal vehicles. |
vMenu.Enhanced.Bully.DisableExplosions | bool | false | Turns off the Explode and Up-n-Atomizer bully actions, for servers whose anti cheat flags explosions. |
vMenu.Enhanced.Bully.DisableParticleEffects | bool | false | Turns off the Fireworks, Chaff and Beast Scare bully actions and the smoke of Transform Vehicle, for servers whose anti cheat flags particle effects. |
Debugging
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.Debugging.Client | bool | false | Enables additional console logging on the client side. |
vMenu.Enhanced.Debugging.Server | bool | false | Enables additional console logging on the server side. |
vMenu.Enhanced.Debugging.ExperimentalFeatures | bool | false | Currently doesn't do anything, leave this as false for now. |
DeveloperFeatures
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.DeveloperFeatures | bool | true | Enables the Developer Features menu. Pretty much all features in here are generally harmless. Give them a try, and then decide if you want to have them enabled or disabled for your server. If you're unsure, turn this off on a public, production, server. |
Gameplay
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.Gameplay.PvpMode | int | 1 | 0 = vMenu does not touch PVP, 1 = PVP Enabled, 2 = PVP Disabled. |
vMenu.Enhanced.Gameplay.NoClipSmoke | bool | true | Shows a puff of smoke where a player goes into or comes out of noclip, for everyone nearby. |
Integration
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.Integration.ApiKey (server only) | string | `` | Please read https://docs.vespura.com/vmenu/enhanced/integrations. Uses 'set' and not 'setr'! This is important to keep your API key secret! |
vMenu.Enhanced.Integration.Endpoint (server only) | string | `` | The base URL of the external tool this server connects to, for example 'https://example.com/api'. Value can be http or https, and an IP or a domain both work. If using HTTPS, the certificate must be valid and trusted. This server makes outgoing HTTP(S) calls to this URL, and also opens a websocket derived from it, so 'https://example.com/api' becomes 'wss://example.com/api/socket' (uses 'ws' for http instead). Leave it empty and this server makes no outgoing calls at all. Please read the documentation if you're planning on using this. Uses 'set' and not 'setr'. |
vMenu.Enhanced.Integration.AllowActions (server only) | bool | false | If set to true, it will allow external tools that connect using the websocket to perform actions against players. For example: kill, kick, heal, etc. Uses 'set' and not 'setr'. |
vMenu.Enhanced.Integration.Allowlist (server only) | bool | false | Only lets in players with the 'vMenu.Enhanced.Integration.Allowlist.Bypass' permission, or players a connected integration (like SnowstormBot) allows. Uses 'set', not 'setr'. |
vMenu.Enhanced.Integration.AllowlistMessage (server only) | string | You are not on the allowlist for this server. | Customize the message someone sees if they're not on the allowlist. |
vMenu.Enhanced.Integration.Queue (server only) | bool | false | If set to true, connecting players are held in a join queue that a connected external tool (like SnowstormBot) manages. Unlike the allowlist, this feature does not work without an external tool managing it! The tool decides the queues, priorities and delays. This convar only turns the queue on or off. A player holding the 'vMenu.Enhanced.Integration.Queue.Bypass' permission can skip the queue if they choose to (there is a button in the join screen they can click to bypass the queue). Uses 'set' and not 'setr'. |
JoinLeave
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.JoinLeave.LogToConsole | bool | true | Logs player connections to the server console. |
KeyBindings
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.KeyBindings.MenuToggleKey | string | M | |
vMenu.Enhanced.KeyBindings.NoClipToggleKey | string | F2 | |
vMenu.Enhanced.KeyBindings.TeleportKey | string | F10 |
Localization
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.Languages | string | nl,de,es,fr | The languages players can pick, as a comma separated list of file names without .json, in picker order. Each code needs a matching language/.json. To add one, copy language/example.json to language/ |
Logging
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.Logging.Enabled | bool | false | Enables or disables all the webhooks, regardless of what you configured below. |
vMenu.Enhanced.Logging.Webhook.Events (server only) | string | `` | A Discord webhook URL for server events. Use 'set' instead of 'setr' to keep your webhook URL secure. |
vMenu.Enhanced.Logging.Webhook.Actions (server only) | string | `` | A Discord webhook URL for what players do to themselves. Chatty on a busy server, so give it its own channel. Use 'set' instead of 'setr' to keep your webhook URL secure. |
vMenu.Enhanced.Logging.Webhook.Staff (server only) | string | `` | A Discord webhook URL for what players do to each other, including attempts refused for lack of permission. Use 'set' instead of 'setr' to keep your webhook URL secure. |
vMenu.Enhanced.Logging.Webhook.Security (server only) | string | `` | A Discord webhook URL when possible cheating is detected. If you leave this empty, the events will be sent to the staff webhook instead. Use 'set' instead of 'setr' to keep your webhook URL secure. |
vMenu.Enhanced.Logging.Webhook.Messages (server only) | string | `` | A Discord webhook URL for private messages players send each other, including what they wrote. Give it a channel only trusted staff can see. If you leave this empty, private messages are not sent to Discord. Use 'set' instead of 'setr' to keep your webhook URL secure. |
vMenu.Enhanced.Logging.Webhook.Generic (server only) | string | `` | A URL that receives the same lines as plain JSON instead of Discord messages, for your own tooling. If it uses HTTPS, the certificate must be valid and trusted. Use 'set' instead of 'setr' to keep your webhook URL secure. |
vMenu.Enhanced.Logging.FlushSeconds | int | 4 | How often vMenu sends what it has collected, in seconds. Lines are batched instead of sent one at a time, since Discord throttles you for posting too fast. Values outside 1 to 60 are clamped to that range. |
vMenu.Enhanced.Logging.QueueLimit | int | 500 | How many lines vMenu holds per webhook while waiting to send. Past this the oldest are dropped, and the next message through says how many. Stops an unresponsive webhook eating your server's memory. |
vMenu.Enhanced.Logging.MenuActionLimit | int | 30 | (Rate limiting) How many menu actions one player may log per window. These are reported by the player's own game, so this stops a modified client filling your channel. Set to 0 to turn the limit off, not recommended. |
vMenu.Enhanced.Logging.MenuActionLimitSeconds | int | 10 | How long the menu action window above lasts, in seconds. |
vMenu.Enhanced.Logging.SecurityLimit | int | 10 | How many security lines one player may log per window. A modified client can try thousands of things a second, and this stops that filling your channel. The next line through says how many were left out. Set to 0 to turn the limit off, not recommended. |
vMenu.Enhanced.Logging.SecurityLimitSeconds | int | 60 | How long the security window above lasts, in seconds. |
MenuAppearance
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.MenuAppearance.Skin | string | default | Choose a default theme: 'default', 'gold', 'green', 'red', 'gta', 'dark' or 'cartoon'. You can also choose any plugin-added theme here. |
vMenu.Enhanced.MenuAppearance.TitleAlignment | string | left | Where the title sits on the banner: 'left', 'center' or 'right'. |
vMenu.Enhanced.MenuAppearance.HeaderGlare | bool | true | Enables or disables the Globe in the menu header and the glare effect, like GTA Online's interaction menu. |
OnlinePlayers
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.OnlinePlayers.ActionLimit | int | 8 | How many things one player may do to other players from the online players menu within the time window below. |
vMenu.Enhanced.OnlinePlayers.ActionLimitSeconds | int | 10 | The length of the window the allowance above is counted over, in seconds. With the defaults, a player gets 8 actions per 10 seconds. |
vMenu.Enhanced.OnlinePlayers.MatchRoutingBucket | bool | true | Whether teleporting to a player, teleporting into their vehicle, and summoning a player should also move somebody into the other player's routing bucket. Routing buckets are separate worlds or dimensions (usually used for interiors). |
PersonalVehicle
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.PersonalVehicle.ActionLimit | int | 8 | Rate limit of personal vehicle remote actions within the configured time limit. Zero means no limit. |
vMenu.Enhanced.PersonalVehicle.ActionLimitSeconds | int | 10 | Time in seconds for the rate limit from above. With the default values that would be 8 actions within 10 seconds. Zero switches the limit off entirely. |
vMenu.Enhanced.PersonalVehicle.ControlRange | float | 350.0f | Leave this as 350.0 for now, this convar only exists for debugging purposes. |
vMenu.Enhanced.PersonalVehicle.ControlTimeout | int | 1500 | Just leave this at 1500 unless you know what you're doing. Timeout for moving on to the next client to try and act on a vehicle within range. Three players are tried before giving up, so keep this under 5 seconds. |
PlayerStats
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.PlayerOptions.MaxShooting | int | 100 | |
vMenu.Enhanced.PlayerOptions.MaxStrength | int | 100 | |
vMenu.Enhanced.PlayerOptions.MaxStamina | int | 100 | |
vMenu.Enhanced.PlayerOptions.MaxStealth | int | 100 | |
vMenu.Enhanced.PlayerOptions.MaxFlying | int | 100 | |
vMenu.Enhanced.PlayerOptions.MaxDriving | int | 100 | |
vMenu.Enhanced.PlayerOptions.MaxLungCapacity | int | 100 |
StaffAlerts
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.StaffAlerts.Enabled | bool | true | Allows players to alert staff via the 'Alert staff' button in the misc settings. |
vMenu.Enhanced.StaffAlerts.CooldownSeconds | int | 60 | How long one player has to wait between sending multiple alerts, in seconds. This is to prevent spam. |
vMenu.Enhanced.StaffAlerts.ExpireSeconds | int | 300 | This is how long an alert will stay active before it is discarded in seconds. |
vMenu.Enhanced.StaffAlerts.DisplaySeconds | int | 30 | How long an alert stays visible on screen in seconds. You can always see all active alerts in the staff alerts menu. |
TimeOptions
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.TimeOptions.Enabled | bool | true | Enables vMenu time control/sync. Set this to 'false' if you have another resource controlling game time. |
vMenu.Enhanced.TimeOptions.SpeedMultiplier | float | 1.0f | How fast the in-game clock runs compared to how GTA normally runs it. Value must be between 0.01 and 1000. |
vMenu.Enhanced.TimeOptions.Presets | string | `` | A list of preset times to choose from in the time options menu. |
vMenu.Enhanced.TimeOptions.TransitionSeconds | int | 4 | How long time transitions take. Zero instantly jumps to the desired time. |
Updates
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.Updates.CheckMode | string | prerelease | Configures the automatic version checks vMenu performs. Can be set to 'off', 'prerelease' or 'stable'. |
VehicleOptions
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.VehicleOptions.DeleteVehicleDistance | float | 5.0f | Distance in meters how far away the /dv command (and menu delete vehicle action) reaches for cars in front of the player. |
vMenu.Enhanced.VehicleOptions.DeleteVehicleCommand | bool | true | Enables or disables the /dv command from vMenu. Uses the same permission as the delete vehicle option inside the vehicle options menu. |
vMenu.Enhanced.VehicleOptions.RepairVehicleCommand | bool | true | Enables the /fixveh command to quickly repair a vehicle. Uses the same permission as the fix vehicle option inside the vehicle options menu. |
vMenu.Enhanced.VehicleOptions.WashVehicleCommand | bool | true | Enables the /washveh command to quickly clean a vehicle. Uses the same permission as the clean vehicle option inside the vehicle options menu. |
vMenu.Enhanced.VehicleOptions.ClearGodModeOnExit | bool | true | When set to true, it disables vehicle god mode for a vehicle as soon as the driver leaves the car (if they had vehicle god mode enabled). |
VehicleSpawner
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.VehicleSpawner.OrphanMode | int | `` | |
vMenu.Enhanced.VehicleSpawner.KeepSpawnedVehiclesPersistent | bool | false | Keeps a vehicle a player spawned loaded after they spawn another one with Replace Previous Vehicle turned off, instead of letting the game clean it up on its own. Turning this on means abandoned vehicles pile up until somebody deletes them. |
vMenu.Enhanced.VehicleSpawner.SpawnLimitSeconds | int | 60 | The stretch of time, in seconds, the three allowances below are counted over. Set this to zero to switch spawn limits off entirely. |
vMenu.Enhanced.VehicleSpawner.SpawnLimitTier1 | int | 5 | How many vehicles a tier 1 player may spawn within the window above. Zero means no limit. |
vMenu.Enhanced.VehicleSpawner.SpawnLimitTier2 | int | 15 | How many vehicles a tier 2 player may spawn within the window above. Zero means no limit. |
vMenu.Enhanced.VehicleSpawner.SpawnLimitTier3 | int | 0 | How many vehicles a tier 3 player may spawn within the window above. Zero means no limit. |
WeatherOptions
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.WeatherOptions.Enabled | bool | true | Enables or disables vMenu's weather control and sync. Turn this off if you want another resource to control the weather. |
vMenu.Enhanced.WeatherOptions.WeatherCycle | string | default | Which weather schedule the server follows: 'default' (the normal GTA Online one), 'snowy' (a winter one that keeps snow on the ground while the snow setting is on automatic) or 'custom' (your own schedule from config/weather-cycle.json, which is the only one that can also schedule blackouts). |
vMenu.Enhanced.WeatherOptions.SyncClouds | bool | true | Syncs clouds with all players. |
vMenu.Enhanced.WeatherOptions.TransitionSeconds | int | 45 | How long, in seconds, it takes for weather to transition from one type to another when manually changing types in the menu. |
WorldApi
| Setting | Type | Default | Description |
|---|---|---|---|
vMenu.Enhanced.WorldApi.Token (server only) | string | `` | A password that lets your own tools read the weather, time, date and moon phase over HTTP, so a Discord bot or a website can show what the sky is doing without guessing. Leave it empty and the endpoint is switched off and answers nobody. Set it to any long random string and callers hand it back in an X-vMenu-Token header, or a token query parameter, to be let in. Uses 'set' and not 'setr': this is a secret. |