Configuration

All settings are in config.lua, the only file that is not escrow-protected. Each option is commented in the file itself.

General

Option	Default	Description
Config.Locale	'en'	Language of the interface: 'en' or 'es'
Config.Framework	'auto'	'auto', 'esx', 'qb', 'qbx' or 'none'
Config.Inventory	'auto'	'auto', 'ox', 'qb', 'esx' or 'native'
Config.Key	'TAB'	Default key. Each player can change it in the FiveM key bindings
Config.AutoConfigureInventory	false	ox_inventory: apply the recommended settings automatically

Behaviour

Option	Default	Description
Config.TapTime	200	Milliseconds within which a release counts as a tap
Config.QuickHolster	true	A tap holsters the weapon in hand and draws it again
Config.WeaponAnimations	false	Play ox_inventory’s holster and draw animations (up to 1.4 s each)
Config.MouseSensitivity	2.5	How quickly the mouse moves the selection
Config.Scale	1.0	Size of the wheel. 0.8 is 20 % smaller
Config.Blur	false	Blur the game behind the wheel
Config.ZIndex	999	Draw the wheel above other resources’ interfaces

Weapons

Option	Default	Description
Config.HideNativeWheel	true	Hide and disable GTA’s own weapon wheel
Config.ShowUnarmed	true	Include Unarmed in the melee section
Config.ShowEmptyCategories	true	Show sections without weapons, greyed out
Config.Categories	GTA layout	Sections and the GTA weapon groups they contain
Config.WeaponCategory	{}	Move individual weapons to another section
Config.Images	nil	Override the path of weapon and item icons

Items and containers

Option	Default	Description
Config.Items	true	Enable the item wheel
Config.ItemCategories	8 categories	Which items belong to each category
Config.ItemBlacklist	money items	Items that never appear in the wheel
Config.Actions	all enabled	{ use = true, give = true, drop = true }
Config.GiveDistance	3.0	Maximum distance, in metres, to give an item
Config.Containers	true	Trunk, glovebox and ground tab
Config.ContainerWeaponsCategory	'ammo'	Category that groups stored weapons, shown as Weapons & ammo. false to disable
Config.Hotbar	true	Show the 1-5 hotbar
Config.HotbarTime	5	Seconds the hotbar stays visible after closing the wheel

Notifications and sound

Option	Default	Description
Config.NotifyPosition	'top-right'	'top-right', 'top-left' or 'top-center'
Config.NotifyTime	4	Seconds a notification stays on screen
Config.Notify	nil	Your own notification function (see below)
Config.Sounds	true	Interface sounds
Config.SoundVolume	0.12	Volume, from 0.0 to 1.0
Config.CanOpen	death and busy checks	Your own conditions before opening (see below)

Item categories

An item is placed in the first category that lists its name in items or whose patterns match it. Patterns are Lua patterns applied to the lowercase item name. Items that match no category go to the last one, so keep a general category at the end.

config.lua

{ id = 'medical', items = { 'bandage', 'medikit', 'my_medkit' }, patterns = { 'bandage', 'med' } },

To rename a category, or to name a category you add, set label. Without it, the text comes from the selected language:

config.lua

{ id = 'drugs', label = 'Drugs', items = { 'weed', 'coke' }, patterns = { '^weed', 'coke' } },

Weapon sections accept label as well.

Weapon sections

Each section lists GTA weapon groups. To move a single weapon without changing the groups:

config.lua

Config.WeaponCategory = {
    ['WEAPON_FLAREGUN'] = 'throwables',
}

Conditions before opening

Config.CanOpen runs every time the key is pressed. Return false to prevent the wheel from opening, for example with your own death or handcuff systems:

config.lua

Config.CanOpen = function()
    local state = LocalPlayer.state
    if state.dead or state.isDead or state.invBusy then return false end
    if state.handcuffed then return false end
    return true
end

Notifications

The wheel includes its own notifications. To use your server’s notification system instead, define Config.Notify. It receives the message, the type ('success', 'warning', 'error' or 'inform') and, when the message refers to an item, its name:

config.lua

Config.Notify = function(message, kind, item)
    exports.ox_lib:notify({ description = message, type = kind })
end

Icons

Icons are taken from the inventory’s own image folder. If your images are elsewhere, set the path, where %s is the item or weapon name:

config.lua

Config.Images = 'nui://my-inventory/html/images/%s.png'

Language

The interface is available in English and Spanish through Config.Locale. Category names can be changed with label, as shown above. For another language, contact us on Discord.