> 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-multichar.md).

# Cuxial Multichar

Character selection and creation with a cinematic scene, a built-in loading screen and extra slots by Discord role.

Cuxial Multichar is the character selection and creation screen of your server. It takes the player from the loading screen to a live scene of their character, and from there into the game.

## What it does

* **Character selection** in a live scene: random locations, job or gang locations, emotes and a camera intro.
* **Character creation** with validated name, date of birth, nationality, height and backstory.
* **Character slots**: a base amount for everyone, plus extra slots by Discord role or by Discord user ID.
* **Built-in loading screen** with background video, music player, tips and a key guide, handing over to the selection without a cut.
* **Minor characters** (optional): a request with parents and motivation that staff approve, with a scaled-down height.
* **Partner scenes** (optional): a couple or best friend appears next to the character in the selection.
* **Owned vehicle in the scene** (optional): the character poses next to one of their vehicles.
* **Starter items** for new characters and Discord logs through a webhook.
* **Per-player settings** in the selection: weather, time, filter, camera distance and music volume.

## Requirements

| Resource                                     | Required            | Used for                                                                                                                             |
| -------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| OneSync                                      | Yes                 | Each player is isolated in their own routing bucket while selecting                                                                  |
| `ox_lib`                                     | Yes                 | Callbacks, commands, notifications, locales                                                                                          |
| `oxmysql`                                    | Yes                 | Database                                                                                                                             |
| `cuxial_bridge`                              | Yes                 | Connection with the framework and the inventory                                                                                      |
| `cuxial_appearance` or `illenium-appearance` | No (one of the two) | Character look in the scene and the creator for new characters. With neither, the character shows the base body and no creator opens |
| `cuxial_emotes`                              | No                  | Emotes in the selection scene                                                                                                        |
| `cuxial_license`                             | No                  | Real ID card preview when creating a character                                                                                       |
| `cuxial_garages`                             | No                  | Owned vehicle in the selection scene                                                                                                 |
| `av_weather`                                 | No                  | Freezes its weather sync while the selection is open                                                                                 |
| `qbx_properties`                             | No                  | Starting apartments for new characters                                                                                               |

{% hint style="warning" %}
Cuxial Multichar requires **QBox** or **QBCore**.
{% 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, convars, Discord bot and start order.</td><td><a href="/scripts/core/cuxial-multichar/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>Every option of <code>shared/config.lua</code> and the <code>data</code> files.</td><td><a href="/scripts/core/cuxial-multichar/configuration.md">Configuration</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>Player and staff commands.</td><td><a href="/scripts/core/cuxial-multichar/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>Public API for minor character requests.</td><td><a href="/scripts/core/cuxial-multichar/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-multichar/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-multichar.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.