Studios
Inventory Addonshouse-3.jpg

Installation

SoonInventory AddonsQbox
PAGE 02 OF 06  ·  OVERVIEW → INSTALLATION → CONFIGURATIONdocs.glitchstudios.dev
Browse docs

Requirements#

The server

Framework qbx_core (Qbox). ESX and plain QBCore are not supported.
Resources ox_lib, ox_inventory
Tested with qbx_core 1.24.0, ox_lib 3.40.0 and ox_inventory 2.48.0 with the pinkfrog.io redesign and the hooks from install/ox_inventory/
Server FiveM artifact with OneSync enabled
Database None

For the inventory UI panels

Inventory redesign The pinkfrog.io ox_inventory redesign, bought from pinkfrog.io. You need your own copy. It was tested with their release for ox_inventory 2.48.0.
Glitch Studios hooks The files in install/ox_inventory/ (GPL-3.0). That folder's README lists every edit by file, function and stock line.

Optional. Each one is detected at run time. When it is not running, the feature that uses it is skipped.

Appearance illenium-appearance, or a fork such as glitch-appearance that exports getPedAppearance. Saves the look after every dress and undress, and turns clothing shop purchases into items.
Key hint HUD glitch-uiElements, for key hints while throwing and placing. Without it the ox_lib text UI shows the keys.
ID cards qbx_idcard or um-idcard, for showing cards from the wallet.
Medical A medical resource that sets an injury state bag and exports GetInjuryBpm, such as glitch-ambulancejob. qbx_medical or a resource built on it clears the body scan on heal and revive.
Buffs and HUD A buff resource that sets a carry weight state bag (glitch-buffs), and a HUD that reads the hud_weight state bag (glitch-hud).
Radial menu qbx_radialmenu with a clothing patch, so /mask, /shirt and similar commands can move the real items.

The glitch-* names are other Glitch Studios resources that the config names as defaults. You need none of them. Replace them with your own resources or set them to false.

Installation steps#

  1. Install ox_inventory and check that it starts on its own. For the UI panels, install the pinkfrog.io redesign and apply install/ox_inventory/ now.

  2. Copy the glitch-inventoryAddons folder into your resources folder. The folder name is case-sensitive and must stay glitch-inventoryAddons, because the inventory hooks call this resource's exports by that name.

  3. Add the items. install/items.lua has every item the resource uses (clothing, backpacks, outfit bag, plates, ammo boxes and the wallet). Copy them into ox_inventory/data/items.lua. The same file shows the container entry the wallet needs in ox_inventory/modules/items/containers.lua. The package ships no SQL and no item images.

  4. Set the slot count in server.cfg and start the resource after its dependencies:

    setr inventory:slots 62
    
    ensure ox_lib
    ensure qbx_core
    ensure ox_inventory
    ensure glitch-uiElements
    ensure glitch-inventoryAddons
    

    Pockets use slots 1 to 42, backpack slots are 43 to 49 and clothing is 50 to 62. If you change the layout, change Config.clothesAsItems and Config.enableBackPackSettings to match. Leave out glitch-uiElements if you do not run it.

  5. Edit shared/config.lua. Set the optional integrations you do not run to false, and check the item names in Config.ammoBoxes and Config.wallet against your items.

  6. If you run an anticheat that ships a net event guard include, add it as the first server_script in fxmanifest.lua, for example server_script '@my-anticheat/guard/server.lua'.

  7. Restart the server and open the inventory. A few seconds after login, the clothing slots fill with what the ped is wearing.

The resource registers no admin commands, so there are no ACE permissions to add.

Moving from an older slot layout#

If your players had more slots than the layout needs (for example inventory:slots 64), keep the convar where it was. Config.retiredSlots = 'auto' treats every slot after the last clothing slot as retired. Those slots take nothing new, and anything still in them moves into the pockets at login, or drops at the player's feet when the pockets are full. With inventory:slots 62 there are no retired slots.

Updating#

Back up shared/config.lua, shared/gloves.lua, shared/weaponStats.lua and client/custom/client_editable.lua, then replace the folder and merge your changes into the new files. Compare install/items.lua and install/ox_inventory/ with what you installed, since a new version can add items and hooks. Restart ox_inventory first, then glitch-inventoryAddons.