> 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/apex-series/cylex-apex-clothing/introduction.md).

# Introduction

Cylex Apex Clothing is a character creator and clothing system for FiveM. Creator, clothing, barber, tattoo and surgeon shops, wardrobes and outfits for QBCore, Qbox, ESX and standalone servers.

<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%2F3IXggQofXnOOTV42doMf%2Fcylex-apex-clothing.png?alt=media" alt="Cylex Apex Clothing"><figcaption></figcaption></figure></div>

Cylex Apex Clothing is the character creator and clothing system for your FiveM server.\
New characters make their look in the creator. Players buy clothes, haircuts, tattoos and surgery in the shops, and keep their saved outfits in wardrobes.\
It runs on QBCore, Qbox, ESX or without a framework (standalone), finds your framework by itself, and leaves every settings, language and integration file open to edit.

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

* A character creator for new characters, with a short intro and two places to get ready: the Black studio and Daylight.
* Clothing, barber, tattoo and plastic surgeon shops. 15 clothing stores, 9 barber shops and 8 tattoo parlours come ready to use.
* Wardrobes with saved outfits, outfit share codes, and sending an outfit to a player nearby.
* Job and gang outfits by grade, with an option for bosses to manage them in the boss menu.
* A photo for every clothing item and every colour, taken once on your own server with a team of helpers.
* Prices per shop: per item, one fixed price, or free. The server checks every price. The first character is always free.
* A first character that was left half done (game crash, quit, lost connection) comes back with the look so far.
* Multicharacter, housing, admin and job scripts made for the common clothing scripts keep working without changes.
* 12 languages. English and Turkish are complete; the others are partly translated.

<figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2FDP0eTY16cXrKAWc4S7Gn%2Fstore-feature-favdl.png?alt=media&amp;token=6482b8cd-1817-42e5-b858-e09cee16f9ec" alt=""><figcaption></figcaption></figure>

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

{% content-ref url="/pages/cJupui4ru7OZEa8Dpbfa" %}
[Installation & Configuration](/docs/apex-series/cylex-apex-clothing/installation-and-configuration.md)
{% endcontent-ref %}

{% content-ref url="/pages/hSESuej8LjMVqaae7CYf" %}
[Configuration](/docs/apex-series/cylex-apex-clothing/installation-and-configuration/configuration.md)
{% endcontent-ref %}

{% content-ref url="/pages/NjPBmi1K0Lc6hyYJq5Jq" %}
[Clothing Photos](/docs/apex-series/cylex-apex-clothing/clothing-photos.md)
{% endcontent-ref %}

{% content-ref url="/pages/xZTTBHprLE8lDPsyW1IS" %}
[Switching From Another Clothing Script](/docs/apex-series/cylex-apex-clothing/switching-from-another-clothing-script.md)
{% endcontent-ref %}

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

| Dependency              | Required               | Notes                                                                                                                                                                                                                                      |
| ----------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| oxmysql                 | **Yes**                | Database connector. Your database must already work with it.                                                                                                                                                                               |
| QBCore, Qbox **or** ESX | Optional               | Found by itself. Without one the script runs standalone: no jobs or gangs, shops are free, and players are saved by their FiveM license.                                                                                                   |
| ox\_lib                 | Optional (recommended) | The script carries its own copy of the ox\_lib parts it needs. It still uses the ox\_lib resource for messages, small menus and the key prompt when nothing else gives them. The box where a boss names a job outfit always needs ox\_lib. |
| ox\_target or qb-target | Optional               | Only if players should open shops by targeting a person instead of pressing a key.                                                                                                                                                         |
| bob74\_ipl              | Optional               | Loads the bunker room used by the "Daylight" creator place.                                                                                                                                                                                |
| Fivemanage API key      | For the photos         | Stores the clothing photos. The free plan is enough for most servers. See [Clothing Photos](/docs/apex-series/cylex-apex-clothing/clothing-photos.md).                                                                                     |

{% 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 script does not start.
{% endhint %}

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

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

| File / Folder                                                                                                                    | Editable?                                                    |
| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| `shared/config/*.lua`                                                                                                            | Yes — all settings, start with `config.lua`                  |
| `locales/*.lua`                                                                                                                  | Yes — every text players see                                 |
| `shared/functions.lua`                                                                                                           | Yes — notifications, menus, text UIs, HUD and other hooks    |
| `shared/peds.lua`, `shared/blacklist.lua`, `shared/tattoos.lua`                                                                  | Yes — ped lists, hidden items, tattoo list                   |
| `core/shared.lua`, `shared/compat.lua`                                                                                           | Yes — framework bridge (shared part) and compatibility layer |
| `client/interaction.lua`, `client/blips.lua`, `client/target/`, `client/management/`, `client/radial/`, `server/permissions.lua` | Yes — integrations with other resources                      |
| `server/database/*.lua`                                                                                                          | Yes — database queries                                       |
| `lib/*.lua`                                                                                                                      | Yes — the ox\_lib parts the script carries                   |
| `photos-config.json`                                                                                                             | Yes — photo capture settings                                 |
| `core/client.lua`, `core/server.lua` and all other Lua files in `client/`, `server/` and `game/`                                 | No — escrow-protected                                        |
| `html/`                                                                                                                          | No — the built UI. Any change turns purchases off            |

{% hint style="warning" %}
Never change the files in `html/`. When they are changed, the script turns purchases off and the console says: "The UI files (html/) were changed. Purchases in the clothing menu are turned off until the original html/ folder of this version is put back."
{% endhint %}

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

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

### In-Game Screenshots <a href="#in-game-screenshots" id="in-game-screenshots"></a>

<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%2FGEwrOEaonFytLVw2zu1M%2Fcfx-banner-gallery.png?alt=media&amp;token=5a1b3a75-22ed-48e3-9ffd-111135aa422e" alt="In-Game Screenshots"><figcaption></figcaption></figure></div>

{% columns %}
{% column %}

<figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2FbETu4ynGWk5HstAM7iFV%2Fm-neon.jpg?alt=media&amp;token=e218b7c7-5576-4a62-bc89-ffcfffdb0e9a" alt="Clothing menu, neon outfit"><figcaption></figcaption></figure>

<figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2FMhdy3yqK29gFl7UUJJ0v%2Fm-favs.jpg?alt=media&amp;token=6611e5ae-217d-46f4-a3f3-f0f587479479" alt="Favourites"><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2FCzxY8DOdvvDtueEKptMB%2Fm-favtab.jpg?alt=media&amp;token=e8339376-5d9b-4ed9-8793-c357d122aed8" alt="Favourites tab"><figcaption></figcaption></figure>

<figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2FS11RjkNWKgOwnLskGKqM%2Fm-downloads.jpg?alt=media&amp;token=e48f98a9-547f-440d-b2e8-437154dbc61e" alt="Downloads"><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}
