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

# Cuxial Emotes

Emote menu for FiveM with a searchable catalog, favorites, props, paired emotes, zones and a photo mode.

Cuxial Emotes gives your players one menu for every animation on the server: emotes, scenarios, walk styles and facial expressions. It also handles props, paired emotes that the other player accepts, and a free camera for screenshots.

## What it does

* **Catalog with search and filters.** Categories, automatic tags, recents, most used and a "new" badge for recently added emotes.
* **Favorites and quick emotes.** Each player keeps favorites and quick sets, played with Shift + 1-5.
* **Props.** Emotes attach their props and show them to nearby players.
* **Paired emotes.** A synchronized emote sends a request to the other player, who accepts or rejects it with a key. Players can also suggest an emote to someone else.
* **Walk styles and expressions.** Saved per character and restored on the next session.
* **Movement shortcuts.** Pointing, hands up, crossed arms, ragdoll, crouch and prone, each on its own key.
* **Position editor.** Players move and rotate their character while an emote is playing.
* **Photo mode.** Free camera with filters, zoom and depth of field.
* **Broken emote reports.** Players flag an emote from the menu. The report is stored and can be sent to Discord.
* **Emote zones (optional add-on).** Staff draw areas on the map where an extra set of emotes becomes available.
* **Relations module (optional add-on).** Off unless the add-on is running.

{% hint style="info" %}
Emote zones and the relations module need the optional add-on `cuxial_emotes_dlc`. Without it, Cuxial Emotes works as a regular emote menu and both stay off. No option in `shared/config.lua` turns them on: starting the add-on does.
{% endhint %}

## Requirements

| Resource            | Needed   | Purpose                                                                 |
| ------------------- | -------- | ----------------------------------------------------------------------- |
| OneSync             | Required | Declared in the manifest                                                |
| `ox_lib`            | Required | Callbacks, keybinds, locales, notifications                             |
| `oxmysql`           | Required | Player data, zones and reports                                          |
| `cuxial_bridge`     | Required | Connects the script to your framework (QBox, QBCore or ESX)             |
| `cuxial_emotes_dlc` | Optional | Add-on: emote zones and relations module                                |
| `cuxial_diseases`   | Optional | Tests and contagion of the relations module. Without it they do nothing |
| `ox_inventory`      | Optional | Only for the items of the relations module                              |

## 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, start order and the final check.</td><td><a href="/scripts/interface/cuxial-emotes/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>Every option in the config, plus how to add your own emotes.</td><td><a href="/scripts/interface/cuxial-emotes/configuration.md">Configuration</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>Commands, default keys and what staff can do.</td><td><a href="/scripts/interface/cuxial-emotes/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>Play, cancel and query emotes from other resources.</td><td><a href="/scripts/interface/cuxial-emotes/developers.md">Exports &amp; events</a></td></tr><tr><td><strong>Troubleshooting</strong></td><td>Common problems, their cause and the fix.</td><td><a href="/scripts/interface/cuxial-emotes/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-emotes.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.