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

# Cuxial Appearance

Character creator and appearance editor for FiveM: clothing shops, photo catalogue, outfits, garments as items and a staff panel.

Cuxial Appearance is the character creator and the appearance editor of your server: face, hair, clothes, accessories, makeup and tattoos in one menu. It also runs the clothing shops, the saved outfits, garments as inventory items and an in-game panel for staff.

## What it does

* **Character creator** for new characters, launched by your multicharacter resource.
* **Shops by zone**: clothing store, barber, surgeon, full dressing room and second-hand shop. Each one is a polygon with its own price, blip and optional job lock.
* **Catalogue with photos** of every garment, taken in game with the built-in photo studio.
* **Outfits**: save, rename, update, share with a nearby player, export as a code, turn into an item, and job outfits by rank.
* **Outfit bag**: an item that is placed on the ground and holds outfits to wear anywhere.
* **Wardrobe**: take garments off and put them back on. A garment taken off becomes an inventory item.
* **Inventory mode** (optional): clothing panel in the inventory, garment bags, replaced garments returned on purchase and body search.
* **Second hand**: shops that buy loose garments from players.
* **Trimmer**: an item that shaves another player's head and locks their hair for a while.
* **Restrictions**: garments and models hidden by file, by ACE permission or granted to specific characters.
* **Staff panel**: shops, exclusive garments, players, logs and live settings.
* **Migration** of skins and outfits from crm-appearance and illenium-appearance, on demand or on the fly.

How each part is used in game is explained in the [Features guide](/scripts/core/cuxial-appearance/features.md).

## Requirements

| Resource                                                  | Required | Used for                                                                         |
| --------------------------------------------------------- | -------- | -------------------------------------------------------------------------------- |
| OneSync                                                   | Yes      | Routing buckets, placed bags, server-side checks                                 |
| `ox_lib`                                                  | Yes      | Commands, keybind, zones, locales                                                |
| `oxmysql`                                                 | Yes      | Appearances, outfits, shops, settings and logs                                   |
| `cuxial_bridge`                                           | Yes      | Connects to your framework (QBox, QBCore or ESX), your inventory and your target |
| Inventory (`ox_inventory` or `qb-inventory`)              | No       | Required for garments as items, outfit items, bags, trimmer and second hand.     |
| Target (`sleepless_interact`, `ox_target` or `qb-target`) | No       | Opening and picking up an outfit bag placed on the ground                        |
| `cuxial_appearance_photos`                                | No       | Stores the catalogue photos. Without it the catalogue shows no photos.           |
| `screencapture` or `screenshot-basic`                     | No       | Taking the photos in the photo studio                                            |
| `cuxial_emotes`                                           | No       | Poses in the menu. Required by the trimmer.                                      |
| `rcore_tattoos`                                           | No       | When it runs, tattoos are left to it and the built-in tattoo tab is hidden       |

{% hint style="warning" %}
Do not run another clothing or appearance script next to Cuxial Appearance. It answers the usual `qb-clothing` events itself, so resources written for them keep working.
{% endhint %}

{% hint style="info" %}
On ESX the creator starts on the male model and the player picks the model in the heritage tab. On QBox and QBCore it starts on the model of the character's gender.
{% endhint %}

## Pages

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Installation</strong></td><td>Dependencies, items, convars and start order.</td><td><a href="/scripts/core/cuxial-appearance/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>Every option in <code>shared/config.lua</code> and the data files.</td><td><a href="/scripts/core/cuxial-appearance/configuration.md">Configuration</a></td></tr><tr><td><strong>Features guide</strong></td><td>Shops, outfits, wardrobe, second hand and the staff panel in game.</td><td><a href="/scripts/core/cuxial-appearance/features.md">Features guide</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>Commands, the shop key and who counts as staff.</td><td><a href="/scripts/core/cuxial-appearance/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>Read, apply and save appearances from your own resources.</td><td><a href="/scripts/core/cuxial-appearance/developers.md">Exports &amp; events</a></td></tr><tr><td><strong>Troubleshooting</strong></td><td>Common problems and how to fix them.</td><td><a href="/scripts/core/cuxial-appearance/troubleshooting.md">Troubleshooting</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cuxial.com/scripts/core/cuxial-appearance.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.