> For the complete documentation index, see [llms.txt](https://bytecode-studios.gitbook.io/cadburry/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bytecode-studios.gitbook.io/cadburry/scripts/character-system.md).

# Character System

## **Description**

Complete identity, character selection and spawn system for FiveM, with a built in appearance editor and loading screen. Framework agnostic, with every integration detected automatically at runtime.

## **Preview**

{% hint style="info" %}
Preview has been removed temporally and will updated with a new video once the ui has been redesigned.
{% endhint %}

## **Features**

* Cinematic character selection with custom scenes, per slot ped placement, camera framing and idle animations. Build your own scenes in game with `/scenebuilder`.
* Character creation with configurable nationalities, name validation and job coloured badges. Optional animated intro sequence and character deletion.
* Character slots with permanent per identifier overrides, temporary slots with expiry, Discord role based slots and admin commands.
* Spawn menu with categorised locations, per job restrictions, last location spawning and an anti combat log timer.
* Spawn effects with post FX, sound and a particle burst.
* Built in appearance editor covering clothing, barber, tattoo and plastic surgeon, with store zones, outfits, blacklists, pricing and thumbnail previews for every drawable.
* Optional themed loading screen with slideshow, social links and a music player shared with the character screen.
* Discord webhook or ox\_lib logging.
* Localised UI (English, Spanish, French) built in React with editable source included.

## **Compatibility**

* Frameworks: qbx\_core, qb-core, ESX
* Clothing: illenium-appearance, bl\_appearance, crm-appearance, dx\_clothing, karma\_clothing, onex-creation, qb-clothing, rcore\_clothing, tgiann-clothing, skinchanger, esx\_skin
* Inventory: ox\_inventory, qb-inventory, ps-inventory, lj-inventory, one\_inventory
* Housing: qbx\_properties, ps-housing, qs-housing, qb-houses, bnl-housing, vms\_housing, nolag\_properties, kartik-properties
* Motels: qb-apartments, qbx\_properties, ps-housing, snipe-motel, vms\_housing

## **Requirements**

* ox\_lib
* oxmysql
* OneSync

## **Notes**

* Database tables are created automatically on first start. Config files and bridges are fully open for editing.
* This script is works with any framework
* This script is encrypted using [Asset Escrow](https://forum.cfx.re/t/introducing-asset-escrow-for-your-resources/4777151)
* There are many files open to edit checkout bridge folder, etc
* The script is has many config open so you don't need a open source version