# PAUSE MENU

<figure><img src="/files/KxmUsXiiwIyGzPRs4gUh" alt=""><figcaption></figcaption></figure>

**A modern and customizable pause menu for your FiveM server**

Documentation • [Support Discord](https://discord.gg/kMdMhDKwrA)

***

### 📋 Table of Contents

* Introduction
* Prerequisites
* Installation
* Configuration
* Features
* Compatibility
* Customization
* Support
* Changelog

***

### 🎯 Introduction

**REX STUDIO Pause Menu** is a custom and modern pause menu that replaces the default FiveM menu. It provides an enhanced user experience with comprehensive player information, quick links to your Discord and Tebex store, as well as an elegant and customizable interface.

#### Main Features

* 🎨 Modern and elegant interface
* 💰 Account display (Wallet, Bank, Black Money)
* 👔 Job and organization information
* 📊 Server statistics (players, playtime)
* 🎮 Built-in camera to see your character
* 🌐 Multilingual support
* 🔧 Simple and intuitive configuration
* 🎯 Compatible with ESX and QBCore

***

### 📦 Prerequisites

Before installing this script, make sure you have:

* A working FiveM server
* **ESX Legacy** or **QBCore** installed and configured
* **ox\_inventory** (optional, for inventory integration)
* A recent version of FiveM (recommended)

***

### 🚀 Installation

#### Step 1: Download

1. Download the script from your Tebex purchase
2. Extract the files to your `resources` folder

#### Step 2: Installation

1. Place the `pausemenu` folder in your `resources` folder
2. Open your `server.cfg` and add the following line:

```lua
ensure pausemenu
```

#### Step 3: Configuration

1. Open the `shared/config.lua` file
2. Configure the options according to your needs (see Configuration)
3. Restart your server

#### Step 4: Verification

Once the server has restarted, press the **ESC** key (default) to open the custom pause menu.

***

### ⚙️ Configuration

All configuration is done in the `shared/config.lua` file. Here are the different sections:

#### ESX Configuration

```lua
Config.OldESX = false -- Enable this option if you're using ESX Legacy with getSharedObject
```

* `false` : For ESX Legacy with export `getSharedObject`
* `true` : For ESX Legacy with `TriggerEvent('esx:getSharedObject')`

#### Main Options

```lua
Config.Key = 'ESCAPE' -- Key to open the menu (default: ESCAPE)
Config.Name = 'REDSTART - Pause Menu' -- Keymapping name
Config.Discord = 'https://discord.gg/UsjAnRv48u' -- Link to your Discord server
Config.MaxPlayers = "512" -- Maximum number of slots (optional, uses GetConvarInt by default)
Config.UseCamera = true -- Enable camera to see character face (true/false)
```

#### Store Configuration

```lua
Config.Boutique = 'https://script.redstartrp.fr/' -- URL of your Tebex store
Config.UseCoin = false -- Enable coin display as item (true/false)
Config.CoinName = "coins" -- Coin item name in your inventory
```

#### Job 2 Configuration

```lua
Config.Job2 = false -- Enable second job display (job2.label job2.grade_label)
```

#### Currency Configuration

```lua
Config.Currency = "USD" -- Displayed currency (EUR, GBP, USD...)
Config.Format = "en-US" -- Locale format (fr-FR, en-GB, es-ES...)
```

#### Translation Customization

Modify the texts in the `Config.Translate` section:

```lua
Config.Translate = {
    FivemUsername = "FIVEM USERNAME",
    PlayingTime = "PLAYING TIME",
    TotalPlayers = "PLAYERS",
    GameId = "GAME ID",
    Resume = "RESUME",
    Settings = "SETTINGS",
    Keyboard = "KEYBOARD",
    Map = "MAP",
    Report = "REPORT",
    Quit = "QUIT",
    -- ... and more
}
```

#### Disconnect Message

```lua
Config.Quit = "Thanks for playing on Redstart RP, see you soon"
```

#### Customizable Functions

**Cash Money Function**

```lua
function getAccountMoney(xPlayer)
    local getAccountMoney = xPlayer.getMoney()
    -- Alternative : local getAccountMoney = xPlayer.getAccount('cash').money
    return getAccountMoney
end
```

**Bank Money Function**

```lua
function getBankMoney(xPlayer)
    local getBankMoney = xPlayer.getAccount('bank').money
    return getBankMoney
end
```

**Black Money Function**

```lua
function getDirtyMoney(xPlayer)
    local getDirtyMoney = xPlayer.getAccount('black_money').money
    return getDirtyMoney
end
```

**Report Function**

```lua
function PauseReport()
    ExecuteCommand("report") -- Modify according to your report system
end
```

**Inventory Function**

```lua
function PauseInventory()
    exports.ox_inventory:openInventory() -- Modify according to your inventory system
end
```

***

### ✨ Features

#### Player Information

* **FiveM Username** : Displays the player's username
* **Game ID** : Displays the player's user ID
* **Server ID** : Displays the player's server ID
* **Playtime** : Displays current session time

#### Financial Information

* **Wallet** : Player's cash
* **Bank** : Player's bank money
* **Black Money** : Player's black money

#### Professional Information

* **Main Job** : Player's job name and grade
* **Secondary Job** : Job 2 (if enabled in config)

#### Server Statistics

* **Online Players** : Number of connected players / Maximum slots

#### Action Buttons

* **Resume** : Closes the pause menu
* **Settings** : Opens game settings
* **Keyboard** : Opens key mapping settings
* **Map** : Opens the game map
* **Report** : Opens the report system
* **Quit** : Disconnects the player from the server

#### Quick Links

* **Discord** : Link to your Discord server
* **Tebex Store** : Link to your store with coin display (if enabled)

#### Custom Camera

When `Config.UseCamera` is enabled, a camera automatically positions itself to display your character's face when the menu is open.

***

### 🔄 Compatibility

#### Supported Frameworks

* ✅ **ESX Legacy** (with export `getSharedObject`)
* ✅ **ESX Legacy** (with `TriggerEvent('esx:getSharedObject')`)
* ✅ **QBCore**

#### Compatible Inventories

* ✅ **ox\_inventory** (default)
* ✅ Any other inventory system (customizable via `PauseInventory()`)

***

### 🎨 Customization

#### Image Modification

Images are located in the `ui/images/` folder:

* `background.png` : Background image
* `discord.png` : Discord icon
* `inventory.png` : Inventory icon
* `job.png` : Job icon
* `logo.png` : Logo
* `tebex.png` : Tebex icon
* `wallet.png` : Wallet icon

#### CSS Style Modification

The style file is located in `ui/css/style.css`. You can modify:

* Colors
* Fonts
* Animations
* Spacing
* Any other visual aspect

#### Custom Fonts

Fonts are located in `ui/css/fonts/`. You can add your own fonts and reference them in the CSS.

***

### 🛠️ Support

#### Discord

For any questions, issues, or suggestions, join our Discord server:

[**🔗 Support Discord**](https://discord.gg/kMdMhDKwrA)

#### Common Issues

**Menu doesn't open**

1. Check that the script is properly started in `server.cfg`
2. Check for errors in the F8 console
3. Make sure the configured key is correct

**Information doesn't display correctly**

1. Check your ESX/QBCore configuration
2. Check the functions in `config.lua` (getAccountMoney, etc.)
3. Make sure the server callback is working correctly

**Inventory doesn't open**

1. Check the `PauseInventory()` function in `config.lua`
2. Make sure your inventory system is properly configured
3. Check that the export/trigger is correct

***

### 📝 Changelog

#### Version 1.4

* ESX and QBCore support
* Improved interface
* Simplified configuration
* Multilingual support
* Custom camera
* Discord and Tebex integration

***

### 📄 License

This script is protected by escrow. Some files are protected and cannot be modified. The following files can be freely modified:

* `client/*.lua`
* `server/*.lua`
* `shared/*.lua`
* `ui/*` (HTML, CSS, JS, images)

***

### 🙏 Acknowledgments

Thank you for purchasing **REX STUDIO Pause Menu**! We hope this script will enhance your players' experience.

For any questions or suggestions, feel free to contact us on Discord.

***

**Developed by REX STUDIO**

[🌐 Tebex Store](https://rexstudio.tebex.io) • [💬 Discord Support](https://discord.gg/kMdMhDKwrA)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rex-studio.gitbook.io/rex-studio-docs/fivem-low-cost/pause-menu.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.