CONFIGURATION#

All configuration is done in a single file: shared/config.lua. This file controls the keybind, behavior, colors, and default menu items for the radial menu.

If you're using QBCore or QBox, your framework-specific menu items are configured separately in the bridge folder. See the Compatibility page for details.

SETTINGS#

shared/config.lua
Config.Settings = {
    toggle = true,
    UseWhilstWalking = false,
    controlsToDisable = { 37, 1, 2, 106, 24 },
    keyBind = 'F1',
    uiHoverEffects = true,
    EditCommand = "editradialmenu",
    ResetCommand = "resetradialmenu",
    color = {
        boxColor = "#ff0039",
        textColor = "#ff0039",
        backBtnColor = "#ff0039",
        ShadowColor = "#ff0039"
    }
}

Setting	Type	Default	Description
`toggle`	boolean	`true`	`true` = press once to open/close. `false` = hold the key to keep the menu open.
`UseWhilstWalking`	boolean	`false`	Allow opening the radial menu while walking or moving.
`controlsToDisable`	table	`{37, 1, 2, 106, 24}`	GTA control IDs to disable while the menu is open. Only applies when `UseWhilstWalking` is `true`.
`keyBind`	string	`'F1'`	Default keybind to open the menu. Players can rebind this in FiveM's keybind settings.
`uiHoverEffects`	boolean	`true`	Enable or disable hover animations on menu items.
`EditCommand`	string	`"editradialmenu"`	Chat command to open the drag-and-drop menu editor.
`ResetCommand`	string	`"resetradialmenu"`	Chat command to reset menu item positions to default.

Controls Reference#

The default controlsToDisable values:

Control ID	Action Disabled
`37`	Weapon wheel
`1`	Looking around
`2`	Moving camera
`106`	Vehicle mouse look behind
`24`	Attack / punch

COLORS#

Customize the radial menu theme by changing hex color values:

shared/config.lua
color = {
    boxColor = "#ff0039",       -- Menu item boxes
    textColor = "#ff0039",      -- Label text
    backBtnColor = "#ff0039",   -- Back button in submenus
    ShadowColor = "#ff0039"     -- Glow / shadow effects
}

All four values accept any valid hex color code (e.g., "#3b82f6" for blue, "#22c55e" for green).

The Config.menuItems table defines the default (static) menu items that appear every time the radial opens. The menu supports up to 6 root items.

Root Item#

shared/config.lua
Config.menuItems = {
    {
        icon = { address = "fa-solid fa-user" },
        label = "My Menu",
        closeRadialMenu = false,
        trigger = {},           -- use {} when the item only opens a submenu
        subMenu = { ... }
    }
}

Sub-Item#

{
    icon = { address = "fa-solid fa-star" },
    label = "My Action",
    closeSubMenu = true,
    closeRadialMenu = true,
    canAccess = function()
        return true             -- return false to hide this item
    end,
    trigger = {
        onSelect = function()
            print('Action triggered!')
        end
    }
}

Full Example#

Adding a custom root item with two sub-items:

shared/config.lua
{
    icon = { address = "fa-solid fa-wrench" },
    label = "My Tools",
    closeRadialMenu = false,
    trigger = {},
    subMenu = {
        {
            icon = { address = "fa-solid fa-hammer" },
            label = "Repair",
            closeSubMenu = true,
            closeRadialMenu = true,
            canAccess = function()
                return IsPedInAnyVehicle(PlayerPedId(), false)
            end,
            trigger = {
                onSelect = function()
                    print('Repairing...')
                end
            }
        },
        {
            icon = { address = "fa-solid fa-gas-pump" },
            label = "Refuel",
            closeSubMenu = true,
            closeRadialMenu = true,
            trigger = {
                event = {
                    name = 'vehicle:refuel',
                    type = 'client'
                }
            }
        }
    }
}

For the full item structure reference (all fields, trigger types, canAccess, nesting), see the Api reference page page.

Default Items#

The resource ships with 6 pre-configured root items:

Slot	Label	Sub-Items
1	Player Actions	Hands Up, Cancel Animation, Point, Crouch
2	Vehicle	Engine, Lock/Unlock, Doors, Seats, Flip Vehicle
3	Clothing	Hat, Glasses, Mask, Top, Gloves, Vest, Bag
4	Emotes	Wave, Sit, Dance, Lean, Cross Arms, Thumbs Up, Salute
5	World	Show Coordinates, Show Heading, Waypoint Info, Delete Waypoint
6	Quick Actions	Screenshot Mode, First Person, Cinematic Mode

You can edit, remove, or replace any of these by modifying the Config.menuItems table.

COMMANDS#

Command	Description
Keybind (default `F1`)	Open or close the radial menu. Players can rebind this in FiveM Settings > Key Bindings.
`/editradialmenu`	Opens the visual editor where you can drag menu items to reposition them.
`/resetradialmenu`	Resets all menu item positions back to their default layout.

The keybind is registered as a FiveM key mapping. Once a player changes it in their settings, the keyBind config value only applies as the initial default for new players.

FRAMEWORK#

The framework is auto-detected at startup. No manual configuration needed.

shared/config.lua
Config.Framework = 'standalone'   -- auto-set to 'qbx', 'qb', 'esx', or 'standalone'

Detected Resource	Framework Value	Description
`qbx_core`	`'qbx'`	QBox framework
`qb-core`	`'qb'`	QBCore framework
`es_extended`	`'esx'`	ESX framework
(none)	`'standalone'`	No framework, uses native GTA5 functions

Do not manually set Config.Framework. The detection runs automatically based on which resources are started on your server.

SHOPPING CART