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_lib, admin overrides are pushed to the client live.

14 keys are also in /hzpanel. Config.Locale, Config.LowPerformanceMode, Config.Brand, Config.ServerName, Config.DiscordURL, Config.ShopURL, Config.Accent and the Config.Hud keys except Custom can also be set in the hz_lib panel under Pause Menu. config.lua applies until a value is saved in the panel. A value saved in the panel wins over config.lua and applies live, and its reset button returns the key to config.lua (with hz_lib 1.2.1 or newer). Before HZ-PauseMenu 1.2.1, the panel defaults won over config.lua for these keys even with nothing saved, so update both hz_pausemenu and hz_lib to 1.2.1. With hz_lib, Config.Locale must be en, fr or es, the three languages the panel offers: any other value falls back to en.

General

Key	Default	Description
`Config.Locale`	`'en'`	UI language. `en`, `fr`, `es` ship; drop more in `locales/`. With hz_lib, use `en`, `fr` or `es`.
`Config.Debug`	`false`	Prints language file errors in the console.
`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`	`true`	`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.Brand`	`"No\\|Trace"`	Logo text at the top centre. The part before `\\|` takes the theme colour. `""` hides it.
`Config.ServerName`	`""`	Text next to the Discord icon. Empty = localized "Join the Discord".
`Config.DiscordURL`	`"https://discord.me/hzscript"`	Discord invite opened by the button. Replace it with yours.
`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"`	Fallback tint for the native GTA V Settings menu, used only while no hz_lib theme has been received. The menu itself takes its colours from the hz_lib theme, and so does the native tint once the theme is loaded.
`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.