> 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/cylex-multicharv3/introduction.md).

# Introduction

Cylex Multicharacter is a modern, cinematic multi-character system for FiveM servers. \
It replaces the default character flow with a fully animated selection screen, giving your players a polished experience from the moment they connect. \
The system supports ESX, QBCore, and QBox out of the box, auto-detects your framework and clothing script on startup, and ships with every configuration file you need left fully open and documented.

### &#x20;Installation Steps <a href="#key-features" id="key-features"></a>

{% content-ref url="/spaces/txqtJ91rcI0EHH3xURdT/pages/fEhz3LxKqEQVYV5xSwYi" %}
[Installation & Configuration](/docs/cylex-multicharv3/installation-and-configuration.md)
{% endcontent-ref %}

{% content-ref url="/spaces/txqtJ91rcI0EHH3xURdT/pages/m6my3Tw0nncotckiAQqn" %}
[Quick Start: First Configuration After Installation](/docs/cylex-multicharv3/installation-and-configuration/quick-start-first-configuration-after-installation.md)
{% endcontent-ref %}

{% content-ref url="/spaces/txqtJ91rcI0EHH3xURdT/pages/rDlwEN7WzOGhXSbYX3SF" %}
[General Configuration Reference](/docs/cylex-multicharv3/installation-and-configuration/general-configuration-reference.md)
{% endcontent-ref %}

{% content-ref url="/spaces/txqtJ91rcI0EHH3xURdT/pages/53Kjb72fHGsX83zQAC1L" %}
[Edit Character Slots](/docs/cylex-multicharv3/installation-and-configuration/edit-character-slots.md)
{% endcontent-ref %}

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

| Dependency               | Required | Notes                                      |
| ------------------------ | -------- | ------------------------------------------ |
| ESX **or** QBCore / QBox | **Yes**  | One framework must be running              |
| oxmysql or mysql-async   | **Yes**  | Database connector                         |
| Clothing script          | Optional | Auto-detected — see `config.lua`           |
| Spawn script             | Optional | Auto-detected or use the built-in selector |
| Apartment script         | Optional | Auto-detected or disabled                  |

### [​](https://cylex.mintlify.app/introduction#what-you-can-edit)What You Can Edit <a href="#what-you-can-edit" id="what-you-can-edit"></a>

Every file you need to configure is fully open. The escrow protection only covers internal client and server logic.

| File / Folder           | Editable?                                       |
| ----------------------- | ----------------------------------------------- |
| `config.lua`            | Yes — main configuration, start here            |
| `shared/*.lua`          | Yes — all open and documented                   |
| `locales/*.lua`         | Yes — safe to edit and translate                |
| `html/assets/index.css` | With care — test any styling changes thoroughly |
| `html/js/index.js`      | Advanced only — errors here will break the UI   |
| `client/*.lua`          | No — escrow-protected                           |
| `server/*.lua`          | No — escrow-protected                           |
| `fxmanifest.lua`        | No — do not edit                                |

{% hint style="warning" %}
Always keep a backup before editing `html/js/index.js` or `html/assets/index.css`. A single syntax error will produce a blank UI for all players.
{% endhint %}