> For the complete documentation index, see [llms.txt](https://cylexdev.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cylexdev.gitbook.io/docs/scripts/cylex-animation-menu-v2/introduction.md).

# Introduction

Cylex Animation Menu V2 is an emote menu for FiveM with more than 4,000 animations, shared and group emotes, an emote wheel, sequences, walk styles and expressions. Works with any framework or none.

<div data-full-width="true"><figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2FqDGNqvSB9co0qTE2z4qN%2Fcylex-animation-menu-v2.png?alt=media" alt="Cylex Animation Menu V2"><figcaption></figcaption></figure></div>

Cylex Animation Menu V2 is the emote menu for your FiveM server.\
Players pick animations, dances, walk styles and facial expressions from a searchable menu with GIF previews, or play them with chat commands.\
It needs no framework and no database, and its settings, texts and animation lists are open to edit.

### Key Features <a href="#key-features" id="key-features"></a>

* More than 4,000 animations in the base menu, most of them dances. The Custom Emotes package adds about 1,900 more, with prop emotes and animal emotes.
* A menu with tabs, search, favorites and GIF previews. Three layouts (Default, Medium, Minimal), a theme colour, white silhouette GIFs and a streamer mode.
* Shared emotes with the nearest player, who accepts with Y or declines with H.
* Group emotes: make a group, invite players within 10 meters, and every emote you click plays for the whole group.
* An emote wheel: hold Caps Lock, point at an emote, let go. Up to 24 emotes on 3 pages.
* Sequences: chain animations, then play the chain with `/sequence <id>`.
* Animation position: place and turn your character with a see-through copy before the emote starts.
* Walk styles and expressions that stay after the player logs out and back in.
* 7 shortcut slots on Left Shift plus Numpad 1 to 7.
* Particle effects on some emotes, started with G.
* Optional crouch, crawl, hands up, pointing and ragdoll, off by default.
* Scripts made for dpemotes and rpemotes that use the `animations:client:EmoteCommandStart` event keep working.
* English, Turkish and Korean.

### Installation Steps <a href="#installation-steps" id="installation-steps"></a>

{% content-ref url="/pages/e305EIFdvk4TH9sDE027" %}
[Installation & Configuration](/docs/scripts/cylex-animation-menu-v2/installation-and-configuration.md)
{% endcontent-ref %}

{% content-ref url="/pages/Vjz6SOYdXyBJPUe0cAJG" %}
[Adding New Animations](/docs/scripts/cylex-animation-menu-v2/adding-new-animations.md)
{% endcontent-ref %}

{% content-ref url="/pages/QxdsJBNjmbBnNiwB8tps" %}
[Frequently Asked Questions](/docs/scripts/cylex-animation-menu-v2/frequently-asked-questions.md)
{% endcontent-ref %}

{% content-ref url="/pages/R8Sm93kjRBuhr08Iy7H7" %}
[Troubleshooting Common Issues](/docs/scripts/cylex-animation-menu-v2/troubleshooting-common-issues.md)
{% endcontent-ref %}

### Dependencies <a href="#dependencies" id="dependencies"></a>

| Dependency            | Required | Notes                                                                                                                                           |
| --------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| A framework           | No       | Works with QBCore, Qbox, ESX or without a framework. The events in `SpawnEvents` put the walk style and expression back after login.            |
| A database            | No       | No tables and no `.sql` file. Player settings are saved on each player's own computer.                                                          |
| Custom Emotes package | Optional | About 1,900 more animations, with prop emotes and animal emotes. Sold separately or in the bundle. Needs `CustomEmotes = true` in `config.lua`. |

### What You Can Edit <a href="#what-you-can-edit" id="what-you-can-edit"></a>

| File / Folder                   | Editable?                                                                              |
| ------------------------------- | -------------------------------------------------------------------------------------- |
| `config.lua`                    | Yes — all settings, keys, tabs, commands, exports and the checks before an emote plays |
| `locales/*.lua`                 | Yes — every text players see                                                           |
| `animations/*.lua`              | Yes — the base lists: emotes, dances, expressions, walks, shared emotes                |
| `animations/AnimationList.json` | Yes — the list of the Custom Emotes package                                            |
| `client/`, `server/`            | No — escrow-protected                                                                  |
| `html/`                         | No — the built menu                                                                    |

### Support <a href="#support" id="support"></a>

Store: <https://cylexdev.com>\
Discord: <https://discord.gg/cylexstore>