⏯️Pause Menu

Docs needed to run script on any ESX / QB / QBox server

---

Overview

XeX PauseMenu is a premium, feature-rich pause menu designed for FiveM roleplay servers. Built with modern web technologies (HTML5, CSS3, JavaScript) and optimized for performance, it provides players with a beautiful glassmorphism-styled interface while giving server owners complete control.

Supported Frameworks

Framework	Version	Status
ESX Legacy	1.6.0+	✅ Full Support
QBCore	Latest	✅ Full Support
QBox	Latest	✅ Full Support

---

Features Summary

Core Features

Category	Feature	Description
UI	Glassmorphism Design	Modern translucent glass effect UI
UI	10 Theme Presets	Dark, Light, Glass, Midnight, Emerald, Sunset, Rose, Ocean, Gold, Neon
UI	Auto Theme	Automatic day/night theme based on in-game time
UI	Responsive	Supports 1080p to 4K resolutions
Customizer	Drag & Drop	Reposition cards freely
Customizer	Color Pickers	Full color customization
Customizer	UI Scale	70% - 130% scaling
Customizer	Presets	Save/Load/Export/Import custom presets
Customizer	Per-Player	Settings saved per player
Info	Player Stats	HP, Armor, Hunger, Thirst, Stress
Info	Vehicle Info	Model, Plate, Fuel, Speed, Engine
Info	Location	Street, Zone, Heading, Coords (admin)
Info	Weather	Weather icon + Temperature (in DateTime card)
Info	Time	Real time + In-game time
Info	Server	Online players, Job counts
Info	Money	Cash, Bank, Crypto, Dirty Money
Social	Custom Links	Website, Discord, Rules, Guides
Social	Social Media	Twitter, Instagram, YouTube, TikTok, Twitch
Reports	Categories	Bug, Player, Support, Suggestion
Reports	Discord Webhook	Automatic Discord integration
Reports	Admin Notifications	In-game alerts to admins
Framework	Multi-Framework	ESX, QBCore, QBox with auto-detection
I18n	12 Languages	EN, ES, PT, FR, DE, IT, PL, NL, TR, ZH, RU, AR
Performance	Optimized	0.00ms when closed
Updater	Auto-Update Check	Notifies of new versions

---

Installation

Requirements

• FiveM Server Build 5181+

• OneSync Enabled

• Framework: ESX Legacy, QBCore, or QBox

• Optional: ox_lib (for enhanced notifications)

Quick Start

1

Extract to your resources folder

2

Rename folder to 'xex_pausemenu' if needed

3

Add to server.cfg:

ensure xex_pausemenu

4

Configure config.lua

5

Configure svconfig.lua (webhooks, tracked jobs)

6

Restart server

Recommended Resource Order

# server.cfg
ensure oxmysql
ensure ox_lib          # Optional but recommended
ensure es_extended     # or qb-core / qbox
ensure xex_pausemenu

---

Configuration

Framework Settings

-- config.lua
Config.Framework = 'auto' -- 'auto' | 'esx' | 'qb' | 'qbox'
Config.AutoDetectOrder = {'qbox', 'qb', 'esx'}

Value	Behavior
'auto'	Detects framework automatically (recommended)
'esx'	Force ESX Legacy
'qb'	Force QBCore
'qbox'	Force QBox

Keybind Settings

Config.Keybind = 'ESC'         -- 'ESC' | 'F1'-'F10' | 'NONE'
Config.OpenCommand = 'pausemenu' -- Command to open (nil to disable)

Keybind	Behavior
'ESC'	Replaces native pause menu completely
'F1'-'F10'	Opens with F-key, ESC still opens native
'NONE'	Only command works

Server Information

Config.ServerName = 'Your Server Name'
Config.ServerLogo = 'img/logo.webp' -- Path relative to web/ folder, or nil
Config.ServerSlogan = 'The best roleplay experience'

Display Options

Player Information

Config.ShowPlayerInfo = {
    name = true,         -- Character name
    id = true,           -- Server ID
    job = true,          -- Current job + grade
    gang = true,         -- Gang (QB/QBox only)
    phoneNumber = true,  -- Phone number (auto-detected)
    money = true,        -- Cash, Bank, Crypto, Dirty Money
    playTime = true,     -- Session time
}

Phone Number Auto-Detection:

• qs-smartphone

• lb-phone

• npwd

• gcphone

• gksphone

• roadphone

• high-phone

• yflip-phone

• d-phone

• renewed-phone

• QB/QBox charinfo.phone (fallback)

Server Information

Config.ShowServerInfo = {
    onlinePlayers = true,  -- Current/Max players
    maxPlayers = true,
    policeCount = true,    -- Jobs are configured in svconfig.lua
    emsCount = true,
    mechanicCount = true,
}

Player Stats

Config.ShowPlayerStats = {
    enabled = true,
    health = true,
    armor = true,
    hunger = true,    -- Requires esx_status (ESX) or built-in (QB)
    thirst = true,
    stress = true,    -- QB/QBox only
}

Vehicle Information

Config.ShowVehicleInfo = {
    enabled = true,
    model = true,
    plate = true,
    fuel = true,      -- Auto-detects fuel resource
    speed = true,
    engine = true,
}

Fuel Resource Auto-Detection:

• ox_fuel

• LegacyFuel

• ps-fuel

• cdn-fuel

• okokGasStation

• lj-fuel

• Native fallback

Location

Config.ShowLocation = {
    enabled = true,
    streetName = true,
    zoneName = true,
    heading = true,        -- N, NE, E, SE, S, SW, W, NW
    coords = false,        -- X, Y, Z (always visible for admins)
}

Date/Time

Config.ShowDateTime = {
    enabled = true,
    realTime = true,
    inGameTime = true,
    weather = true,
}

Menu Buttons

Config.Buttons = {
    map = true,       -- Opens GTA map
    settings = true,  -- Opens customizer
    report = true,    -- Opens report modal
    inventory = false, -- Future: inventory integration
    phone = false,    -- Future: phone integration
}

Social Links

Config.SocialLinks = {
    enabled = true,
    
    -- Main action buttons
    mainLinks = {
        {
            id = 'website',
            label = 'WEBSITE',
            icon = 'globe',       -- FontAwesome icon name
            url = 'https://your-server.com',
            enabled = true,
            color = '#3B82F6'
        },
        {
            id = 'discord',
            label = 'DISCORD',
            icon = 'discord',
            url = 'https://discord.gg/your-server',
            enabled = true,
            color = '#5865F2'
        },
        {
            id = 'rules',
            label = 'RULES',
            icon = 'scroll',
            url = 'https://your-server.com/rules',
            enabled = true,
            color = '#EF4444'
        },
        {
            id = 'guides',
            label = 'GUIDES',
            icon = 'book-open',
            url = 'https://your-server.com/guides',
            enabled = true,
            color = '#10B981'
        },
    },
    
    -- Social media icons (bottom row)
    socialMedia = {
        {id = 'twitter', icon = 'twitter', url = 'https://twitter.com/...', enabled = true, color = '#FFFFFF'},
        {id = 'instagram', icon = 'instagram', url = 'https://instagram.com/...', enabled = true, color = '#E4405F'},
        {id = 'youtube', icon = 'youtube', url = 'https://youtube.com/...', enabled = true, color = '#FF0000'},
        {id = 'tiktok', icon = 'tiktok', url = 'https://tiktok.com/...', enabled = false, color = '#FFFFFF'},
        {id = 'twitch', icon = 'twitch', url = 'https://twitch.tv/...', enabled = false, color = '#9146FF'},
    }
}

Available Icons:

• Main: globe, discord, scroll, book-open, link, gamepad, headset, store

• Social: twitter, instagram, youtube, tiktok, twitch, facebook

Report System

Config.ReportSystem = {
    enabled = true,
    categories = {
        {id = 'bug', label = '🐛 Bug Report', color = '#F59E0B'},
        {id = 'player', label = '👤 Player Report', color = '#EF4444'},
        {id = 'support', label = '❓ Support Request', color = '#3B82F6'},
        {id = 'suggestion', label = '💡 Suggestion', color = '#10B981'},
    },
    minMessageLength = 20,    -- Minimum characters
    cooldown = 60,            -- Seconds between reports
    notifyAdmins = true,      -- In-game notification to admins
    sendToDiscord = true,     -- Send to webhook
}

Disconnect Options

Config.Disconnect = {
    showConfirmation = true,
    leaveMessage = 'Thanks for playing! See you soon! 👋',
    options = {
        disconnect = true,      -- Disconnect from server
        quitGame = true,        -- Close FiveM
        characterSelect = true, -- Return to character selection
    }
}

UI Customization

Config.UI = {
    theme = 'dark',           -- Default theme: 'dark' | 'light'
    accentColor = '#3B82F6',  -- Primary color
    blurIntensity = 10,       -- Background blur
    glassmorphism = true,     -- Glass effect
    animationSpeed = 'normal', -- 'slow' | 'normal' | 'fast'
    sounds = {
        enabled = true,
        open = true,
        close = true,
        hover = true,
        click = true,
    },
    layout = 'modern',
    hideRadar = true,         -- Hide minimap when open
    showOverlay = true,       -- Dark overlay behind menu
    overlayOpacity = 0.7,
    enableCustomizer = true,  -- Allow player customization
}

Customizer Options

Control what players can customize:

Config.CustomizerOptions = {
    -- Enable/disable entire tabs
    tabs = {
        theme = true,    -- Theme, background, animations
        colors = true,   -- Color customization
        layout = true,   -- Drag & drop, visibility
        cards = true,    -- Card styles
        presets = true,  -- Save/load presets
    },
    
    -- Theme tab
    theme = {
        baseTheme = true,         -- Theme selection
        autoTheme = true,         -- Auto day/night
        backgroundOpacity = true, -- Overlay opacity
        backgroundImage = true,   -- Custom background
        cardOpacity = true,       -- Card transparency
        animations = true,        -- Enable/disable
        animationSpeed = true,    -- Speed slider
        displayMode = true,       -- Fullscreen/Boxed
        uiScale = true,           -- Scale slider
    },
    
    -- Colors tab
    colors = {
        mainColors = true,        -- Primary, Secondary, Accent
        backgroundColors = true,  -- Background colors
        textColors = true,        -- Text colors
        statusBarColors = true,   -- HP, Armor, etc.
        jobColors = true,         -- Police, EMS, Mechanic
    },
    
    -- Layout tab
    layout = {
        editMode = true,          -- Drag & drop
        cardVisibility = true,    -- Show/hide cards
        columnLayout = true,      -- Column count
        resetPositions = true,    -- Reset button
    },
    
    -- Cards tab
    cards = {
        cardStyle = true,         -- Glass, Solid, Minimal, Neon
        borderRadius = true,      -- Corner rounding
        cardSpacing = true,       -- Gap between cards
        cardShadow = true,        -- Shadow intensity
    },
    
    -- Presets tab
    presets = {
        themePresets = true,      -- Built-in presets
        savePreset = true,        -- Save custom
        importExport = true,      -- Import/Export JSON
    },
}

Admin Features

Config.Admin = {
    showAdminBadge = true,       -- Badge next to admin names
    showCoordsForAdmins = true,  -- Coordinates visible
    groups = {'admin', 'mod', 'superadmin', 'god', 'owner', 'staff'}
}

Performance Options

Config.Performance = {
    updateInterval = 1000,         -- Update frequency (ms)
    cachePlayerData = true,        -- Enable caching
    cacheDuration = 5000,          -- Cache duration (ms)
    disableNativePauseMenu = true, -- Disable GTA pause
}

---

Server Configuration

svconfig.lua

Notification System

ConfigSv.NotificationSystem = 'auto' -- 'auto' | 'ox_lib' | 'esx' | 'qb' | 'native'

ConfigSv.OxLibSettings = {
    position = 'top-right',
    duration = 5000,
    icon = 'flag',
    iconColor = '#3B82F6',
}

Discord Webhooks

ConfigSv.ReportWebhook = 'https://discord.com/api/webhooks/...'

ConfigSv.WebhookColors = {
    bug = 16753920,        -- Orange
    player = 15548997,     -- Red
    support = 3447003,     -- Blue
    suggestion = 5763719,  -- Green
}

ConfigSv.WebhookName = 'XeX Reports'
ConfigSv.WebhookAvatar = nil -- URL to avatar

Admin Detection

-- ESX groups
ConfigSv.ESXAdminGroups = {'admin', 'superadmin', 'mod', 'owner', 'god'}

-- QB/QBox permissions
ConfigSv.QBPermissions = {'admin', 'god', 'mod'}

-- Custom check (optional)
ConfigSv.CustomAdminCheck = function(source)
    return IsPlayerAceAllowed(source, 'command.admin')
end

Job Tracking

ConfigSv.TrackedJobs = {
    {
        id = 'police',
        label = 'Police',
        icon = 'fas fa-shield',
        color = '#3B82F6',
        jobs = {'police', 'sheriff', 'fbi', 'lspd', 'bcso'}
    },
    {
        id = 'ems',
        label = 'EMS',
        icon = 'fas fa-truck-medical',
        color = '#EF4444',
        jobs = {'ambulance', 'ems', 'doctor', 'hospital'}
    },
    {
        id = 'mechanic',
        label = 'Mechanics',
        icon = 'fas fa-wrench',
        color = '#F59E0B',
        jobs = {'mechanic', 'bennys', 'lscustoms'}
    },
    -- Add unlimited jobs!
}

ConfigSv.OnlyCountOnDuty = true -- QB/QBox only

Rate Limiting

ConfigSv.MaxRequestsPerMinute = 30
ConfigSv.ReportCooldown = 60 -- seconds

Logging

ConfigSv.EnableLogging = true
ConfigSv.LogToConsole = false -- Set to true for debugging

Updates

ConfigSv.CheckForUpdates = true

---

Localization

Supported Languages

Code	Language	Code	Language
en	English	it	Italiano
es	Español	pl	Polski
pt	Português	nl	Nederlands
fr	Français	tr	Türkçe
de	Deutsch	zh	中文
ru	Русский	ar	العربية

Setting Language

Config.Locale = 'en' -- Change to your language code

Adding Custom Languages

Config.Locales['custom'] = {
    pause_menu = 'CUSTOM MENU',
    close = 'Close',
    back = 'Back',
    -- ... all keys (see existing locales for reference)
}

---

Visual Customizer

Theme Presets

Theme	Style
Dark	Dark backgrounds, subtle accents
Light	Light backgrounds, dark text
Glass	Maximum transparency
Midnight	Deep blue tones
Emerald	Green nature vibes
Sunset	Warm orange/red tones
Rose	Pink romantic style
Ocean	Blue aquatic feel
Gold	Luxury golden tones
Neon	Vibrant cyberpunk

Card Styles

Style	Description
Glass	Translucent with blur
Solid	Opaque background
Minimal	Subtle, flat design
Neon	Glowing borders

Layout Options

Layout	Description
3-Column	Default, cards in 3 columns
2-Column	Cards in 2 wider columns
Centered	Single column, centered

Display Modes

Mode	Description
Fullscreen	Menu covers entire screen
Boxed	Menu in center with custom background

---

Notification System

Priority Order

1. ox_lib - If installed and started

2. Framework - ESX/QB/QBox native

3. Native - GTA V notifications

ox_lib Configuration

ConfigSv.NotificationSystem = 'ox_lib'
ConfigSv.OxLibSettings = {
    position = 'top-right',
    duration = 5000,
    icon = 'flag',
    iconColor = '#3B82F6',
}

---

Exports & Events

Client Exports

-- Check if menu is open
local isOpen = exports['xex_pausemenu']:IsMenuOpen()

-- Open menu programmatically
exports['xex_pausemenu']:OpenPauseMenu()

-- Close menu
exports['xex_pausemenu']:ClosePauseMenu()

Shared Exports

-- Get the framework bridge object (useful for integrations)
local bridge = exports['xex_pausemenu']:GetBridge()

Server Exports

-- Trigger update check manually
exports['xex_pausemenu']:CheckForUpdates()

Server Events

-- Listen for report submissions
AddEventHandler('xex_pausemenu:onReport', function(reportData)
    print(reportData.playerId)
    print(reportData.playerName)
    print(reportData.category)
    print(reportData.subject)
    print(reportData.message)
end)

---

File Structure

xex_pausemenu/
├── client/
│   └── main.lua           # Client-side logic
├── server/
│   ├── main.lua           # Server-side logic
│   └── updater.lua        # Version checker
├── shared/
│   ├── bridge.lua         # Framework abstraction
│   └── lib_loader.lua     # ox_lib loader
├── web/
│   ├── index.html         # UI structure
│   ├── style.css          # Styles
│   ├── app.js             # Main app logic
│   ├── customizer.js      # Customizer panel
│   ├── customizer.css     # Customizer styles
│   └── img/               # Images folder
│       └── logo.webp      # Server logo
├── config.lua             # Client configuration
├── svconfig.lua           # Server configuration
├── fxmanifest.lua         # Resource manifest
├── LICENSE                # Commercial license
└── DOCS.md                # This documentation

---

Troubleshooting

Menu Not Opening

1

Verify resource is started:

ensure xex_pausemenu

2

Check console for errors

3

Verify framework is detected

4

Check keybind conflicts

Framework Not Detected

-- Force framework
Config.Framework = 'esx' -- instead of 'auto'

Stats Not Showing

• ESX: Requires esx_status for hunger/thirst

• QB/QBox: Uses built-in metadata

Fuel Not Showing

• Ensure fuel resource is started before xex_pausemenu

• Check if fuel resource exports are available

Customizer Not Saving

• Check server console for save/load errors

• Verify player has valid identifier

---

Changelog

v2.0.0

• Complete rewrite with modern architecture

• Multi-framework support (ESX, QBCore, QBox)

• Advanced visual customizer

• 10 theme presets

• Weather display (icon + temperature)

• 12 language support

• ox_lib integration

• Enhanced report system

• Performance optimizations

---

License

This is commercial software. See LICENSE for terms.

Restrictions:

• Single server use only

• No redistribution

• No resale

• No source sharing

© 2024-2026 XeX Development. All rights reserved.