Installation
Dependencies
| Dependency | Required | Why |
|---|---|---|
| Framework (ESX / QBCore / QBox / ox_core / vRP) | No | Auto-detected; also runs standalone |
| HZ-Bridge | No | Optional — live theme cascade + in-panel admin config |
| HZ-Loading | No | Optional — shares one keybinds source if present |
ox_lib | No | Not used; compatible if you run it |
| Database | No | None. Player settings live in client KVP |
There is no hard dependency. HZ-PauseMenu boots on a bare server and detects your framework on its own.
Steps
- Drop the
HZ-PauseMenufolder into yourresourcesdirectory. - (Optional) if you use HZ-Bridge, ensure it first so the theme applies at first paint:
ensure HZ-Bridge
ensure HZ-PauseMenu
- Add
ensure HZ-PauseMenu(on its own if you don't run HZ-Bridge). - Reconnect.
npm install.
What you should see
Pressing Escape now opens HZ-PauseMenu instead of the native GTA V menu. The default configuration already works on any framework: profile, map, settings and a Discord button, in English.
The native GTA V Settings screen is still reachable from the Settings → GTA V Settings card — and it is recoloured to your accent.
Confirming it works
- Press Escape — the HZ-PauseMenu NUI should open (not the stock Rockstar menu).
- Open the Profile tab — your identity, vitals, licenses and wallet should be filled from your framework.
If the profile shows
-- for a field, your framework simply doesn't expose it (base ESX has no nationality column, for example). See Config.DefaultNationality and the framework notes in Configuration.