Skip to Content

Installation

Get Nexus Multicharacter running on your QBCore, Qbox, or ESX server.

Asset download

The asset only appears in the Cfx portal of the account that purchased it. If you need it on a different keymaster, use the transfer system on the portal.

Once your purchase clears, head to your Cfx portal  and download nxs_multicharacter from your asset panel.

Requirements

You’ll need the following on your server before installing:

Required for everyone:

Optional (starter apartment / property integration):

If you want new characters to be assigned a starter apartment or property during character creation, the resource supports these out of the box:

  • QBCore: qb-apartments
  • Qbox: qbx_properties

These are completely optional. Either way, characters always spawn at Config.InitialSpawn after creation. The integration only affects whether they get assigned a starter apartment alongside it.

One appearance menu of your choice:

Out of the box, these appearance/clothing menus are supported:

  • fivem-appearance, illenium-appearance, qb-clothing, skinchanger, crm-appearance, bl_appearance, tgiann-clothing, rcore_clothing, dx_clothing, karma_clothing

You’ll pick the active one in config.lua after install. If you use a menu that isn’t on this list, you can wire it up yourself by editing client/cl_customize.lua and server/sv_customize.lua.

Framework setup

The default multicharacter that ships with your framework needs to be replaced. Follow the steps for the framework you’re running:

1. Remove esx_multicharacter

Delete esx_multicharacter from /resources/[core]/ completely.

2. Enable multichar in es_extended

Find your ESX config file:

  • ESX Legacy 1.12 and above: es_extended/shared/config/main.lua
  • Any other version: es_extended/config.lua

Find this line:

Config.Multichar = GetResourceState("esx_multicharacter") ~= "missing"

Change it to:

Config.Multichar = true

3. Install the resource

Drag nxs_multicharacter into your /resources folder.

Start the resource

Add it to your server.cfg after all of its dependencies:

ensure ox_lib
ensure oxmysql
ensure <your-appearance-menu>
# Optional: ensure qbx_properties (Qbox) or qb-apartments (QBCore)
ensure nxs_multicharacter

Then restart your server. The first launch will run any required SQL migrations automatically.

Framework detection

By default Config.Framework = 'auto' in config.lua, so the resource will detect QBCore, Qbox, or ESX on its own. If detection ever fails or you want to force a specific framework, set it explicitly:

shared/config.lua
Config.Framework = 'qbx' -- auto | qb | qbx | esx

What to configure next

Head over to the Config page to set:

  • Number of free vs paid character slots
  • Initial spawn location
  • Which appearance menu to integrate with
  • Paid slot unlock mode (Tebex codes, Discord roles, or both)
  • Logo, sounds, and per-slot animations

If you run into any trouble, hop into our Discord  and we’ll help you sort it out.

Last updated on
FAQConfig