QBOX Framework - Complete Guide
Overextended (Ox) is the modern baseline for FiveM servers. This guide shows you how to install, configure, and safely migrate to ox_inventory, ox_lib, ox_target, and oxmysql. You’ll get copy‑pasteable code, opinionated defaults, and battle‑tested patterns for UI, interactions, and data. Includes playbooks for qb-inventory → ox_inventory and mysql-async → oxmysql. Back up your server and database before any change.
This guide is part of our complete FiveM frameworks guide, where we compare ESX, QBCore, and QBOX in depth and help you choose the right one.
TL;DR: Which Ox component for what?
| Component | Purpose | Core APIs | Typical Use | Migration Path | Common Gotchas |
|---|---|---|---|---|---|
| ox_inventory | Inventory & items, stashes, shops | AddItem, RemoveItem, RegisterStash, RegisterShop | Player items, job stashes, vendor shops | qb-inventory → ox_inventory | Wrong item schema, duplicate invs running, missing ensure order |
| ox_lib | Utilities, UI, helpers | addCommand, registerContext/showContext, inputDialog, progressBar, zones/points | Menus, prompts, rate‑limits, zone logic | N/A | Mixing UI libs, not awaiting callbacks |
| ox_target | Interaction targeting | addBoxZone, addSphereZone, addEntity, addModel | Eye targets on props/peds/zones | qtarget → ox_target (optional) | Overlapping zones, missing job conditions |
| oxmysql | MySQL driver | query, single, scalar, insert, prepare, transaction | DB persistence, leaderboards, audits | mysql-async → oxmysql | Unindexed queries, unsafe string concat |
Tip: Start with oxmysql and ox_lib, then migrate inventory and target. Validate each step on a staging server.
Related: https://vertexmods.com/frameworks/ · https://vertexmods.com/en/blog/converting-fivem-scripts
Stay in the Loop
Get the latest FiveM tutorials, mod releases, and exclusive updates delivered to your inbox.
No spam. Unsubscribe anytime.