Skip to main content

Installation

Step-by-step installation guide for Code9 Multicharacter

This section

Installation

Requirements

DependencyRequired?Notes
oxmysql / mysql-async / ghmattimysqlYes (one)Database driver
FiveM Server 5848+YesMinimum artifact version
es_extended / qb-core / qbx_coreYes (one)Framework — auto-detected
Skin scriptYes (one)Any supported skin script for character creation
screenshot-basicOptionalFor profile photo feature
qb-apartmentsOptionalFor apartment-based spawn locations

Steps

1. Extract Resource

Extract the code9_multichar folder into your server's resources/ directory.

2. Add to server.cfg

ensure oxmysql
ensure code9_multichar

3. Database Setup — Automatic

As of v1.0.1 no manual SQL import is needed. All tables (multichar_music, multichar_purchases, multichar_slots) are created automatically when the resource starts, and the settings column is added to your framework's player table (players for QB/QBox, users for ESX).

Existing installations are repaired automatically too — e.g. the old multichar_music.license INT column is migrated to VARCHAR on start.

4. QBox (qbx_core) Only — Required

QBox ships with a built-in character system that must be disabled. Open qbx_core/config/client.lua and set:

lua
useExternalCharacters = true,

5. qb-apartments

If you do not use qb-apartments, delete this line from fxmanifest.lua:

lua
'@qb-apartments/config.lua', -- You need to delete this if you don't use qb-apartments.

6. Configure

Edit shared/config.lua to set your character slots, spawn locations, backgrounds, poses, starter items, loading screen (Config.LoadingTime, Config.LoadingLogo) and skin script preferences.

7. Start Server

Restart your server. The multicharacter screen appears automatically when players connect.