Installation

Requirements

FiveM server build 6116 or higher
ox_lib (required)
One of: QBCore, QBox, ESX, or standalone mode

Download & Extract

01Download orb_customs from your Tebex purchase dashboard
02Extract the archive into your server's resources/ directory
03Ensure the folder is named orb_customs

Dependencies

Install these resources if you don't have them:

ox_lib — Download from GitHub

ox_lib is the only hard dependency. Framework detection is automatic.

Configure server.cfg

Add the following to your server.cfg, ensuring dependencies load first:

cfg

ensure ox_lib
ensure orb_customs

Verify Installation

After starting the resource, check your server console for the startup banner:

=============================================
  orb_customs v1.0.0
=============================================
  Framework  : qbcore
  ox_lib     : ok
=============================================

If framework shows standalone, the script will still work but all modifications will be free (no economy integration). If ox_lib shows MISSING, the script will not function correctly.

File Structure

orb_customs/
├── bridge/
│   ├── _detect.lua              # Auto-detection & locale loader
│   └── server/
│       └── framework.lua        # Framework bridge (QBCore/QBox/ESX/Standalone)
├── client/
│   ├── init.lua                 # Keybind & gamepad setup
│   └── modules/
│       ├── menu.lua             # Main UI logic & purchase flow
│       ├── vehicle.lua          # Vehicle mod retrieval & application
│       ├── camera.lua           # Dynamic 3D camera system
│       ├── polyzone.lua         # Zone detection & blips
│       ├── store.lua            # Client state management
│       ├── filter.lua           # Category filtering
│       └── utils.lua            # NUI communication
├── server/
│   └── main.lua                 # Economy callbacks & routing buckets
├── data/                        # All configurable data (escrow_ignore)
│   ├── config.lua               # Main configuration
│   ├── categories.lua           # Menu categories & pricing
│   ├── colors.lua               # 500+ paint colors
│   ├── decals.lua               # Body modifications
│   ├── horns.lua                # Horn options
│   ├── performance.lua          # Performance upgrades
│   ├── stance.lua               # Stance parameters
│   ├── wheels.lua               # Wheel types
│   └── chameleon/               # GTA chameleon paint meta files
├── locales/                     # Translations (escrow_ignore)
│   ├── en.lua
│   └── es.lua
├── web/                         # React NUI (compiled)
│   ├── build/                   # Production build
│   └── src/                     # Source (TypeScript + React)
├── stream/                      # Vehicle texture assets
└── fxmanifest.lua

Editable Files

The following files are not escrowed and can be freely edited:

data/*.lua — All configuration, pricing, colors, locations
locales/*.lua — All UI text and notifications