> 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-pausemenu/installation.md).

# Installation

Install Cuxial Pause Menu step by step: dependencies, convars and start order.

Cuxial Pause Menu needs no SQL import and no inventory items. It stores nothing in the database.

{% stepper %}
{% step %}

## Check the dependencies

These resources must be installed and working before you add the menu:

* `ox_lib`
* `cuxial_bridge`, with one of the supported frameworks: QBox, QBCore or ESX
* OneSync enabled on the server
  {% endstep %}

{% step %}

## Copy the resource

Place the `cuxial_pausemenu` folder inside your `resources` directory. Keep the folder name as it is.

The interface is already built in `web/dist`. You do not need to compile anything.
{% endstep %}

{% step %}

## Remove any other pause menu

Delete or comment out every line that starts another pause menu resource:

{% code title="server.cfg" %}

```cfg
# ensure your_old_pause_menu
```

{% endcode %}

{% hint style="danger" %}
Two pause menus fight over <kbd>Esc</kbd>. Cuxial Pause Menu also closes the GTA pause screen whenever another resource opens it. Leave only one.
{% endhint %}
{% endstep %}

{% step %}

## Set the convars

Both are optional.

{% code title="server.cfg" %}

```cfg
# Language of the menu (en and es are included)
setr ox:locale "en"

# Debug traces in the server console
set cuxial_pausemenu_debug "0"
```

{% endcode %}
{% endstep %}

{% step %}

## Start the resource

Start the menu after its dependencies and after your framework:

{% code title="server.cfg" %}

```cfg
ensure ox_lib
# your framework here (qbx_core, qb-core or es_extended)
ensure cuxial_bridge
ensure cuxial_pausemenu
```

{% endcode %}
{% endstep %}

{% step %}

## Check that it works

1. Join the server and press <kbd>Esc</kbd>. The side frame opens and the GTA pause screen does not show.
2. Check the header: time, players online, your id, cash and bank.
3. Pick **Map**. The GTA map opens directly. Close it with <kbd>Esc</kbd>.
4. Outside the menu, press <kbd>P</kbd>. The map opens without the frame.
5. Pick **Settings**. The GTA settings open.
   {% endstep %}
   {% endstepper %}

Next: put your server name, rules and social networks in [Configuration](/scripts/interface/cuxial-pausemenu/configuration.md).


---

# 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-pausemenu/installation.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.