Configuration
All configuration is in config.lua.
General Settings
| Setting | Type | Default | Description |
|---|---|---|---|
Config.Framework | string | 'esx' | Framework: 'esx', 'qb', or 'qbx' |
Config.Keybind | string | 'F1' | Key to open the radial menu |
Config.ToggleMode | boolean | true | true = press to toggle, false = hold to keep open |
Config.PrimaryColor | string | '#FF0000' | Hex color for the menu theme |
Menu Items
Define items in Config.MenuItems:
Config.MenuItems = {
{
id = 'garage',
label = 'Garage',
icon = 'fas fa-warehouse',
type = 'event',
event = 'garages:open',
args = {},
shouldClose = true,
},
}Item Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Unique identifier |
label | string | Yes | Display text |
icon | string | Yes | FontAwesome icon class (e.g. 'fas fa-home') |
type | string | Yes | Action type (see below) |
shouldClose | boolean | No | Close menu after selection (default: true) |
job | string | No | Restrict to a specific job |
gang | string | No | Restrict to a specific gang |
Action Types
| Type | Fields | Description |
|---|---|---|
event | event, args | Trigger a client event |
server-event | event, args | Trigger a server event |
command | command | Execute a command |
function | func | Call a Lua function |
submenu | items | Open a nested submenu |
Submenu Example
{
id = 'vehicle',
label = 'Vehicle',
icon = 'fas fa-car',
type = 'submenu',
items = {
{
id = 'engine',
label = 'Toggle Engine',
icon = 'fas fa-power-off',
type = 'event',
event = 'vehicle:toggleEngine',
shouldClose = true,
},
{
id = 'doors',
label = 'Lock/Unlock',
icon = 'fas fa-lock',
type = 'event',
event = 'vehicle:toggleLock',
shouldClose = true,
},
},
}Job/Gang Restricted Items
{
id = 'police_menu',
label = 'Police Menu',
icon = 'fas fa-shield-halved',
type = 'submenu',
job = 'police',
items = { ... },
}Items with job or gang fields are only shown to players with the matching job or gang.
Last updated on