> For the complete documentation index, see [llms.txt](https://nanoscripts.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://nanoscripts.gitbook.io/docs/scripts/nn_animations.md).

# nn\_animations

## nn\_animations

Welcome to **nn\_animations** — a polished animation and emote menu for your FiveM server. It gives your players a beautiful, modern way to browse and play animations: a smooth coverflow carousel, four hand-crafted themes, favourites and key binds, a radial wheel, a simple `/e` chat command, and even an in-game studio for capturing your own custom animation previews. Everything is built on **community\_bridge**, so it works the same whether your server runs QBox, QBCore or ESX.

This page is a friendly, high-level tour of what nn\_animations is and what it can do. When you are ready to get it running, head over to the **Installation** page next.

{% hint style="info" %}
**At a glance** — Resource: `nn_animations` · Author: nanoscripts · Version: 1.0.2 · Frameworks: QBox, QBCore, ESX (via community\_bridge).
{% endhint %}

#### What is nn\_animations?

nn\_animations is a drop-in emote menu. Your players press a key (F3 by default) or type `/animations`, browse a clean carousel of animations grouped into tabs, and click a card to play it. They can star their favourites, bind them to keys, and flick through them on a hold-to-open radial wheel — all without ever leaving the game.

It is designed to feel great out of the box, while still being easy for you to make your own: switch the theme, change the language, and add your own animations through the built-in capture studio or a simple JSON file.

#### Who is it for?

* **Server owners** who want a premium emote menu that just works on their framework, with no scripting required.
* **Roleplay communities** that want favourites, key binds and persistent walk styles for their players.
* **Content creators and developers** who want to capture their own custom animation previews and import them in bulk.

{% hint style="success" %}
You do not need to be a developer to use nn\_animations. The defaults are sensible, the configuration is plain-English, and per-player favourites, binds and themes are saved automatically.
{% endhint %}

#### Headline features

Here is everything nn\_animations brings to your server, at a glance.

| Feature                               | What it does                                                                                                                     |
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Coverflow carousel + compact grid** | A smooth coverflow menu, with an optional compact grid variant. Each player picks the layout they prefer, and the choice sticks. |
| **4 themes**                          | Choose from `normal`, `arcade`, `cyberpunk` and `rugged`, with an optional live game-blur behind the menu.                       |
| **Favourites**                        | Star any card to save it to the Favourites tab.                                                                                  |
| **Key binds**                         | Bind a favourite to a key and trigger it while the menu is closed; manage them all in the Binds tab.                             |
| **Favourites radial wheel**           | Hold a key to fan out your favourites in a radial wheel — release over a segment to play it, or release in the centre to cancel. |
| **`/e` command**                      | Play any animation instantly by its short card name, e.g. `/e wave`.                                                             |
| **Cancel keybind + overlay**          | Stop the current animation with a key, with a tidy on-screen "Animation Canceled" overlay.                                       |
| **Walk styles & expressions**         | Persistent walk styles that survive a relog, plus per-session facial expressions.                                                |
| **8 languages**                       | Built-in translations for the UI labels and the default category/navbar names.                                                   |
| **Per-player persistence**            | Favourites, binds, theme, compact toggle and walk style are saved per player via oxmysql.                                        |
| **Capture studio**                    | An in-game studio (`/animstudio`) that records transparent WebP previews on a chroma backdrop.                                   |
| **Bulk JSON import**                  | Add many custom animations at once from a simple JSON file.                                                                      |

#### A quick taste of the controls

You will find the full reference on the later pages, but here are the headline interactions so you know what to expect.

| Action                  | Default                      | What happens                                                                         |
| ----------------------- | ---------------------------- | ------------------------------------------------------------------------------------ |
| Open the menu           | `F3` or `/animations`        | Opens the carousel menu.                                                             |
| Play by name            | `/e <name>`                  | Plays an animation by its card name, e.g. `/e wave`.                                 |
| Cancel animation        | `Backspace` or `/cancelanim` | Stops the current animation and flashes the cancel overlay.                          |
| Favourites radial wheel | Hold `X`                     | Fan out your favourites; release over a segment to play, or in the centre to cancel. |
| Capture studio          | `/animstudio`                | Opens the in-game preview-capture studio.                                            |

{% hint style="info" %}
The open-menu and cancel keys are rebindable in **FiveM Settings > Key Bindings**. The radial wheel key is a raw key set in the config, so it is changed by editing the config rather than from the settings menu.
{% endhint %}

#### What you will need

nn\_animations stands on a few dependencies. The Installation page walks through each one — this is just so you know what to gather first.

| Dependency            | Why it is needed                                                                            |
| --------------------- | ------------------------------------------------------------------------------------------- |
| **community\_bridge** | Framework abstraction so the same resource works on QBCore, ESX and QBox.                   |
| **nn\_lib**           | Library dependency used for our scripts.                                                    |
| **oxmysql**           | Saves per-player preferences. The `nn_animations_prefs` table auto-creates — no SQL import. |
| **screenshot-basic**  | Powers the capture studio. It ships with FiveM server artifacts.                            |

{% hint style="warning" %}
**nn\_lib must start before nn\_animations.** A built-in guard will print a clear message and stop the resource if nn\_lib is not started first. The Installation page shows the exact `ensure` order for your `server.cfg`.
{% endhint %}

#### Make it your own

Out of the box you can:

* **Switch the look** — pick one of the four themes and toggle the live game-blur.
* **Change the language** — set one of the eight language codes and restart; no rebuild needed.
* **Add your own animations** — capture previews one at a time in the studio, or import many at once from a JSON file.

#### What's next

Ready to install? Continue to the **Installation** page, where we place the resource, set up the dependencies, build the menu, and add the `ensure` lines to your `server.cfg` in the right order. From there, the **Configuration**, **Using the Menu**, **Adding Animations** and **Troubleshooting** pages cover everything else.

{% hint style="success" %}
Once installed, your players open the menu with **F3** or **`/animations`** and start animating right away.
{% endhint %}