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

# Introduction

Cylex Multicharacter V2 is a character selection screen for FiveM: characters wait in one of seven places, with an identity form, Discord role slots and play time. For ESX, QBCore and Qbox.

<div data-full-width="true"><figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2FOCGZckL4mllb5Wls9CFV%2Fcylex-multicharacter-v2.png?alt=media" alt="Cylex Multicharacter V2"><figcaption></figcaption></figure></div>

Cylex Multicharacter V2 (`cylex_multichar`) is the character selection screen for your FiveM server.\
When players join, their characters sit or stand in one of seven places: a cube room, a beach, a camp, a courthouse, an apartment, Michael's house or an office. Players pick a character to play, create a new one with the identity form, or delete one.\
It runs on ESX, QBCore and Qbox (and bs-core), finds your framework, clothing script and spawn selector by itself, and leaves its config and integration files open to edit.

### Key Features <a href="#key-features" id="key-features"></a>

* Seven places with their own seats, poses, camera moves, weather and time. Use one, or a random one at every join.
* Every character is shown in its own clothes, with its job, cash and bank money, and play time.
* An identity form for new characters: first name, last name, gender, date of birth, height and nationality.
* Character slots: one number for everyone, more by Discord role, or a set number for single players.
* Works with 10 clothing scripts: illenium-appearance, fivem-appearance, bs-appearance, onex-creation, qb-clothing, bl\_appearance, rcore\_clothing, tgiann-clothing, raid\_clothes and skinchanger, plus a place for your own.
* Works with 8 spawn selectors: cylex\_spawn, um-spawn, fry\_spawn, qb-apartments, qbx\_apartments, qbx\_spawn, qb-spawn and bs-spawn.
* Starter items for new characters.
* An option to hide the delete button.
* `/logout` sends staff back to the selection screen.

### Installation Steps <a href="#installation-steps" id="installation-steps"></a>

{% content-ref url="/pages/gTJNsFEo74gQzwBbHGeR" %}
[Installation & Configuration](/docs/scripts/cylex-multicharacter-v2/installation-and-configuration.md)
{% endcontent-ref %}

{% content-ref url="/pages/hZeBLiEZL8X1Mprkjzn1" %}
[Configuration Reference](/docs/scripts/cylex-multicharacter-v2/installation-and-configuration/configuration-reference.md)
{% endcontent-ref %}

### Dependencies <a href="#dependencies" id="dependencies"></a>

| Dependency              | Required          | Notes                                                                     |
| ----------------------- | ----------------- | ------------------------------------------------------------------------- |
| oxmysql                 | **Yes**           | Database connector.                                                       |
| ESX, QBCore **or** Qbox | **Yes**           | Found by itself (`core = 'auto'`). bs-core works too.                     |
| A clothing script       | **Yes**           | Shows the characters in their clothes and opens the creator for new ones. |
| A spawn selector        | Optional          | Only used when `CustomSpawnSelector = true`.                              |
| cylex\_multichar\_map   | Included          | The room of the `cuberoom` place.                                         |
| ox\_inventory           | For starter items | Needed for starter items on ESX and Qbox.                                 |
| A Discord bot           | Optional          | Only for more slots by Discord role.                                      |

{% hint style="warning" %}
Your server's license key (the `sv_licenseKey` line in server.cfg) must belong to the same Cfx.re account that bought the script. Otherwise the protected files do not load.
{% endhint %}

### What You Can Edit <a href="#what-you-can-edit" id="what-you-can-edit"></a>

All settings, texts, places and framework integrations are open. The escrow protection only covers the internal client and server logic.

| File / Folder                                            | Editable?                                                                    |
| -------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `configs/sh_config.lua`                                  | Yes — main settings and the functions for clothing and spawn scripts         |
| `configs/sv_config.lua`                                  | Yes — character slots, Discord roles, `/logout` and how saved looks are read |
| `configs/sh_locations.lua`                               | Yes — the places                                                             |
| `configs/sh_locales.lua`                                 | Yes — every text of the menu                                                 |
| `client/integrations/*.lua`, `server/integrations/*.lua` | Yes — the ESX, QBCore, Qbox and bs-core integrations                         |
| `database.json`                                          | Your data — play time of every character                                     |
| All other Lua files in `client/`, `server/` and `rpc/`   | No — escrow-protected                                                        |
| `html/`                                                  | No — the built menu                                                          |

### Support <a href="#support" id="support"></a>

Store: <https://cylexdev.com>\
Discord: <https://discord.gg/cylexstore>