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

# Configuration

***

## <mark style="color:blue;">Emote Menu Script Configuration Guide</mark>

This guide provides detailed instructions for configuring the **STG Emote Menu Script** for FiveM. This script allows players to access an emote menu, offering options for in-game animations, vehicle usage, and custom keybinds.

***

#### <mark style="color:blue;">Main Configuration</mark>

<mark style="color:green;">**Config.Debug**</mark>

* **Description**: Enables debug mode for the script. Set to `true` to enable detailed debug prints in the console for troubleshooting.
* **Example**:

  ```lua
  Config.Debug = false -- true or false
  ```

<mark style="color:green;">**Config.InCar**</mark>

* **Description**: Determines if emotes can be used in vehicles. Setting this to `true` will allow emotes to be used while in a vehicle.
* **Example**:

  ```lua
  Config.InCar = false -- true or false
  ```

<mark style="color:green;">**Config.MoveWhileOpen**</mark>

* **Description**: Allows players to move while the emote menu is open if set to `true`. Set to `false` to restrict movement when the menu is open.
* **Example**:

  ```lua
  Config.MoveWhileOpen = false -- true or false
  ```

<mark style="color:green;">**Config.CloseOnPlay**</mark>

* **Description**: Closes the emote menu automatically after an emote is selected. Set to `true` to close the menu upon selection, or `false` to keep it open.
* **Example**:

  ```lua
  Config.CloseOnPlay = true -- true or false
  ```

***

#### <mark style="color:blue;">Command Configuration</mark>

Each command has a customizable keybind, description, and function. Below are the primary commands for the emote menu.

<mark style="color:green;">**Command:**</mark><mark style="color:green;">**&#x20;**</mark><mark style="color:green;">**`emotemenu`**</mark>

* **Keybind**: `F3`
* **Description**: Opens the emote menu for selecting animations.
* **Example**:

  ```lua
  Config.Commands["emotemenu"] = {
      Keybind = 'F3',
      Description = 'Open Emote Menu'
  }
  ```

<mark style="color:green;">**Command:**</mark><mark style="color:green;">**&#x20;**</mark><mark style="color:green;">**`cancel`**</mark>

* **Keybind**: `X`
* **Description**: Cancels the currently playing animation.
* **Example**:

  ```lua
  Config.Commands["cancel"] = {
      Keybind = 'X',
      Description = 'Cancel the current animation'
  }
  ```

<mark style="color:green;">**Command:**</mark><mark style="color:green;">**&#x20;**</mark><mark style="color:green;">**`accept`**</mark>

* **Keybind**: `Z`
* **Description**: Accepts a shared emote request from a nearby player.
* **Example**:

  ```lua
  Config.Commands["accept"] = {
      Keybind = 'Z',
      Description = 'Accept the shared Emote request.'
  }
  ```

***