> 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/welcome.md).

# Welcome

Install, configure and extend every Cuxial script for FiveM.

This is the documentation for the Cuxial scripts. Every script follows the same pages: what it does, how to install it, every configuration option, its commands, its public exports and events, and the problems you are most likely to hit. The larger ones add a features guide.

{% hint style="info" %}
New here? Read [Requirements](/scripts/getting-started/requirements.md) and [Cuxial Bridge](/scripts/getting-started/cuxial-bridge.md) first. The scripts depend on them, and most installation problems come from skipping that part.
{% endhint %}

## Core

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-users">:users:</i></td><td><strong>Cuxial Multichar</strong></td><td>Character selection and creation with a cinematic scene, a built-in loading screen and extra slots by Discord role.</td><td><a href="/scripts/core/cuxial-multichar.md">Cuxial Multichar</a></td></tr><tr><td><i class="fa-shirt">:shirt:</i></td><td><strong>Cuxial Appearance</strong></td><td>Character creator and appearance editor: clothing shops, photo catalogue, outfits, garments as items and a staff panel.</td><td><a href="/scripts/core/cuxial-appearance.md">Cuxial Appearance</a></td></tr><tr><td><i class="fa-building-columns">:building-columns:</i></td><td><strong>Cuxial Banking</strong></td><td>Bank with personal, business and shared accounts, ATMs, cards, loans, savings, cheques and a staff panel.</td><td><a href="/scripts/core/cuxial-banking.md">Cuxial Banking</a></td></tr><tr><td><i class="fa-warehouse">:warehouse:</i></td><td><strong>Cuxial Garages</strong></td><td>Garages, vehicle keys, rentals, job fleets, impound and an in-game admin panel.</td><td><a href="/scripts/core/cuxial-garages.md">Cuxial Garages</a></td></tr><tr><td><i class="fa-id-card">:id-card:</i></td><td><strong>Cuxial License</strong></td><td>Licences, ID cards and badges designed in game and carried as inventory items, with the character's data and photo.</td><td><a href="/scripts/core/cuxial-license.md">Cuxial License</a></td></tr><tr><td><i class="fa-comment-dots">:comment-dots:</i></td><td><strong>Cuxial Interactions</strong></td><td>NPCs with dialogue and a selling shop, plus an API so other resources can register their own.</td><td><a href="/scripts/core/cuxial-interactions.md">Cuxial Interactions</a></td></tr><tr><td><i class="fa-shield-halved">:shield-halved:</i></td><td><strong>Cuxial Safezones</strong></td><td>Safe zones drawn in game, with their own rules, on-screen sign and exceptions per zone.</td><td><a href="/scripts/core/cuxial-safezones.md">Cuxial Safezones</a></td></tr><tr><td><i class="fa-user-shield">:user-shield:</i></td><td><strong>Cuxial Admin</strong></td><td>Administration panel with ranks, reports, sanctions history, audit log and live moderation tools.</td><td><a href="/scripts/core/cuxial-admin.md">Cuxial Admin</a></td></tr><tr><td><i class="fa-handcuffs">:handcuffs:</i></td><td><strong>Cuxial Community Service</strong></td><td>Staff sanctions with community service tasks, administrative jail and an admin panel.</td><td><a href="/scripts/core/cuxial-cmservices.md">Cuxial Community Service</a></td></tr></tbody></table>

## Interface

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-comments">:comments:</i></td><td><strong>Cuxial Chat</strong></td><td>Roleplay chat with coloured channels, overhead actions and per-player settings.</td><td><a href="/scripts/interface/cuxial-chat.md">Cuxial Chat</a></td></tr><tr><td><i class="fa-masks-theater">:masks-theater:</i></td><td><strong>Cuxial Emotes</strong></td><td>Emote menu with a searchable catalog, favorites, props, paired emotes, zones and a photo mode.</td><td><a href="/scripts/interface/cuxial-emotes.md">Cuxial Emotes</a></td></tr><tr><td><i class="fa-circle-pause">:circle-pause:</i></td><td><strong>Cuxial Pause Menu</strong></td><td>Custom pause menu: a side frame over the game with server info, rules and shortcuts to the map and settings.</td><td><a href="/scripts/interface/cuxial-pausemenu.md">Cuxial Pause Menu</a></td></tr><tr><td><i class="fa-bullhorn">:bullhorn:</i></td><td><strong>Cuxial Announcements</strong></td><td>On-screen announcements, with one visual style per job designed in game.</td><td><a href="/scripts/interface/cuxial-anuncios.md">Cuxial Announcements</a></td></tr></tbody></table>

## Police & medical

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-shield-halved">:shield-halved:</i></td><td><strong>Cuxial Police</strong></td><td>MDT for police, EMS and a federal agency: tablet, quick menu, radio, dispatch and live admin settings.</td><td><a href="/scripts/police-and-medical/cuxial-police.md">Cuxial Police</a></td></tr><tr><td><i class="fa-kit-medical">:kit-medical:</i></td><td><strong>Cuxial Medical</strong></td><td>Medical system: death phases, injuries by body zone, hospitals with beds, EMS tools and a live admin panel.</td><td><a href="/scripts/police-and-medical/cuxial-medical.md">Cuxial Medical</a></td></tr><tr><td><i class="fa-virus">:virus:</i></td><td><strong>Cuxial Diseases</strong></td><td>Disease system with stages, animated symptoms, contagion, tests, treatments and vaccines.</td><td><a href="/scripts/police-and-medical/cuxial-diseases.md">Cuxial Diseases</a></td></tr></tbody></table>

## Gangs

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-people-group">:people-group:</i></td><td><strong>Cuxial Gang</strong></td><td>Organizations and gangs: boss menu, tablet, territory, activities and a staff panel.</td><td><a href="/scripts/gangs/cuxial-gang.md">Cuxial Gang</a></td></tr><tr><td><i class="fa-mobile-screen-button">:mobile-screen-button:</i></td><td><strong>Cuxial Gang App</strong></td><td>Phone app for Cuxial Gang: organization, chat, mules, contacts and turf map inside lb-phone.</td><td><a href="/scripts/gangs/cuxial-gang-app.md">Cuxial Gang App</a></td></tr></tbody></table>

## Vehicles

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-gas-pump">:gas-pump:</i></td><td><strong>Cuxial Fuel</strong></td><td>Fuel system with pumps, fuel types, electric chargers, jerry cans and an interactive screen on the pump itself.</td><td><a href="/scripts/vehicles/cuxial-fuel.md">Cuxial Fuel</a></td></tr><tr><td><i class="fa-gas-pump">:gas-pump:</i></td><td><strong>Cuxial Gas Stations</strong></td><td>Player-owned gas stations: fuel stock, delivery fleet, staff, pressure washing, detailing and an admin panel.</td><td><a href="/scripts/vehicles/cuxial-gasstations.md">Cuxial Gas Stations</a></td></tr><tr><td><i class="fa-radio">:radio:</i></td><td><strong>Cuxial Chipeo</strong></td><td>Car audio systems: an installable head unit with USB sticks, equalizer, subwoofer, portable speakers and overheating.</td><td><a href="/scripts/vehicles/cuxial-chipeo.md">Cuxial Chipeo</a></td></tr></tbody></table>

## Jobs

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-person-swimming">:person-swimming:</i></td><td><strong>Cuxial Diving</strong></td><td>Crew-based diving job with regions, a work boat, oxygen gear, a market and progression.</td><td><a href="/scripts/jobs/cuxial-diving.md">Cuxial Diving</a></td></tr><tr><td><i class="fa-bolt">:bolt:</i></td><td><strong>Cuxial Electrician</strong></td><td>Crew-based electrician job: transformers, house panels, street lamps, traffic lights and utility poles.</td><td><a href="/scripts/jobs/cuxial-electrician.md">Cuxial Electrician</a></td></tr><tr><td><i class="fa-seedling">:seedling:</i></td><td><strong>Cuxial Gardener</strong></td><td>Team gardener job: mowing, pruning, branch cutting from a ladder, planting and watering.</td><td><a href="/scripts/jobs/cuxial-gardener.md">Cuxial Gardener</a></td></tr></tbody></table>

## Leisure

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-dumbbell">:dumbbell:</i></td><td><strong>Cuxial Gym</strong></td><td>Gyms with real equipment, minigames per rep, strength and agility stats, memberships and player-run businesses.</td><td><a href="/scripts/leisure/cuxial-gym.md">Cuxial Gym</a></td></tr><tr><td><i class="fa-music">:music:</i></td><td><strong>Cuxial Dance Class</strong></td><td>Group dance classes: an instructor, a drawn zone, students and a rhythm minigame.</td><td><a href="/scripts/leisure/cuxial-danceclass.md">Cuxial Dance Class</a></td></tr><tr><td><i class="fa-dice">:dice:</i></td><td><strong>Cuxial Domino</strong></td><td>Multiplayer domino with physical tables, bets, classic and All Fives matches, and an admin tablet.</td><td><a href="/scripts/leisure/cuxial-domino.md">Cuxial Domino</a></td></tr><tr><td><i class="fa-crosshairs">:crosshairs:</i></td><td><strong>Cuxial PvP</strong></td><td>PvP arenas with team duels, Gun Game, live spectating, bets and leaderboards.</td><td><a href="/scripts/leisure/cuxial-pvp.md">Cuxial PvP</a></td></tr></tbody></table>

## Before you install

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-list-check">:list-check:</i></td><td><strong>Requirements</strong></td><td>What your server needs, what each script adds and the order to start it in.</td><td><a href="/scripts/getting-started/requirements.md">Requirements</a></td></tr><tr><td><i class="fa-layer-group">:layer-group:</i></td><td><strong>Cuxial Bridge</strong></td><td>The layer that connects the scripts to your framework, inventory and target.</td><td><a href="/scripts/getting-started/cuxial-bridge.md">Cuxial Bridge</a></td></tr><tr><td><i class="fa-toolbox">:toolbox:</i></td><td><strong>Cuxial Jobs</strong></td><td>The shared library delivered with the job scripts.</td><td><a href="/scripts/getting-started/cuxial-jobs.md">Cuxial Jobs</a></td></tr><tr><td><i class="fa-rotate">:rotate:</i></td><td><strong>Updating a script</strong></td><td>Move to a new version without losing your configuration.</td><td><a href="/scripts/getting-started/updating.md">Updating a script</a></td></tr></tbody></table>

## Need help?

Common questions and errors shared by all scripts live in [Help](https://docs.cuxial.com/help/). Version history is in the [Changelog](https://docs.cuxial.com/changelog/).


---

# 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/welcome.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.