Using ox_inventory

ESX Legacy works with ox_inventory out of the box. Start ox_inventory after es_extended, and es_extended detects it, switches to its built-in ox bridge and forwards the usual xPlayer inventory and cash functions to ox_inventory. You do not edit Config.CustomInventory. Items, weapons and stashes are then managed by ox_inventory, not by ESX.

OverviewCopy Anchor Link

• Bridge files: es_extended/server/bridge/inventory/oxinventory.lua and es_extended/server/classes/overrides/oxinventory.lua
• Detection: shared/config/main.lua, below the "DO NOT CHANGE" line
• Requires: oxmysql, ox_lib (required by ox_inventory itself), esx_lib, es_extended
• Official ox_inventory docs: overextended.dev/ox_inventory

How ESX detects ox_inventoryCopy Anchor Link

The detection is one block at the bottom of the main config:

if GetResourceState("ox_inventory") ~= "missing" then
    Config.CustomInventory = "ox"
end

Config.EnableDefaultInventory = Config.CustomInventory == false -- Display the default Inventory ( F2 )

So ESX switches to ox mode whenever the ox_inventory folder exists in your resources, even if you never ensure it. In ox mode, es_extended also:

• sets Config.OxInventory = true (a backwards-compatibility flag that older scripts still read)
• sets the replicated convars inventory:framework to esx and inventory:weight to Config.MaxWeight * 1000
• skips ESX.RefreshItems() at startup and loads the item list from ox_inventory instead
• does not register the ESX inventory commands (/giveitem, /giveweapon, /giveammo, /giveweaponcomponent, /refreshitems, /clearinventory, /clearloadout)
• disables the default F2 inventory

Set up ox_inventory with ESXCopy Anchor Link

ensure oxmysql
ensure ox_lib
ensure esx_lib
ensure es_extended
ensure ox_inventory
ensure [core]
ensure [esx_addons]

setr inventory:framework "esx"
setr inventory:accounts '["money", "black_money"]'

['coffee'] = {
    label = 'Coffee',
    weight = 200,
    stack = true,
    close = true,
},

What changes for your scriptsCopy Anchor Link

The xPlayer API stays the same for the common calls. The ox override routes them to ox_inventory exports:

Note the extra metadata and slot parameters, which exist only in ox mode. Code written for the default ESX inventory keeps working because the extra parameters are optional.

local xPlayer = ESX.GetPlayerFromId(source)

if xPlayer.canCarryItem('coffee', 1) then
    xPlayer.addInventoryItem('coffee', 1)
end

-- Works in both modes: hasItem returns false when the player has none
if xPlayer.hasItem('lockpick') then
    -- ...
end

Money with ox_inventoryCopy Anchor Link

With the default inventory:accounts, cash (money) and black_money are inventory items. xPlayer.addMoney, removeMoney and getAccount('money') still work because ESX syncs the item count back into the player's accounts. Unlike the default ESX mode, the ox versions of the account methods return false instead of throwing an error for an invalid account name or amount. Check the return value. See Money and accounts.

Usable itemsCopy Anchor Link

ESX.RegisterUsableItem still stores the handler in ox mode. How an item is used, and whether it is removed, is decided by ox_inventory's item definition (consume, client, server.export). Check the ox_inventory item docs when you port usable items, and test each one. For new scripts, defining the use behavior in data/items.lua with a server.export is the most direct option:

['coffee'] = {
    label = 'Coffee',
    weight = 200,
    server = {
        export = 'mycafe.useCoffee',
    },
},

WeaponsCopy Anchor Link

Weapons are items in ox_inventory. Scripts that give weapons with xPlayer.addWeapon silently do nothing in ox mode. Replace those calls with xPlayer.addInventoryItem('WEAPON_PISTOL', 1) or the ox_inventory exports.

Moving from the ESX inventory to ox_inventoryCopy Anchor Link

Common issuesCopy Anchor Link

• No inventory at all: the ox_inventory folder exists but is not started, so ESX is in ox mode without an inventory. Start ox_inventory or remove the folder.
• ox_inventory errors about the framework on start: it started before es_extended. Fix the order in server.cfg.
• /giveitem does nothing or is unknown: in ox mode ESX does not register its inventory commands. Use the ox_inventory admin commands instead.
• Cash shows 0 after switching: money is now an item. Old balances stay in users.accounts until a conversion moves them. Starting money for new players is given as an item from Config.StartingAccountMoney for accounts that are in inventory:accounts.
• Weapon shop or job armory gives nothing: the script uses xPlayer.addWeapon. Change it to items.
• Scripts checking Config.OxInventory: still works, ESX sets it from Config.CustomInventory == "ox". New code can check ESX.GetConfig('CustomInventory') == 'ox' on the client.

RelatedCopy Anchor Link

• esx_inventory (default inventory)
• Add items
• Money and accounts
• Main config
• xPlayer reference

Frequently asked questions