> For the complete documentation index, see [llms.txt](https://f4-studio.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://f4-studio.gitbook.io/documentation/resources/f4-xmulticharacter.md).

# f4-xmulticharacter

Welcome to the official GitBook documentation for F4 XMulticharacter.

F4 XMulticharacter is a character selection and creation screen staged as a cinematic scene. Your character sits in one of six hand-built locations while you choose who to play. New characters are booked in a mugshot room that fills in as the form is typed. It runs on QBox, QBCore and ESX, and works with the common appearance resources out of the box.

## Highlights

* Select, create and delete characters from one screen.
* First name, last name, date of birth, nationality, height and gender, checked live in the interface and again on the server.
* Six scenes to pick from, plus a dedicated booking room for character creation.
* Per-player weather and time on the character screen. The server's weather is never touched.
* Real ped height scaling, synced to nearby players.
* Locked slots and per-player slot grants, reloadable without a restart.
* `/logout` to switch characters without reconnecting.
* Discord logs for joining, leaving, creating and deleting characters.
* Eight languages: English, Turkish, German, French, Polish, Greek, Bulgarian and Arabic.

## About these docs

This documentation is written for the escrow-protected package. It only describes the files and public surfaces you are expected to touch:

* `shared/config.lua`, `shared/server_config.lua`, `shared/slots.lua`, `shared/names.lua`, `shared/nationalities.lua`
* `locales/*.lua`
* `client/open.lua` and `server/open.lua`
* The framework bridges, `client/spawn.lua` and `server/logs.lua`
* Public exports, events, callbacks and console commands

Encrypted files are not part of the editing surface. When a behavior lives in protected code, these pages explain the public contract instead.

{% hint style="info" %}
Moving from the older [f4-multicharacter](/documentation/resources/f4-multicharacter.md)? F4 XMulticharacter is a separate resource with a new configuration. Settings such as `ServerName`, `ThemeColor`, `Rules` and `spawnCoords` do not exist here. Existing characters stay in your framework's tables and show up on the new screen. See [Updating](/documentation/resources/f4-xmulticharacter/operations/updating.md).
{% endhint %}

## Recommended reading order

1. [Requirements](/documentation/resources/f4-xmulticharacter/getting-started/requirements.md)
2. [Installation](/documentation/resources/f4-xmulticharacter/getting-started/installation.md)
3. [Framework Setup](/documentation/resources/f4-xmulticharacter/getting-started/framework-setup.md)
4. [Main Configuration](/documentation/resources/f4-xmulticharacter/configuration/main-configuration.md)
5. [Slots and Locks](/documentation/resources/f4-xmulticharacter/configuration/slots-and-locks.md)
6. [Appearance](/documentation/resources/f4-xmulticharacter/configuration/appearance.md)
7. [Spawning](/documentation/resources/f4-xmulticharacter/configuration/spawning.md)
8. [Troubleshooting](/documentation/resources/f4-xmulticharacter/operations/troubleshooting.md)

Need help? Join the [Discord server](https://discord.gg/YxNWgxYKdQ) or visit the [Tebex store](https://f4studio.tebex.io).