> 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/installation-and-configuration.md).

# Installation & Configuration

#### Installation Instructions for **cylex\_multichar**

{% hint style="info" %}
Remember to choose your own framework and install accordingly!
{% endhint %}

{% stepper %}
{% step %}

### **Download the Script**

* Log in to [portal.cfx.re](https://portal.cfx.re/).
* Click on **"Granted Access"** on the left side of the page.
* Search for **cylex\_multicharv3**
* Download all the available options that appear.
  {% endstep %}

{% step %}

### **Extract the Files**

* After downloading, unzip all the **cylex\_multicharv3.pack**.**zip** folders.
* Move all the extracted files into the **resources** folder.
* Delete <kbd>**esx\_multicharacter**</kbd> , <kbd>**qb-multicharacter**</kbd> and <kbd>**other multicharacter**</kbd> scripts in **resources** folder.
  {% endstep %}

{% step %}

### **Update the Server Configuration:**

* Open the **server.cfg** file located in your server files.
* <kbd>**stop basic-gamemode**</kbd> in server.cfg (do not add this again, if you have this, replace ensure with stop)

{% hint style="danger" %}

### **If you use ESX framework, don't forget to do this.**

{% endhint %}

* open > **es\_extended** > config.lua
* set <kbd>**Config.Multichar = true**</kbd>
  {% endstep %}

{% step %}

### Add the resource to server.cfg&#xD;&#x20;&#xD;

Open your `server.cfg` and add the `ensure` line **after** your framework resource. Cylex Multicharacter must start after **es\_extended** is fully loaded — if it starts too early, the character select screen will flash and disappear.

```
# Your framework must come first
# this is a example, if you already have it, do not add again.
start  es_extended

# Then add Cylex Multicharacter
ensure cylex_multicharv3
```

{% endstep %}

{% step %}

### **(Optional) Configure Discord integration**

If you want Discord webhook logging or Discord-role based slot permissions, add these two convars to `server.cfg`:

```
set cylex_multicharv3:DISCORD_GUILD_ID  "YOUR_GUILD_ID"
set cylex_multicharv3:DISCORD_BOT_TOKEN "YOUR_BOT_TOKEN"
```

Replace `YOUR_GUILD_ID` with your Discord server’s ID and `YOUR_BOT_TOKEN` with your bot’s token. These convars enable:

* Webhook log messages for character create, delete, select, logout, and partner events (configured in `shared/webhooks.lua`)
* Per-Discord-role character slot overrides (configured in `shared/slot.lua`)

{% hint style="danger" %}
Never commit or share your `DISCORD_BOT_TOKEN` publicly. Anyone with the token can act as your bot.If you do not need Discord features, skip this step entirely — everything else will work fine without these convars.
{% endhint %}
{% endstep %}

{% step %}

### Configure the Script

Visit the below link for detailed information about configure.<br>

{% 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 %}
{% endstep %}

{% step %}

### Start your server

Start or restart your server. On first launch, Cylex Multicharacter automatically:

* Detects your framework (ESX, QBCore, or QBox)
* Detects your clothing script
* Creates the `cylex_playtime` database table

When a player connects, the character select screen will open automatically. No additional commands or setup are required.<br>

{% hint style="warning" %}
If something does not look right, open `config.lua` and set `Config.Debug = true`. This enables verbose output in the server console to help you identify the issue.
{% endhint %}
{% endstep %}
{% endstepper %}

By following these steps and adjusting the settings in **config.lua**, **MultiCharacter Script** will be fully configured and ready to use on your server!