Installation

Requirements

FiveM server build 6116 or higher
ox_lib (required — callbacks and notifications)
oxmysql (required — queries and auto-migration)
One of: QBCore, QBox, ESX, or standalone mode
A clothing/appearance system (recommended): orb-clothing, illenium-appearance, fivem-appearance or qb-clothing

Download & Extract

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

Remove the Stock Multicharacter

Stop or remove your framework's built-in character selector and spawn resources (e.g. qb-multicharacter and qb-spawn). ORB Multicharacter declares provides { 'qb-multicharacter' }, so other resources that depend on the stock one still resolve.

Configure server.cfg

Dependencies must load first:

cfg

ensure ox_lib
ensure oxmysql
ensure orb-multicharacter

Database

No SQL to import. Tables are handled automatically on first boot:

Standalone — a self-contained orb_characters table is created for you
QBCore / QBox / ESX — your framework's own player and vehicle tables are used as-is

Verify Installation

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

==========================================
  orb-multicharacter v1.0.0
==========================================
  Framework : qbcore
  Clothing  : orb-clothing
  HUD       : qb-hud
  ox_lib    : ok
  oxmysql   : ok
==========================================

If Framework shows standalone on a framework server, your core resource had not started yet — check the order in server.cfg. If Clothing shows none, character creation has no appearance editor to hand off to.

File Structure

orb-multicharacter/
├── bridge/
│   ├── _detect.lua              # Framework / clothing / HUD auto-detection
│   ├── client/
│   │   ├── framework.lua        # Client framework bridge
│   │   ├── hud.lua              # HUD hide & restore
│   │   ├── clothing.lua         # Appearance system hand-off
│   │   └── weather.lua          # Pause / resume the server weather sync
│   └── server/
│       └── framework.lua        # Server bridge + DB migration
├── client/
│   ├── main.lua                 # Orchestrator
│   ├── systems/
│   │   ├── camera.lua           # Preview cameras & glide
│   │   ├── preview.lua          # Character lineup peds
│   │   ├── scenes.lua           # Scene switching, weather & time
│   │   ├── garage.lua           # Garage showroom vehicles
│   │   ├── spawn.lua            # Aerial spawn selector
│   │   └── audio.lua            # SFX & music
│   ├── ui/nui_callbacks.lua     # NUI to Lua callbacks
│   └── utils/math.lua
├── server/
│   ├── main.lua                 # Character callbacks, logout, exports
│   └── buckets.lua              # Routing-bucket isolation
├── locales/                     # Translations (escrow_ignore)
│   ├── en.lua
│   └── es.lua
├── html/                        # NUI
│   ├── index.html
│   ├── config_ui.js             # Colors & fonts (escrow_ignore)
│   ├── style.css
│   ├── script.js
│   ├── music.mp3                # Default background track (escrow_ignore)
│   └── sounds/                  # Drop your own tracks here (escrow_ignore)
├── stream/                      # Custom pose animations & props
├── config.lua                   # Main configuration (escrow_ignore)
└── fxmanifest.lua

Editable Files

The resource ships with escrow encryption. The files listed in escrow_ignore are editable:

config.lua — All settings, scenes, cameras, poses and spawn locations
locales/*.lua — All UI text and notifications
html/config_ui.js — Interface colors and fonts
html/.mp3, html/.ogg, html/sounds/* — Swap the default music track
README.md