Configuration is located in shared/config.lua. The file is open-source (escrow_ignore).
Framework
Variable
Type
Default
Description
Config.Framework
string
"newesx"
Framework in use. Accepted values: esx, newesx, oldqb, newqb
Command
Variable
Type
Default
Description
Config.Command
string
"pauseMenu"
Command name used to open the menu (also registered as key mapping)
Config.CommandDescription
string
"Open Pause Menu"
Description shown in the key bindings settings
Behavior
Variable
Type
Default
Description
Config.OpenDead
boolean
true
Whether dead players can open the pause menu
Config.DisableMap
boolean
true
If true, the native pause menu (P / ESC) is disabled — the menu only opens via the configured command
Config.ExitMessage
string
"Thanks for playing!"
Message shown to the player when they leave the server via the exit button
Money (QBCore only)
Variable
Type
Default
Description
Config.MoneyItem.enabled
boolean
false
Use an item as the cash representation instead of the cash money type
Config.MoneyItem.item
string
"cash"
Item name to read the cash amount from
Config.MoneyItem only applies when using a QBCore framework (oldqb or newqb).
Police
Variable
Type
Default
Description
Config.PoliceJobs
table
{ "police" }
List of job names considered as police
Config.PoliceRequired
number
1
Minimum number of police on duty for PoliceAvailable to be true in the NUI
Social links
Variable
Type
Description
Config.Discord
string
Discord invite URL shown in the menu
Config.Website
string
Website URL shown in the menu
Config.Twitter
string
Twitter profile URL shown in the menu
Config.Instagram
string
Instagram profile URL shown in the menu
Config.Youtube
string
YouTube channel URL shown in the menu
Animation
Variable
Type
Default
Description
Config.EnableAnim
boolean
true
Play a tablet animation when the menu is opened
Config.PropName
string
"prop_cs_tablet"
Prop spawned during the animation. Alternative: "prop_tourist_map_01"
Custom NUI data
Variable
Type
Default
Description
Config.CustomNUIData
boolean
false
If true, the SendNUIData() function in custom/client.lua is called instead of the default data sender
Config.ExtraData
table
{}
Additional key-value pairs sent to the NUI under the other field when Config.CustomNUIData is false
Enable Config.CustomNUIData when you need to send data the default handler does not cover (e.g. extra wallet types, custom fields). See the Custom page for implementation details.