Configuration

Server setup lives in config.lua. Players adjust permitted display preferences through /hudedit. Edit existing fields rather than duplicating config tables.

Configuration map

Setting	Purpose
Config.Installer	One-time library/framework/target integration selection
Config.Framework	auto, qbox/qbx, qb, esx, standalone or custom player-data reader
Config.Logo	HUD logo URL
Config.Brand	Pause/dashboard name, image URL and fallback mark
Config.Website / DiscordInvite	Official HTTP/HTTPS links
Config.Chat	Enabled state, key, history/suggestion/fade limits and distances
Config.HudEditor	Command/aliases, access, global saves and player limitations
Config.Interaction	World mode, key, distance, LOS, sizing and target replacement
Config.Fuel / Seatbelt	Status readers and optional belt toggle forwarding
Config.PauseAnimations / PauseNews	On-foot poses and update JSON
Config.UIVisibility	Server-wide component availability
Config.DemoEnabled / DemoCommand	Demo hub availability and command

Branding

Lua

Config.Logo = 'https://your-server.com/logo.png'
Config.Brand = {
    name = 'Your Server',
    logoUrl = 'https://your-server.com/logo.png',
    mark = 'Y'
}
Config.Website = 'https://your-server.com'
Config.DiscordInvite = 'https://discord.gg/yourserver'

The dashboard uses the pause menu's brand. Players cannot change branding through the dashboard. Use images you own or may distribute. Leave Website empty to disable its button.

Theme defaults and keys

Lua

Config.UiTheme = 'cyan'
Config.CustomThemePresets = {
    ocean = { primary = '#38bdf8', primaryRgb = '56, 189, 248' }
}
Config.RadialKey = 'X'
Config.ProgressCancelKey = 'X'
Config.Interaction.defaultInteractKey = 'E'

Standard themes are cyan, blue, green, yellow, orange, red, purple and blackandwhite. A changed default key does not replace an existing player's saved FiveM binding; also update FiveM Settings → Key Bindings.

Production demos

Lua

Config.DemoEnabled = false
Config.DemoCommand = 'fui'

When enabled, /fui opens the hub and /fuiinteract creates/removes a temporary point. Preset recording commands have been removed. The kit does not include graphics/FPS-booster changes.

Config versus dashboard

Pause behavior, integration policy, chat limits, world prompt geometry, hologram/microphone geometry and server availability remain in config. The dashboard exposes only owner-approved display preferences. Restart after config changes; filesystem permissions and patched integration reloads require a full server restart.

See the Config File child page for the current annotated reference. Merge your values into a new version's config rather than replacing its new defaults blindly.