Installation Guide

This document explains the full installation proccess and config.lua file used by the resource. Every section is described in detail so server owners can easily customize the PauseMenu their needs.

Step 1: Configure your PauseMenu

---

Framework Setup

Choose which framework your server uses.

Config.frameworkType = "ESX"

Supported frameworks:

Framework	Value
ESX	"ESX"
QBOX	"QBOX"
QBCore	"QBCore"

Example configurations:

Config.frameworkType = "ESX"

Config.frameworkType = "QBOX"

Config.frameworkType = "QBCore"

Important: If the framework type is incorrect, player data such as job, money or gang may not load correctly. In client_editable and server_editables files you can define your own framework.

---

UI Settings

All interface related configuration is stored inside:

Config.uiSettings = {}

---

Accent Colors

Defines the default UI gradient colors.

['defaultAccentA'] = 'rgb(251, 167, 236)'
['defaultAccentB'] = 'rgb(163,163,163)'

These colors are used across the interface and can be changed by players in the UI settings menu.

---

Navigation Bar

Controls which buttons appear in the top navigation bar.

['navBar'] = {
    ['map'] = true,
    ['rules'] = true,
    ['pages'] = true,
    ['keybinds'] = true,
    ['gameSettings'] = true,
    ['uiSettings'] = true,
    ['darkModeLightModeToggle'] = true,
}

Option	Description
map	Opens the map
rules	Shows server rules
pages	Opens custom pages
keybinds	Shows server shortcuts
gameSettings	Opens GTA settings
uiSettings	Opens UI customization
darkModeLightModeToggle	Switch between dark and light theme

Setting a value to false hides the button.

---

Custom Navigation Buttons

You can add custom buttons to the pause menu.

['customNavBar'] = {
    ['inventory'] = {
        ['label'] = 'INVENTORY',
        ['command'] = 'openInventoryPauseMenu',
        ['icon'] = 'inventory.svg',
    },
}

Field	Description
label	Button label
command	Client command executed
icon	Icon file located in html/icons

Icons must be placed inside:

html/icons/

---

Player Statistics

Controls which player information is visible in the statistics panel.

['statistic'] = {
    ['idAndName'] = true,
    ['job'] = true,
    ['gang'] = true,
    ['cash'] = true,
    ['bank'] = true,
    ['playtime'] = true,
    ['currentPlayers'] = true,
}

Displayed information depends on the framework and server integrations.

---

Social Links

Add links to your community platforms.

['links'] = {
    ['discord'] = 'https://discord.com/',
    ['tiktok'] = 'https://www.tiktok.com/',
    ['tebex'] = 'https://pinkfrog.tebex.io',
}

Platform	Purpose
Discord	Community server
TikTok	Social media
Tebex	Donations / store

---

Max Players

Defines the maximum server player count used for the player counter.

['maxPlayers'] = 250

Setting this value to 0 hides the player counter.

---

Permissions

Defines which permission groups can edit specific features.

Config.permissionsToEdit = {
    ['rules'] = {'admin', 'superadmin', 'god'},
    ['pages'] = {'admin', 'superadmin', 'god'},
    ['announcements'] = {'admin', 'superadmin', 'god', 'mod'},
    ['keybinds'] = {'admin', 'superadmin', 'god'},
    ['keybindsAdd'] = {'admin', 'superadmin', 'god'},
}

Section	Who can edit
rules	Admins
pages	Admins
announcements	Admins + moderators
keybinds	Admins
keybindsAdd	Admins

---

Animation Settings

Controls the animation played when opening the pause menu.

Config.animationSettings = {
    ['enable'] = true,
    ['dict'] = "amb@world_human_tourist_map@male@base",
    ['anim'] = 'base',
    ['prop'] = 'prop_tourist_map_01',
    ['bone'] = 28422,
    ['placement'] = {0.0, 0.0, 0.0, 0.0, 0.0, 0.0},
    ['loop'] = true
}

Property	Description
enable	Enables animation
dict	Animation dictionary
anim	Animation name
prop	Attached prop
bone	Player bone index
placement	Position offset
loop	Loop animation

To disable the animation:

['enable'] = false

---

Localization

Defines which language the UI uses.

Config.useLocale = 'en'

Supported languages:

Language	Value
English	en
Polish	pl

Example:

Config.useLocale = 'pl'

---

Translations

All interface text is stored inside Config.translations.

Config.translations = {
    ['en'] = {
        pausedTitle = 'XYZ RP',
        navMap = 'MAP',
        navRules = 'RULES'
    }
}

To add a new language:

1. Copy an existing translation block

2. Rename the language key

3. Replace the text values

---

---