SHOPPING CART

Onex

Command Palette

Search for a command to run...

INSTALLATION#

This page walks you from download ➜ placement ➜ startup order ➜ framework setup for Onex Creation - the ultimate character creation and clothing system.

ASSET DOWNLOAD#

  1. Go to the CFX Portal (Keymaster)
  2. Navigate to Granted Assets section
  3. Locate onex-creation in your asset list
  4. Click Download to get the latest version
  5. Extract the downloaded archive to a temporary location

ASSET DEPENDENCIES#

REQUIRED DEPENDENCIES:

The following resources must be installed and started before onex-creation:

DependencyDescriptionRequired
ox_libOverextended library for UI and utilitiesYes
onex-baseOnex framework core moduleYes
onex-interactionInteraction system for shop zonesYes
oxmysqlDatabase connector (for outfit storage)Yes

Missing dependencies will cause the script to fail on startup. Ensure all required dependencies are properly installed first.

DATABASE SETUP#

Import the SQL schema into your database to enable the outfit saving system:

SQL.sql
CREATE TABLE IF NOT EXISTS `player_outfits` ( `id` int(11) NOT NULL AUTO_INCREMENT, `identifier` varchar(46) DEFAULT NULL, `outfitname` varchar(50) NOT NULL DEFAULT '0', `description` varchar(50) DEFAULT NULL, `skin` longtext DEFAULT '{}', `code` varchar(50) DEFAULT NULL, PRIMARY KEY (`id`) );

This table stores player outfits with shareable codes. The code field enables outfit sharing between players.

UPDATE ARTIFACTS & GAME BUILD#

Ensure your server is running compatible versions:

Minimum Requirements:
ComponentMinimum Version
Server Artifacts7290+
Game Build2944+ (for latest DLC clothes)

To update your game build, add this to your server.cfg:

server.cfg
set sv_enforceGameBuild 2944

Find all available game build versions in the FiveM Server Commands Documentation.

ASSET POSITIONING#

Place the resource folder in your server's resources directory, then configure your server.cfg:

server.cfg
# Dependencies (start these first) ensure ox_lib ensure onex-base ensure onex-interaction # Main resource ensure onex-creation

The startup order is critical! Dependencies must load before onex-creation or the script will fail.

FRAMEWORK COMPATIBILITY#

SUPPORTED FRAMEWORKS:

onex-creation supports multiple frameworks with automatic detection:

FrameworkSupport LevelAuto-Detect
QBCoreFullYes
ESXFullYes
StandaloneFullYes
CustomTemplateManual
REPLACES THESE SCRIPTS:

onex-creation provides full compatibility and replaces:

  • esx_skin
  • skinchanger
  • qb-clothing
  • fivem-appearance
  • illenium-appearance

You can safely remove the above scripts from your server. onex-creation handles their events and exports for seamless integration.

VERIFY INSTALLATION#

After starting your server, verify the installation:

  1. Check server console for any errors
  2. Use the /acreation command (requires admin permissions)
  3. Visit any configured shop zone to test interaction

CALIBRATION & PREVIEWS#

After basic installation, set up clothing collections and preview images:

For servers with addon clothes:

  1. Run /clothescallibrateall to calibrate all clothing items
  2. Record preview images using /clothesstudio or /shootclothes

For servers with only default clothes:

  1. Download pre-recorded previews (link in !ReadMe.md)
  2. Extract to onex-creation/previews/ folder

See Collections & Calibration and Preview Images for detailed guides.

Next Steps#