Skip to main content
Rarx Pausemenu Preview

Overview

RARX Pausemenu is a customizable pause menu replacement for FiveM servers, built with Svelte technology. It supports both ESX and QBCore frameworks.

Features

Player Info

Display player information including name, job, cash, bank, and XP

Business Management

Manage business information directly from the menu

Events System

Server events displayed in grid format

Admin Panel

Full admin functionality with keybind access

Requirements

  • ox_lib
  • oxmysql
  • ESX or QBCore framework (any version)

Installation

1

Download & Extract

Download the latest version from your Keymaster and extract to your resources folder.
2

Import Database

Import the SQL database file for the events table.
3

Add to server.cfg

ensure rarx_pausemenu
4

Configure

Edit shared/config.lua to customize settings.

Configuration

Server Branding

Config.ServerName = "Your Server Name"
Config.ServerLogo = "https://your-logo-url.png"
Config.BackgroundImage = "https://your-background-url.png"

Color Schemes

The menu supports HEX color customization with primary/secondary colors. Available Presets:
  • Pink/Cyan (Default)
  • Blue/Orange
  • Green/Purple
  • Red/Yellow
Config.Colors = {
    primary = "#FF69B4",
    secondary = "#00FFFF",
    primaryDark = "#FF1493",
    secondaryDark = "#00CED1"
}

Audio Settings

Config.Audio = {
    hover = true,
    click = true,
    volume = 0.5 -- Range: 0.0 - 1.0
}

Currency Display

Config.Currency = {
    symbol = "$",
    position = "before" -- "before" or "after"
}

Experience System

Config.XP = {
    enabled = true,
    accountName = "xp",
    label = "Experience",
    symbolPosition = "after"
}
Config.MenuOptions = {
    showHelp = true,
    showExit = true,
    showBills = true,
    showServices = true,
    showBusiness = true,
    showOrganization = true
}

Admin Features

Administrators can access the admin panel using a configurable keybind (default: END).

Access Control

Config.AdminIdentifiers = {
    "discord:123456789",
    "license:abcdef123456",
    "steam:110000123456789",
    "fivem:12345"
}

Event Management

Admins can:
  • Create, edit, and delete events
  • Set title, description, date, and image
  • Changes sync in real-time to all players

Custom Buttons

Add action buttons with three action types:
Config.CustomButtons = {
    {
        label = "My Button",
        icon = "fa-solid fa-star",
        action = "command", -- "command", "client", or "server"
        value = "/mycommand",
        jobs = {"police", "ambulance"} -- Optional job restriction
    }
}

Localization

Translation files exist for Spanish and English. Add additional languages by duplicating and translating the language files.

Technical Integration

Client Events

-- Open the pause menu
TriggerEvent('rarx_pausemenu:open')

-- Close the pause menu
TriggerEvent('rarx_pausemenu:close')

Server Events

-- Broadcast event updates to all players
TriggerClientEvent('rarx_pausemenu:client:eventsUpdated', -1, eventsTable)

Troubleshooting

Verify database connection and that the events table was created correctly.
Ensure your identifier is correctly added to the admin list.
Clear your game cache and verify HEX color format.

Compatibility

origen_masterjob

To enable full compatibility with origen_masterjob, you need to add the RARX injection to the resource’s fxmanifest.lua.
1

Open fxmanifest.lua

Navigate to your origen_masterjob resource folder and open the fxmanifest.lua file.
2

Add the injection

Add the following line at the end of your server_scripts section:
"@rarx_lib/injections/server/origen_masterjob.lua"
server_scripts {
    "@oxmysql/lib/MySQL.lua",
    "server/log.lua",
    "server/init.lua",
    "custom/server/command.lua",
    "custom/server/main.lua",
    "custom/server/menu/phone.lua",
    "server/garage.lua",
    "server/class.lua",
    "server/commands.lua",
    "server/events.lua",
    "server/functions.lua",
    "server/menu.lua",
    "server/npcs.lua",
    "server/threads.lua",
    "radio/server/**/*.lua",
    "@rarx_lib/injections/server/origen_masterjob.lua"
}
Make sure rarx_lib is started before origen_masterjob in your server.cfg.