Skip to content
All documentation

Pausemenu

Pause menu: Instead of the GTA menu, ESC opens a custom fullscreen menu with player info, a 3D map of the whole city and Guide & Rules that the team can edit in game.

Requirements
  • ESX Legacy (es_extended)
  • oxmysql

Features

  • Main menu with Resume, Map, Guide & Rules, Settings, Discord and Leave server. Plus a player card (name, job, grade, cash, bank), time and player count. The camera slowly circles the player meanwhile.
  • 3D map (mapMode = 'script'): The camera flies over the city. The city stays clear – only when you pick a category on the left do its places appear and the camera flies to the nearest one. A click sets a waypoint. Other players and their vehicles are invisible only for you and only while the map is open (no dimension change) – so the map is useless for spying. By default (mapMode = 'gta'), Map opens the normal GTA map.
  • Guide & Rules: Tabs with headings, lists and quotes. Allowed groups edit them right in game, everyone sees changes instantly.
  • Settings opens the GTA settings for graphics, audio and keybinds. P still opens the GTA menu (can be turned off).

Installation

  1. Put the off_pausemenu folder into your resources folder.
  2. Add to your server.cfg – after oxmysql and ESX:
cfg
ensure oxmysql
ensure es_extended
ensure off_pausemenu

The table off_pausemenu_guide is created automatically and filled with example rules on first start.

Configuration

config/settings/config.lua

OptionDefaultDescription
serverInfo.name'OFF Scripts'Server name, shown at the top of the menu and in the UI instead of "OFF SCRIPTS"
serverInfo.locale'de'Language: de, en, pl, fr, es or it
serverInfo.color{ 155, 89, 255 }UI color (RGB)
serverInfo.design3UI design: 1 = Classic, 2 = Receipt, 3 = Storefront
blurtrueBlurred background while the menu is open. In the map it turns sharp again automatically
discordLinkDiscord invite ('' = button hidden)
gtaMenuOnPtruetrue = P opens the GTA menu, false = P also opens this menu
orbitCameratrueCamera circles the player in the menu
mapMode'gta''script' = 3D map from the script, 'gta' = normal GTA map
guide.groups{ 'projektleitung' }ESX groups allowed to edit Guide & Rules
guide.maxTabs / maxLength10 / 8000Max. number of tabs and characters per tab
map.minHeight150.0Minimum camera height above the ground (meters), you can't zoom in close to markers or players
map.categories16 categoriesMap categories: label, sprites (GTA blip IDs) and color

A category shows all blips with these sprites – including those from other scripts. To add your own blips: enter the sprite ID in a category.

config/settings/config.server.lua

OptionPurpose
Webhooks.guideDiscord log when saving/deleting in the guide
Webhooks.leaveDiscord log when someone leaves through the menu

config/functions.lua

FunctionPurpose
ServerPlayerLeft(source)Custom action before a player is disconnected through the menu
ClientCanOpen()false = ESC doesn't open the menu right now (e.g. your own menu is open), also for 0.5 s afterwards
ClientMenuOpened() / ClientMenuClosed()Hide and show your own HUD again

Languages

All texts are in config/locales/<language>.json. For your own language, copy a file, translate it and set locale – keep placeholders like %s and {n} as they are.

In game

  • ESC opens the menu, ESC closes it again. In the map and guide, ESC goes back to the main menu. If you close another menu with ESC (e.g. inventory or garage), the pause menu stays closed. Control with mouse or ↑ ↓ and Enter.
  • Map (mapMode = 'script'): Drag with the left mouse button or WASD = move (Shift = faster), drag with the right mouse button = rotate, mouse wheel = zoom, left click = waypoint, Space = back to your own position. Click a category on the left: its places appear, the camera flies to the nearest one. Click again = next place, × = clear selection. Categories without places aren't shown.
  • Guide & Rules: Allowed groups see Edit, Add tab and Delete tab. With Save for everyone, everyone sees the change.

Common issues

ProblemSolution
[ERROR] or [WARNING] in the consoleThe script checks the setup on start. Read the message, fix it, restart the script.
ESC still opens the GTA menuAnother script opens the pause menu itself – remove that script.
ESC opens the menu inside my menuAdd a check in ClientCanOpen().
Map opens the GTA mapmapMode is set to 'gta'. For the 3D map, enter 'script'.
Map shows no placesThe sprites in map.categories don't match your server's blips.
Discord button is missingdiscord is empty.