Lumo Inventory

Slot inventory with stashes, trunks, shops, crafting, equipment bays and physical drops.

Version 1.0.3 · Frameworks QBCore · Qbox · ESX · standalone · Requires oxmysql

Installation · Config files · Exports & events · Changelog

A slot inventory with a glass-style React interface: stashes, trunks and gloveboxes, shops and vending, crafting, equipment bays (backpack, armor, phone, radio), physical item drops you can hold, throw and place, and a levelling system.

QBCore · Qbox · ESX · Standalone (detected automatically) · by Lumo · https://lumo-server.tebex.io/

Version 1.0.0 · one folder, no lumo-bridge or any other Lumo resource needed · open source (GPL-3.0)

---

Features

• Slot inventory with weight and slot limits, hotbar (1–5), drag and drop, split, lock, sort and quick actions
• Equipment bays: backpack (extra slots and weight), plate carrier with armor plates, phone, radio and gadget slots
• Physical drops: hold, throw (native aim) and place items in the world with a live preview; every item has a real prop, bulky items are carried in both arms
• Give with a visible recipient picker and a hand-off animation
• Stashes, trunks, gloveboxes, shops and vending machines
• Crafting with recipes, levels and blueprints; experience and levels with rewards
• Weapons: works with qb-weapons on QBCore, and has its own built-in weapon handler everywhere else (equip, ammo items, ammo saved per weapon, wear, grenades and other throwables)
• Food, drink, alcohol and healing items work out of the box (esx_status on ESX)
• Credentials: ID card, driver's and firearms licence shown as cards
• ESX: replaces ESX's inventory functions, so every ESX script (xPlayer.addInventoryItem, removeInventoryItem, addWeapon …) uses this inventory unchanged. Existing ESX items and weapons are copied in once.
• Qbox: ships an ox_inventory compatibility resource, so qbx_core and ox scripts run on top of it, with ~45 ready shops (24/7, Ammu-Nation, job armouries)
• Shops with rules: weapon licence, job/gang, grade and on-duty checks on every purchase; ESX licences come from esx_license
• Standalone: built-in item list, free shops or your own money hooks
• Drop-in for qb-inventory: same events, exports and database tables, plus an optional qb-inventory name shim for old scripts
• Tables created automatically on first start

Requirements

Resource	Needed?
oxmysql	Required
qb-core / qbx_core / es_extended	Optional, detected automatically (standalone works too)
ox_lib	Recommended on Qbox, ESX and standalone (progress bars, prompts). Required on Qbox
ox_target / qb-target / qtarget	Optional. Without one, drops and vending use an [E] prompt
qb-weapons	Optional (QBCore). Without it, the built-in weapon handler is used
lumo-ui	Optional. Adds the key hints strip and HUD theme sync

Installation (short version)

1. Put the lumo-inventory folder in your resources folder.
2. Stop the inventory you are replacing (qb-inventory, ps-inventory, ox_inventory, ESX's esx_inventory / esx_inventoryhud, …). Only one inventory may run. On ESX keep esx_addoninventory: it is the job and property storage, not a player inventory.
3. In server.cfg, after oxmysql and your framework:

   ensure oxmysql
   ensure ox_lib             # recommended; required on Qbox
   ensure qb-core            # or qbx_core / es_extended / nothing
   ensure lumo-inventory

4. Start the server. The console shows:

   [lumo-inventory] player items are stored in ...
   [lumo-inventory] ready — framework: qb, version 1.0.0

Qbox needs one extra step (the ox_inventory shim) and ESX has a few notes. Full step-by-step guide for every framework: Installation.

Controls and commands

Key / command	Who	What
TAB	Everyone	Open the inventory (Config.Keybinds.Open)
Z	Everyone	Show the hotbar (Config.Keybinds.Hotbar)
1–5	Everyone	Use the item in that hotbar slot
/giveitem [id] [item] [amount]	Admin	Give an item
/clearinv [id]	Admin	Clear a player's inventory
/givexp [id] [track] [amount]	Admin	Grant experience
/invdebug [id]	Admin	Show framework and where items are stored
/testkit	Admin	Fill your equipment bays to try the features
/randomitems	God	Ten random items

Keys can be rebound by players in GTA's key binding settings (FiveM section). Admin permission: QBCore/Qbox admin/god, ESX admin/superadmin, standalone the ACE group (add_principal identifier.license:… group.admin).

Configuration

• config/config.lua: weights, slots, keybinds, drops, consumables, weapons, crafting, equipment, vending, ESX options, extra items.
• bridge/config.lua: framework detection and standalone money/job hooks. Most servers never touch it.
• shared/items.lua: the built-in item list (standalone, and pictures for ESX).
• Item pictures: html/images/<item>.png.

Documentation

• Installation: installation per framework, items, test checklist
• Standalone: running without a framework
• Features: drops, throwing, give, overflow, weapons
• Integration: exports and events for developers, experience system
• Back items: items shown on the character's back
• Support: troubleshooting and support
• Compat Qb Inventory (in the download): the old-name shim

License

lumo-inventory is a modified version of qb-inventory from the QBCore Framework (Copyright (C) 2021 Joshua Eger, https://github.com/qbcore-framework/qb-inventory). Like the original it is free software under the GNU General Public License v3.0 (see LICENSE): you may use, study, change and share it, and anything you distribute that is based on it must stay under the GPL with its source. The built-in item list is based on QBCore's shared/items.lua (GPL-3.0). Lumo's changes and additions are released under the same licence.