Customer documentation · ESX / QBCore / Qbox / Standalone
TenX Pause Menu
A configurable FiveM pause menu with multi-framework support, Discord avatars, locales, sound, and visual customization.
# TenX Pause Menu
> Customer documentation · ESX / QBCore / Qbox / Standalone
Thank you for purchasing TenX Pause Menu.
This resource provides a modern, configurable FiveM pause menu with multi-framework support, Discord avatar integration, locales, configurable categories, sound effects, animations and visual customization.
Requirements
TenX Pause Menu supports:
- ESX
- QBCore
- Qbox
- Standalone
No ox_lib is required.
No database is required for the pause menu itself.
For custom Discord profile pictures, a Discord bot token is required. The bot is only used server-side to request the player's Discord avatar.
Installation
1. Download and extract the resource.
2. Make sure the folder is named:
tenx_pausemenu
3. Move the folder into your server resources directory, for example:
resources/[scripts]/tenx_pausemenu
4. Add this line to your server.cfg:
ensure tenx_pausemenu
5. Restart the server or start the resource manually:
restart tenx_pausemenu
The menu can also be tested in game with:
/pausemenu
or:
/tenx_pausemenu
Default Controls
By default, the menu can open with:
- ESC
- P
- F10
The extra key can be changed from config.lua:
Config.Menu.ExtraKey = 'F10'
You can also enable or disable individual controls:
Config.Menu = {
ReplaceDefaultPause = true,
OpenWithP = true,
OpenWithEscape = true,
CloseWithEscape = true,
ExtraKey = 'F10',
BlurGame = false,
DefaultVehicles = 0
}
Language / Locales
English and Italian are included by default.
To select the language, open config.lua and change:
Config.Locale = 'en'
Available default languages:
en = English
it = Italian
Locale files are located inside:
locales/
To add another language, duplicate one of the existing locale files and create a new locale entry.
Example:
Locales['fr'] = {
welcome = 'Bienvenue,',
home = 'Accueil'
}
Then set:
Config.Locale = 'fr'
Server Branding
All main server information can be changed from config.lua:
Config.Server = {
Name = 'Your Server Name',
Highlight = 'Name',
Subtitle = 'ROLEPLAY • COMMUNITY • SINCE 2019',
City = 'Los Santos',
Footer = 'Top server dal 2019',
Discord = 'https://discord.gg/yourserver',
Store = 'https://yourstore.com',
Rules = 'https://yourwebsite.com/rules',
Support = 'https://discord.gg/yourserver'
}
### Name
Name = 'Your Server Name'
This is the main server name displayed in the interface.
### Highlight
Highlight = 'Name'
This text receives the accent color inside the server name.
### Links
Replace the default links with your own:
Discord = 'https://discord.gg/yourserver'
Store = 'https://yourstore.com'
Rules = 'https://yourwebsite.com/rules'
Support = 'https://discord.gg/yourserver'
Theme Customization
The visual style can be customized from:
Config.Theme = {
Color = '#1497ff',
SecondaryColor = '#6b5cff',
MenuScale = 0.76,
CompactMode = true,
PanelOpacity = 0.94,
BorderRadius = 16,
StrongGlow = true,
HoverEffects = true,
AnimatedShine = true,
AmbientGlow = true,
CursorGlow = true,
GlassReflection = true
}
### Primary Color
Config.Theme.Color = '#1497ff'
### Secondary Color
Config.Theme.SecondaryColor = '#6b5cff'
Use standard HEX colors.
Examples:
Blue: #1497ff
Purple: #8b5cf6
Red: #ef4444
Green: #22c55e
Orange: #f97316
### Menu Size
Config.Theme.MenuScale = 0.76
Lower values make the menu smaller.
Recommended range:
0.70 - 0.90
### Compact Mode
Config.Theme.CompactMode = true
Compact mode uses the smaller optimized layout.
### Panel Opacity
Config.Theme.PanelOpacity = 0.94
Recommended range:
0.75 - 1.00
### Visual Effects
You can disable individual effects if required:
StrongGlow = false
HoverEffects = false
AnimatedShine = false
AmbientGlow = false
CursorGlow = false
GlassReflection = false
Enable / Disable Categories
Menu categories can be enabled or disabled without editing the HTML or JavaScript.
Config.Categories = {
Sidebar = {
Home = true,
Map = true,
Settings = true,
GTASettings = true,
Discord = true,
Store = true,
Exit = true
},
QuickLinks = {
Discord = true,
Store = true,
Rules = true,
Support = true
},
Sections = {
Clock = true,
News = true,
CharacterStats = true
}
}
### Example: Remove Store Completely
Config.Categories.Sidebar.Store = false
Config.Categories.QuickLinks.Store = false
### Example: Remove News
Config.Categories.Sections.News = false
### Example: Remove Character Statistics
Config.Categories.Sections.CharacterStats = false
### Example: Remove Clock
Config.Categories.Sections.Clock = false
Discord Avatar Setup
TenX Pause Menu automatically looks for the player's Discord identifier in FiveM.
Profile settings:
Config.Profile = {
Source = 'auto',
UseDiscordAvatar = true,
ShowDiscordBadge = true,
DiscordBotTokenConvar = 'pausemenu_discord_bot_token',
FallbackImage = 'assets/avatar.svg'
}
### Profile Source Modes
### Automatic
Source = 'auto'
The menu prefers the Discord avatar and falls back to the character headshot if a Discord avatar is not available.
### Discord
Source = 'discord'
The menu prefers Discord profile information.
### Character
Source = 'character'
The menu uses the in-game character headshot.
Discord Bot Token
To retrieve a player's custom Discord avatar, add your bot token to server.cfg:
set pausemenu_discord_bot_token "YOUR_DISCORD_BOT_TOKEN"
Do not place the bot token inside config.lua, client files or NUI files.
The token must remain server-side.
After adding the token, restart the resource or server.
### Important
Never share your Discord bot token publicly.
If your token becomes exposed, regenerate it immediately from the Discord Developer Portal.
Interface Sounds
Sound effects can be configured from:
Config.Sound = {
Enabled = true,
Volume = 0.18,
Style = 'soft_chime'
}
To disable sounds:
Config.Sound.Enabled = false
To change the volume:
Config.Sound.Volume = 0.10
Recommended range:
0.05 - 0.30
Money Display
Money formatting is controlled by:
Config.Money = {
Symbol = '$',
Locale = 'it-IT'
}
Example for Euro formatting:
Config.Money = {
Symbol = '€',
Locale = 'it-IT'
}
Example for US formatting:
Config.Money = {
Symbol = '$',
Locale = 'en-US'
}
News System
News cards are configured inside:
Config.News
Default example:
Config.News = {
{
titleKey = 'news_update_title',
textKey = 'news_update_text',
date = '20 Apr 2026',
image = 'assets/news_update.svg'
}
}
The titleKey and textKey values are translated using the active locale file.
Example locale entries:
news_update_title = 'New update available',
news_update_text = 'Discover the latest features, improvements and new server content.'
You can edit the included news text from the locale files.
Framework Support
The resource automatically detects supported frameworks.
### ESX
Displays supported player information such as:
- Character/player name
- Cash
- Bank
- Job
### QBCore
Displays supported player information such as:
- Character name
- Cash
- Bank
- Job
- Gang / faction
### Qbox
Displays supported player information such as:
- Character name
- Cash
- Bank
- Job
- Gang / faction
### Standalone
The pause menu can still run without a framework. Framework-specific player data will use fallback/default values when unavailable.
Vehicle Count
The included build currently uses:
Config.Menu.DefaultVehicles = 0
This is a configurable fallback value.
A live owned-vehicle count is not automatically queried from your database because vehicle database structures differ between servers and frameworks.
If you want a live vehicle count, it must be integrated with your own vehicle/garage database structure.
Native GTA Menu Access
The pause menu includes access to the native GTA pause interface.
Depending on the selected button, the custom NUI closes and FiveM/GTA opens the native pause frontend.
This resource does not include an external 3D map dependency.
Background Blur
Game blur can be enabled with:
Config.Menu.BlurGame = true
Or disabled with:
Config.Menu.BlurGame = false
Cfx Asset Escrow
This resource is prepared for Cfx Asset Escrow.
The following files are intentionally left editable:
config.lua
locales/*.lua
The manifest contains:
escrow_ignore {
'config.lua',
'locales/*.lua'
}
Cfx Asset Escrow protection is applied by Cfx when the asset is processed and uploaded through the Cfx Portal.
Do not remove the escrow_ignore section if you want customers to keep access to the configuration and language files.
Resource Structure
tenx_pausemenu/
├── client.lua
├── server.lua
├── config.lua
├── fxmanifest.lua
├── locales/
│ ├── en.lua
│ └── it.lua
└── html/
├── index.html
├── style.css
├── app.js
└── assets/
Troubleshooting
### The menu does not open
Check that the resource is started:
ensure tenx_pausemenu
Then test:
/pausemenu
Check the FiveM F8 console and server console for errors.
Also make sure the resource folder is named correctly:
tenx_pausemenu
### ESC or P does not open the menu
Check:
Config.Menu.ReplaceDefaultPause = true
Config.Menu.OpenWithP = true
Config.Menu.OpenWithEscape = true
Restart the resource after changing the config.
### Discord avatar does not appear
Check the following:
1. Config.Profile.UseDiscordAvatar = true
2. The player has a Discord identifier available to FiveM.
3. The Discord bot token is correctly configured in server.cfg.
4. The bot token is valid.
5. Restart the resource after changing the token.
If Discord data is unavailable and Source = 'auto', the menu will use the character headshot fallback.
### The Store button should not appear
Disable it in both locations:
Config.Categories.Sidebar.Store = false
Config.Categories.QuickLinks.Store = false
### The menu is too large
Reduce:
Config.Theme.MenuScale = 0.72
If necessary, adjust gradually instead of using extremely low values.
### The menu is too transparent
Increase:
Config.Theme.PanelOpacity = 0.98
### I changed the config but nothing changed
Restart the resource:
restart tenx_pausemenu
If necessary, fully reconnect to the server after the restart.
Recommended First-Time Configuration
Before using the resource in production, change at least:
Config.Locale
Config.Server.Name
Config.Server.Highlight
Config.Server.Subtitle
Config.Server.Discord
Config.Server.Store
Config.Server.Rules
Config.Server.Support
Config.Theme.Color
Config.Theme.SecondaryColor
If you do not use a store, disable it:
Config.Categories.Sidebar.Store = false
Config.Categories.QuickLinks.Store = false
Support Information to Provide
If you need technical support, provide:
- FiveM server artifact version
- Framework and version
- Screenshot of the problem
- F8 console error
- Server console error
- Your config.lua with private tokens removed
Never send your Discord bot token, server license key or other private credentials in a public support channel.
Quick Installation Summary
1. Extract tenx_pausemenu
2. Move it into your resources folder
3. Add: ensure tenx_pausemenu
4. Configure config.lua
5. Optional: configure Discord bot token
6. Restart the server/resource
7. Test with /pausemenu
TenX Pause Menu
Thank you for using the resource.