Installation

Requirements

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

Download & Extract

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

Dependencies

Install these resources if you don't have them:

ox_lib — Download from GitHub
oxmysql — Download from GitHub

Configure server.cfg

cfg

ensure ox_lib
ensure oxmysql
ensure orb_clothing

Ensure ox_lib and oxmysql load before orb_clothing.

Database Setup

The database table is created automatically on first startup. No manual SQL import is required.

If you prefer to create the table manually, a database.sql file is included:

sql

CREATE TABLE IF NOT EXISTS character_appearance (
    id INT(11) NOT NULL AUTO_INCREMENT,
    identifier VARCHAR(60) NOT NULL,
    appearance LONGTEXT DEFAULT NULL,
    hair LONGTEXT DEFAULT NULL,
    clothing LONGTEXT DEFAULT NULL,
    props LONGTEXT DEFAULT NULL,
    tattoos LONGTEXT DEFAULT NULL,
    created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (id),
    UNIQUE KEY identifier (identifier)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Verify Installation

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

======================================
  orb_clothing v1.0.0
======================================
  Framework : qbcore
  HUD       : hud_apx
  Target    : ox_target
  Clothing  : illenium-appearance
  ox_lib    : ok
  oxmysql   : ok
======================================

File Structure

orb_clothing/
├── bridge/
│   ├── _detect.lua              # Auto-detection (framework, HUD, target, clothing)
│   ├── client/
│   │   ├── framework.lua        # Player data & load events
│   │   └── hud.lua              # HUD hide/show (8+ systems)
│   └── server/
│       └── framework.lua        # Identity, jobs, permissions, skin mirroring, DB
├── client/
│   ├── main.lua                 # Entry point, creator logic
│   ├── admin/                   # Admin panel UI & logic
│   ├── store/                   # Store zones, blips, interaction
│   ├── systems/                 # Appearance, camera, clothes, hair, tattoos
│   ├── ui/                      # NUI callbacks
│   └── utils/                   # Data cache, validation
├── server/
│   ├── main.lua                 # Save/load, routing buckets
│   ├── load.lua                 # Initial data loading
│   ├── admin/                   # Admin commands & storage
│   └── store/                   # Store proximity validation
├── config.lua                   # Main configuration (escrow_ignore)
├── shared/
│   ├── tattoo_data.lua          # Tattoo definitions (escrow_ignore)
│   └── ped_models.lua           # Ped model list (escrow_ignore)
├── data/
│   └── admin_stores.json        # Admin-created stores (escrow_ignore)
├── html/                        # NUI interface
└── database.sql                 # Schema reference

Editable Files

The resource ships with escrow encryption. Only the files listed in escrow_ignore can be edited — everything else is protected. The editable files are:

config.lua — All settings, store locations, pricing
shared/tattoo_data.lua — Tattoo zone definitions
shared/ped_models.lua — Ped model list
data/admin_stores.json — Admin-created store data
database.sql — Schema reference
html/config_ui.js — UI colors, fonts, and theming
html/assets/.svg, html/assets/.png — Icons and images
locales/*.lua — All translatable text