> 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/interface/cuxial-chat.md).

# Cuxial Chat

Roleplay chat for FiveM with coloured channels, overhead actions and per-player settings.

Cuxial Chat replaces the default FiveM chat with a roleplay chat built around channels. It keeps working with resources written for the standard chat, so nothing else on your server needs to change.

## What it does

* **Channels with their own colour and tab.** IC, OOC, ME, DO, PM and the organization channel each get a tab; dice rolls, sanctions and system messages show up in the general view.
* **`/me`, `/do` and dice rolls above the head, in the chat, or both.** You pick the server default and every player can override it.
* **"Is typing" indicator** above nearby players.
* **Command autocomplete** with fuzzy search, plus `@` mentions for nearby players and an emoji picker.
* **Per-player settings**: position, scale, width, height, opacity, density, timestamps, sounds and muted channels.
* **Anonymous names** while wearing a mask, per channel.
* **Organization channel** (`/gchat`) with an optional variant the police can read.
* **Image sharing** from an allow-list of domains (disabled by default).
* **Message logs** to the database and to a Discord webhook.
* **Standard chat compatibility**: `exports.chat:addMessage`, `chat:addMessage`, `chat:addSuggestion` and the rest keep working.

## Requirements

| Resource        | Required | Used for                                           |
| --------------- | -------- | -------------------------------------------------- |
| OneSync         | Yes      | Proximity channels                                 |
| `ox_lib`        | Yes      | Commands, keybind, locales                         |
| `oxmysql`       | Yes      | Player settings and logs                           |
| `cuxial_bridge` | Yes      | Connects to your framework (QBox, QBCore or ESX)   |
| `cuxial_gang`   | No       | Gives each organization its own colour in `/gchat` |

{% hint style="warning" %}
Cuxial Chat provides the `chat` resource. The default `chat` resource, and any other chat script, must not run alongside it.
{% 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 and start order.</td><td><a href="/scripts/interface/cuxial-chat/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>Every option in <code>shared/config.lua</code> and the channel list.</td><td><a href="/scripts/interface/cuxial-chat/configuration.md">Configuration</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>Chat commands, keys and who can use what.</td><td><a href="/scripts/interface/cuxial-chat/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>Send messages to the chat from your own resources.</td><td><a href="/scripts/interface/cuxial-chat/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/interface/cuxial-chat/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/interface/cuxial-chat.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.