> For the complete documentation index, see [llms.txt](https://docs.sleepycode.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sleepycode.eu/scripts/multicharacter.md).

# Multicharacter

Premium FiveM multicharacter with identity, spawn selector, and a custom loading screen in one resource for ESX, QBCore, Qbox, and ox\_core.

<figure><img src="https://1230571396-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fm30w7eH1DvWE1aHGS5VP%2Fuploads%2Fgit-blob-10716676930c5a998fb37f174caa7d2fefbe2505%2FSleepyCode_Multicharacter.png?alt=media" alt="SleepyCode Multicharacter"><figcaption></figcaption></figure>

## Multicharacter

SC Multicharacter is a complete character selection and creation system for FiveM.

It replaces `esx_multicharacter`, `esx_identity`, `qb-multicharacter`, and similar resources with one script.

It covers the whole start of a player session: loading screen, character select, identity, appearance, starting items, spawn selector, and arrival.

**Discord**: [Join SleepyCode Discord](https://discord.gg/hPpJANwfUQ)

{% hint style="success" %}
Works with **ESX Legacy, QBCore, Qbox, and ox\_core**.

The framework is detected automatically. Characters are saved in the native framework table, so jobs, phones, garages, and inventories keep working.
{% endhint %}

### At a glance

| Feature              | Includes                                                                |
| -------------------- | ----------------------------------------------------------------------- |
| **Loading screen**   | Your branding, live player count, Discord staff list, music, and video  |
| **Character select** | Live in-world scene, camera animations, filters, and character lineup   |
| **Identity**         | Server-side validated name, birth date, nationality, height, and weight |
| **Starting items**   | Budget-based starter basket for items and vehicles                      |
| **Spawn selector**   | Aerial preview camera, last location, and automatic location photos     |
| **Arrival**          | GTA Online style airplane intro and a welcome card                      |
| **Administration**   | Slots, character locks, force delete, Discord role slots, and logs      |

### Documentation

Use these pages to install, configure, and extend the resource.

* [Features](/scripts/multicharacter/features.md)
* [Installation](/scripts/multicharacter/installation.md)
* [Framework Setup](/scripts/multicharacter/framework-setup.md)
* [Core Settings](/scripts/multicharacter/core-settings.md)
* [Characters and Slots](/scripts/multicharacter/characters-and-slots.md)
* [Identity](/scripts/multicharacter/identity.md)
* [Spawn Selector](/scripts/multicharacter/spawn-selector.md)
* [Camera and Scene](/scripts/multicharacter/camera-and-scene.md)
* [Arrival and Welcome](/scripts/multicharacter/arrival-and-welcome.md)
* [Starting Items](/scripts/multicharacter/starting-items.md)
* [Loading Screen](/scripts/multicharacter/loading-screen.md)
* [Discord](/scripts/multicharacter/discord.md)
* [Logs](/scripts/multicharacter/logs.md)
* [Theme and Branding](/scripts/multicharacter/theme-and-branding.md)
* [Translations](/scripts/multicharacter/translations.md)
* [Commands and Permissions](/scripts/multicharacter/commands-and-permissions.md)
* [Database](/scripts/multicharacter/database.md)
* [Integrations](/scripts/multicharacter/integrations.md)
* [Hooks](/scripts/multicharacter/hooks.md)
* [Exports and Events](/scripts/multicharacter/exports-and-events.md)
* [Examples](/scripts/multicharacter/examples.md)
* [Security](/scripts/multicharacter/security.md)
* [Troubleshooting](/scripts/multicharacter/troubleshooting.md)

### Requirements

| Resource            | Required | Purpose                                        |
| ------------------- | -------- | ---------------------------------------------- |
| `oxmysql`           | Yes      | The only hard dependency                       |
| OneSync             | Yes      | Private routing bucket during character select |
| Framework           | Yes      | ESX Legacy, QBCore, Qbox, or ox\_core          |
| Appearance resource | Optional | Character appearance and the creation editor   |
| Inventory           | Optional | Starting items and their images                |
| `screenshot-basic`  | Optional | Automatic spawn location photos                |
| Discord bot         | Optional | Role slots, staff list, player name and avatar |

### Quick start

1. Remove every other character select and identity resource.
2. Place the resource in `resources/[core]/sc_multicharacter`.
3. Add `ensure sc_multicharacter` after `oxmysql` and your framework.
4. Apply the one framework change from [Framework Setup](/scripts/multicharacter/framework-setup.md).
5. Set `Config.Locale` and `Config.ServerName` in `config/core.lua`.

The database tables are created automatically on the first start.

### Editable files

The Cfx asset escrow release keeps configuration and integrations editable.

| Path                            | Purpose                            |
| ------------------------------- | ---------------------------------- |
| `config/*.lua`                  | Every setting and the theme        |
| `bridge/server/editable.lua`    | Your server-side hooks             |
| `bridge/client/editable.lua`    | Your client-side hooks             |
| `bridge/client/appearance.lua`  | Appearance resource adapters       |
| `locale/*.json`                 | Translations                       |
| `sql/*.sql`                     | Database install script            |
| `web/dist/loadingscreen.json`   | Loading screen content             |
| `web/dist/audio/`, `loadingbg/` | Your music and loading backgrounds |
| `web/dist/spawnmap/`, `logo/`   | Your spawn photos and logo         |

{% hint style="info" %}
The UI ships as a ready build in `web/dist/`. You do not need Node.js or any build step.
{% endhint %}