Configuration
Everything is in config.lua. Player-facing settings (graphics, crosshair) are chosen by each player in-game and stored client-side — the keys below are only the first-run defaults and the admin-level options.
config.lua is a shared script — it loads in both the server and client Lua VMs. Keys that drive client behaviour are applied on the client; with HZ-Bridge, admin overrides are pushed to the client live.
General
| Key | Default | Description |
|---|
Config.Locale | 'en' | UI language. en, fr, es ship; drop more in locales/. |
Config.Framework | 'auto' | auto detects es_extended → qbx_core → qb-core → ox_core → vRP → standalone. Force a name only if two cores run side by side. |
Config.LowPerformanceMode | false | Disables UI transitions/blur for very low-end clients. |
Config.ClientWait | 300000 | ms a client reuses one server-info fetch. Player count is always read fresh. |
Profile
| Key | Default | Description |
|---|
Config.Mugshot.Enabled | true | Show the player's face (GPU pedheadshot → base64) instead of an initial. Self-contained, cached, regenerated only on ped change. |
Config.Mugshot.Transparent | false | true = cut-out face over the circle gradient; false = studio backdrop cropped to the circle. |
Config.Mugshot.PollSeconds | 4 | How often to check for an outfit/model change. |
Config.DefaultNationality | 'USA' | Shown when the framework carries none (base ESX). Set "" to keep --. |
Config.LogoutCommand | 'logout' | Command run by the character card when the server has multichar. Leave "" with no multichar → the card opens the PROFILE tab instead (no dead button). |
Config.CharacterImage | 'images/character.webp' | Image on the GAME tab character card (under web/public/). "" falls back to the VICE wordmark. |
Branding & shop
| Key | Default | Description |
|---|
Config.ServerName | "" | Text next to the Discord icon. Empty = localized "Join the Discord". |
Config.DiscordURL | "…" | Discord invite opened by the button. |
Config.ShopURL | "" | The SHOP tab opens this URL in the player's browser (must be http(s)://). Empty = the SHOP tab is hidden. |
Accent & theme
| Key | Default | Description |
|---|
Config.Accent | "#FF6EC7" | One accent, injected as a CSS var. Overridden live by the HZ-Bridge theme cascade when present. |
Config.NativeMenuAccent | (table) | Tints the native GTA V Settings menu to your accent. See Theme. |
Player settings (defaults)
| Key | Default | Description |
|---|
Config.Graphics.Enabled | true | false hides the whole FPS panel. |
Config.Graphics.Timecycles | {} | Timecycle names offered in the dropdown. Empty on purpose — GTA has one timecycle slot and weather scripts own it. Only fill on a server where nothing else drives it. |
Config.CrosshairEnabled | true | false hides the whole Crosshair panel. |
Config.KeybindsEnabled | true | false hides the Keybinds sub-panel. |
Config.KeybindLayout | 'qwerty' | qwerty or azerty — the physical letter rows on the board. |
Config.Keybinds | (list) | Standalone keybind list, "KEY\ | LABEL\ | icon\ | DESC". If HZ-Loading runs, its shared keybinds are used instead. |
See Player settings for how these render in-game.
HUD integration
Config.Hud hides your HUD while the menu (or the native map/settings) is open, then restores it. It works with any HUD resource. Full reference: HUD integration.