Configuration

Every setting lives in one file: shared/config.lua, inside the flux-pausemenu folder. Open it in any text editor to make changes.

This file is yours to edit freely, and your changes are kept when you update the resource — you won’t lose your settings. After editing it, run restart flux-pausemenu in your server console and reopen the menu to see the change.

This page walks through every option, grouped by what it does. You can skip to the part you care about — nothing here is required reading.

The basics


Config.Framework = 'qbox' -- 'esx' | 'qbcore' | 'qbox' | 'standalone'
Config.Locale = 'en'      -- 'en' | 'fr' | 'de' | 'es' | 'pt'
Config.Debug = false      -- extra messages in the console, for fixing problems

Setting	What it does
`Config.Framework`	Which framework the menu reads player data from. See Pick your framework.
`Config.Locale`	The menu’s language.
`Config.Debug`	Prints extra info to the client console. Leave this `false` unless you’re chasing a problem.


Config.Command = 'pausemenu'         -- chat command, e.g. typing /pausemenu
Config.Key = 'ESCAPE'                -- the key that opens the menu
Config.DisableNativePauseMenu = true -- show this menu instead of GTA's ESC screen

Setting	What it does
`Config.Command`	A chat command players can type to open the menu.
`Config.Key`	The key that opens the menu. Players can also rebind this themselves in FiveM Settings → Key Bindings. Set it to `''` (empty) if you only want the chat command.
`Config.DisableNativePauseMenu`	When `true`, your players get this menu in place of GTA’s normal ESC menu. This is the whole point of the resource, so most servers leave it `true`.

Branding


Config.Brand = {
    name = 'Flux Developments',  -- your server name, shown at the top
    tagline = 'Roleplay Server',  -- a short line under the name
    logo = 'header-logo.svg',     -- your logo
}

Field	What it does
`name`	Your server’s name, shown in the menu header.
`tagline`	A short subtitle under the name.
`logo`	Your logo image. Either drop a file into the resource’s `web/` folder and name it here, or paste a full web link (`https://...`) to an image.

Color theme


Config.Theme = {
    primary = '#FF0000', -- one color the whole menu is built from
}

This is the fun one. Pick one color and the entire menu — borders, glows, highlights, button tints — is generated from it automatically. You don’t touch anything else.

Not sure what hex code your brand color is? Search “color picker” in Google and copy the # value (for example #7C3AED for purple).

Player profile pictures


Config.Avatar = {
    source = 'discord', -- 'discord' | 'steam' | 'none'
}

Shows each player’s real profile picture on their card. This needs a little extra setup (a Discord or Steam key), so it has its own page: Player Avatar.

The scene

When the menu opens, the camera swings around to show the player’s character holding a map. Both the camera move and the animation can be turned off independently if you’d rather keep it simple.

Camera


Config.Camera = {
    enabled = true,
    distance = 1.8,
    height = 0.6,
    xOffset = 0.85,
    fov = 50.0,
    targetZOffset = -0.35,
}

Field	What it does
`enabled`	Set to `false` to skip the camera move entirely.
`distance`	How far the camera sits from the character.
`height`	How high the camera sits.
`xOffset`	Shifts the character to one side of the screen.
`fov`	Field of view (how “zoomed in” the shot feels).
`targetZOffset`	Aim height. Lower numbers frame more of the upper body.

These are fine to leave as‑is. Only change them if you want to fine‑tune the camera shot — adjust one number at a time and reopen the menu to see the effect.

Animation


Config.Animation = {
    enabled = true,
    dict = 'amb@world_human_tourist_map@male@base',
    name = 'base',
    prop = 'prop_tourist_map_01',
    propBone = 28422,
    propOffset = vector3(0.07, 0.05, 0.03),
    propRot = vector3(20.0, 0.0, 180.0),
}

Field	What it does
`enabled`	Set to `false` to skip the map‑holding animation.
`dict` / `name`	The animation played on the character.
`prop`	The map model placed in the character’s hand.
`propBone`	Which hand bone the map attaches to.
`propOffset` / `propRot`	Fine position and angle of the map in the hand.

Open and close animation

This controls the slide‑and‑fade when the menu appears and disappears. Opening (entry) and closing (exit) are set separately.


Config.Transitions = {
    entry = { enabled = true, speed = 1.0 },
    exit  = { enabled = true, speed = 2.0 },
}

Field	What it does
`enabled`	Set to `false` for an instant open or close, with no animation.
`speed`	How fast the animation plays. `1.0` is normal, `2.0` is twice as fast, `0.5` is half speed. (Anything outside `0.1`–`5` is gently pulled back into range.)

Up to three buttons that link to your community. Tapping one opens the link (or copies it, for things like Discord invites).


Config.Socials = {
    {
        label = 'YouTube',
        url   = 'https://www.youtube.com/@FluxDevelopments',
        icon  = '/youtube.svg',
        color = '#FF0000', -- the button's color
    },
    -- up to 3 entries
}

Field	What it does
`label`	The text on the button.
`url`	Where the button links to.
`icon`	An icon name from lucide.dev , one of the built‑ins `'discord'` / `'tiktok'`, or your own SVG file placed in the `web/` folder.
`color`	The button’s color, as a hex code.

Announcement carousel

A small rotating set of announcement cards inside the menu — great for rules reminders, events, or a welcome message.


Config.Announcement = {
    autoRotate = true,
    rotateSeconds = 8, -- seconds each card is shown
    items = {
        { title = 'Announcement', body = 'Welcome to the server...' },
        -- add as many as you like
    },
}

Field	What it does
`autoRotate`	Cycle through the cards automatically.
`rotateSeconds`	How long each card stays on screen.
`items`	Your list of cards, each with a `title` and `body`.


Config.Rules = {
    url = 'https://docs.fluxdevelopments.net', -- leave as '' to hide the link button
    items = {
        'Respect all players and staff at all times.',
        -- add your own rules
    },
}

Field	What it does
`url`	A link to your full rules, shown as a button. Set it to `''` (empty) to hide that button.
`items`	The rules shown in the pop‑up, one line each.

Bottom buttons

The bar at the bottom of the menu. The Close FiveM button is always there; these two can be hidden.


Config.ActionButtons = {
    keyBinds = true, -- show the Keybinds button
    rules = true,    -- show the Rules button
}

Keybinds list

The list of keys shown in the Keybinds pop‑up.

This list is for display only — it shows players what your server’s keys are. It does not change any keybindings. Players rebind keys in FiveM’s own settings.


Config.KeyBinds = {
    { key = 'ESC', label = 'keybind_open_pause' },
    { key = 'M',   label = 'keybind_open_map' },
    { key = 'F5',  label = 'keybind_interaction' },
    { key = 'TAB', label = 'keybind_inventory' },
}

Field	What it does
`key`	The key shown on the on‑screen keyboard.
`label`	The action it does. Can be plain text, or a translation key from the `locales/` files.