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

# Cuxial Pause Menu

Custom pause menu for FiveM: a side frame over the game with server info, rules and shortcuts to the map and settings.

Cuxial Pause Menu replaces the GTA pause screen with a side frame that leaves the game visible. It shows the player's data, the state of the city and four shortcuts: back to the game, map, settings and quit.

## What it does

* **Replaces the pause screen.** <kbd>Esc</kbd> opens the frame instead of the GTA menu. The GTA map and settings are still one click away.
* **Header with live data**: city time, players online, server id, cash, bank, latency and an optional extra currency.
* **Character card**: name, identifier, job with grade, and gang.
* **The city right now**: weather, time of day, police and medics on duty.
* **Rules and community** lists written in the config.
* **Direct map key.** <kbd>P</kbd> opens the GTA map without going through the menu.
* **Presence icons** above the head of nearby players who have the menu or the map open.
* **Quit with confirmation**: disconnect from the server or close the game.
* **GTA map and settings recoloured** to match the interface.

## Requirements

| Resource        | Required | Used for                                         |
| --------------- | -------- | ------------------------------------------------ |
| OneSync         | Yes      | Presence icons between players                   |
| `ox_lib`        | Yes      | Keys, locales and callbacks                      |
| `cuxial_bridge` | Yes      | Connects to your framework (QBox, QBCore or ESX) |

No database and no inventory items.

{% hint style="warning" %}
Cuxial Pause Menu takes over <kbd>Esc</kbd> and closes the GTA pause screen every time it appears. It cannot run next to another pause menu resource.
{% endhint %}

{% hint style="info" %}
On ESX the duty counters go by job name. The gang tag is shown on QBox and QBCore. See [Configuration](/scripts/interface/cuxial-pausemenu/configuration.md).
{% endhint %}

## 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, convars and start order.</td><td><a href="/scripts/interface/cuxial-pausemenu/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>Every option in <code>shared/config.lua</code>.</td><td><a href="/scripts/interface/cuxial-pausemenu/configuration.md">Configuration</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>Keys and how the menu is used.</td><td><a href="/scripts/interface/cuxial-pausemenu/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>Read who has the menu open from your own resources.</td><td><a href="/scripts/interface/cuxial-pausemenu/developers.md">Exports &amp; events</a></td></tr><tr><td><strong>Troubleshooting</strong></td><td>Common problems and how to fix them.</td><td><a href="/scripts/interface/cuxial-pausemenu/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-pausemenu.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.