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

# JGS Pause Menu

A full pause-menu replacement for FiveM — standalone, self-contained, configurable to the last key.

**What is JGS Pause?** JGS Pause is a full pause-menu replacement for FiveM, built with a Vue 3 NUI. It intercepts <kbd>ESC</kbd> and opens a custom, self-contained interface with server information, an online-player list, vehicle controls, a two-board announcement system, a three-queue support/ticket system, a built-in PDF rules reader and per-player settings.

It is **standalone**: it needs no framework at all to run. If your server has one, every framework-dependent feature — player data, job, money, permissions, notifications — works out of the box on **ESX Legacy**, **QBCore**, **Qbox** (`qbx_core`) and **Ox Core**. Detection is automatic; there is nothing to configure.

The whole interface is **self-contained**: no icon CDN, no web fonts, no avatar service. A client with no internet access sees exactly the same menu as one with a fibre connection.

***

{% hint style="info" %}
With JGS Pause you gain access to a wide range of essential features:
{% endhint %}

1. **Custom pause menu:** <kbd>ESC</kbd> is intercepted and the native GTA pause menu is suppressed — with a configurable cost/behaviour trade-off, down to zero native calls per frame while you are just playing.
2. **Home tab:** a map card plus configurable action buttons and social links, all editable from `config/home.lua`.
3. **Vehicle tab:** engine, horn, lights and windows out of the box, plus live fuel/engine/body gauges. Only visible while you're in a vehicle. A lock button is wired up but hidden until you point it at your own keys resource — a button with nothing behind it is never drawn, and the server console names what is still unconfigured on every start.
4. **Online players:** a live list with search, favourites and a staff filter, with fully configurable per-player fields (id, ping, job, grade, Discord).
5. **Staff & job announcements:** two independent boards, published from the menu, with edit/delete, image verification and persistence across restarts.
6. **Support tickets:** three independent queues — reports, bugs and questions — each with chat, internal staff notes, transfer, audit and screenshot evidence.
7. **Private chat:** two players open a conversation from the Online Players tab — request, accept, block — in a panel beside the menu. Staff cannot read it; a participant can hand the thread over as a support case with one button.
8. **Server rules reader:** a built-in PDF viewer beside the menu, with thumbnails, zoom and full-text search — works even on CEF builds with no PDF plugin.
9. **Player settings:** name/avatar source, interface density, text size, tooltips, accent colour and fully custom shortcuts — everything stored per machine.
10. **Restarts, safe zones and Discord identity:** a live restart countdown (with optional txAdmin sync), safe-zone detection with hooks for your own logic, and Discord names/avatars over state bags.
11. **Everything is configurable:** every feature above has a switch, and every sensitive setting is kept out of the player's machine by design — see Configuration.

JGS Pause combines functionality and aesthetics while staying completely safe by design: the server is authoritative for every action, no identifiers ever reach the client, and every network entry point is rate-limited. Configure it to match your server, and let your players enjoy a pause menu that feels like part of the product instead of a bolted-on script.

***

### Where to go

<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>🚀 Getting started</strong></td><td>Dependencies, installation and the two credentials. Ten minutes on a server that already runs <code>ox_lib</code>.</td><td></td></tr><tr><td><strong>🖥 The menu</strong></td><td>What your players see, tab by tab: home, vehicle, players, announcements, support, private chat, rules and settings.</td><td></td></tr><tr><td><strong>🛡 Staff &#x26; moderation</strong></td><td>Duty, the five moderation actions and the image review queue — and the rules that hold them together.</td><td></td></tr><tr><td><strong>⚙ Configuration</strong></td><td>Every key you can change, in the two drawers that split what the player sees from what they never do.</td><td></td></tr><tr><td><strong>🛠 Developers</strong></td><td>Exports, commands, the event surface, and the <code>custom/</code> folder that ships outside escrow.</td><td></td></tr><tr><td><strong>🧰 Maintenance</strong></td><td>Troubleshooting by symptom, and how updates work.</td><td></td></tr></tbody></table>

### The three pages to read first

{% hint style="warning" %}
The third one is not optional reading. **The Vehicle tab is the one part of JGS Pause that ships incomplete on purpose** — its lock and repair buttons are not drawn until you point them at your own resources, and the fuel gauge needs to know which fuel system you run. Five minutes there before you go live.
{% endhint %}