Installation

RequirementsLink copied

Supported frameworks: ESX Legacy (es_extended), QBCore (qb-core), Qbox (qbx_core), and ox_core (ox_core).

Optional resources

Resources to removeLink copied

SC Multicharacter takes over character select and identity. These resources do the same job and must be disabled:

• esx_multicharacter
• esx_identity on ESX
• qb-multicharacter
• ox_multicharacter
• fivem-multicharacter, multicharacter, and any other character select

Escrow and downloadLink copied

SC Multicharacter is protected by FiveM Asset Escrow. The logic only runs on servers whose license key belongs to the Cfx.re account that bought it.

Everything you should be able to change is excluded from encryption. See the editable files table in Multicharacter.

1. 1

   Sign in to the Cfx.re portalLink copied

   Open portal.cfx.re (opens in a new tab) and sign in with the account that bought the resource.

2. 2

   Open Granted AssetsLink copied

   Go to Assets - Granted Assets. You will find sc_multicharacter there.

3. 3

   Download the packageLink copied

   Click Download to get the ready ZIP.

4. 4

   Check the server keyLink copied

   sv_licenseKey in server.cfg must come from the same account. A key from another account is the most common escrow error.

Common escrow errors

Install the resourceLink copied

1. 1

   Remove the old character selectLink copied

   Stop and remove every character select and identity resource listed above.

2. 2

   Upload the resourceLink copied

   Extract the package into resources, for example resources/[core]/.

3. 3

   DatabaseLink copied

   You do not need to import anything. With Config.AutoFixDatabase = true, the resource creates its tables and missing columns on start.

   To do it manually, import sql/install.sql and set Config.AutoFixDatabase = false. See Database.

4. 4

   Add it to server.cfgLink copied

   Start sc_multicharacter after oxmysql and your framework, but before resources that depend on a loaded character.

   ESXQBCoreQboxox_core

   ensure oxmysqlensure ox_libensure es_extendedensure skinchangerensure esx_skinensure sc_multicharacter

5. 5

   Admin permissionsLink copied

   add_ace group.admin sc_multicharacter.admin allowadd_ace group.admin sc_multicharacter.setslots allow

   See Commands and Permissions for per-command access.

6. 6

   Framework settingsLink copied

   Some frameworks need one change, for example Config.Multichar = true on ESX. See Framework Setup.

7. 7

   Basic configurationLink copied

   Open config/core.lua and set at least:

   • Config.Locale to 'en' or 'pl'
   • Config.ServerName to your server name
   • Config.Debug = false on production

   Then set Config.DefaultSlots in config/characters.lua.

8. 8

   Start the serverLink copied

   The console should show:

   [sc_multicharacter] Framework: esx

   Join the server. You will see the loading screen and then character select.

Post-install checklistLink copied

• No red sc_multicharacter messages in the console.
• The detected framework is correct.
• No other character select is running.
• You can create a character and the appearance editor opens.
• The character spawns, and the HUD and inventory work.
• /relog returns to character select.
• Config.Debug = false.

File structureLink copied

sc_multicharacter/├── fxmanifest.lua├── config/                      editable│   ├── core.lua                 framework, locale, admins, database│   ├── characters.lua           slots, cooldowns, /relog│   ├── identity.lua             validation, nationalities, random names│   ├── spawn.lua                spawn, buckets, spawn selector│   ├── camera.lua               scenes, animations, filters, lineup│   ├── arrival.lua              airplane intro, welcome card│   ├── startingitems.lua        starting items│   ├── loading.lua              loading screen server data│   ├── discord.lua              Discord integration│   ├── discord-secrets.lua      bot token and guild id, server only│   ├── integrations.lua         logs│   └── theme.lua                colors, logo, font├── bridge/│   ├── client/editable.lua      editable client hooks│   ├── client/appearance.lua    editable appearance adapters│   ├── server/editable.lua      editable server hooks│   └── ...                      encrypted├── client/                      encrypted├── server/                      encrypted├── shared/                      encrypted├── locale/                      editable├── sql/install.sql              editable└── web/dist/                    ready UI build    ├── assets/                  do not edit    ├── loadingscreen.json       editable loading screen content    ├── audio/                   your music    ├── loadingbg/               your loading backgrounds    ├── spawnmap/                your spawn photos    ├── logo/                    your logo    ├── flags/                   nationality flags    └── fonts/                   fonts

UpdatingLink copied

1. 1

   Make a backupLink copied

   Copy config/, locale/, the three editable files in bridge/, web/dist/loadingscreen.json, and your files in audio/, loadingbg/, spawnmap/, and logo/.

2. 2

   Download the new versionLink copied

   Get the package from portal.cfx.re (opens in a new tab) in Granted Assets.

3. 3

   Replace the filesLink copied

   Upload the new version, then restore your backed up files.

4. 4

   RestartLink copied

   Restart the server. Config.AutoFixDatabase adds any new columns automatically.

The editable files are yours. Updates do not change their behavior, and every hook you leave out has a safe default.