JK Pause Menu

Configuration

All settings live in shared/cfg.lua and are fully open (escrow-ignored). Edit, save and restart the resource.

The config file

Both shared/cfg.lua and the language files are escrow-ignored, so you can freely edit them. Here is the full file:

shared/cfg.lua

CFG = {
    Locale = "en",
    Debug  = false,

    KeyBind = {
        Command = 'pauseMenu',
        Key     = 'ESCAPE',
    },

    Style = {
        -- Primary color (accents, hover, exit button).
        -- Supported formats: "#ff0000", "ff0000", "FFFF0000" (ARGB).
        primaryColor   = "#ff0000",
        -- Secondary color (icons and borders).
        secondaryColor = "#888888",
    },

    Links = {
        discord = "https://discord.gg/jkstudios",
        tebex   = "https://your-tebex-store-link.com",
        rules   = "https://your-server-rules.com",
    },

    WeekEvents = {
        -- { title = "Title", description = "Short description", image = "https://example.com/image.png" }
    },

    AdminContact = {
        type = "command", -- "command" | "event" | "export"
        name = "report",
    },
}

General

Option	Type	Default	Description
`Locale`	string	"en"	UI language. One of `en, it, es, fr, de, pl, pt`. See Localization.
`Debug`	boolean	false	Prints helpful debug logs to the client console.

Keybind

Option	Type	Default	Description
`KeyBind.Command`	string	'pauseMenu'	The command name used to toggle the menu.
`KeyBind.Key`	string	'ESCAPE'	The key that opens the menu. Any FiveM key name (e.g. `F1`, `F5`).

ESCAPE vs custom keysWhen Key = 'ESCAPE' the script intercepts the native pause controls so ESC opens your menu instead of the GTA one. With any other key, a standard key mapping is registered (players can rebind it from Settings → Key Bindings → FiveM). The map shortcut M is always registered.

Style / Colors

Two colors drive the whole theme. Three formats are accepted:

Option	Type	Default	Description
`Style.primaryColor`	string	"#ff0000"	Accents, hover states and the Exit button.
`Style.secondaryColor`	string	"#888888"	Icons and borders.

color formats

primaryColor = "#ff0000"   -- hex with hash
primaryColor = "ff0000"    -- hex without hash
primaryColor = "FFFF0000"  -- ARGB (alpha first)

Links

These power the Store, Discord and Rules buttons. Store & Discord open externally; Rules is shown inside an in-game frame.

Option	Type	Default	Description
`Links.discord`	string	—	Discord invite — opened in the player’s browser.
`Links.tebex`	string	—	Your Tebex store — opened in the player’s browser.
`Links.rules`	string	—	Rules page URL — rendered inside an in-game iframe.

Player data & Discord avatars

The header shows the player's first name and Discord avatar. Avatars require a Discord bot token provided as a server convar:

server.cfg

setr jk_pausemenu_discord_bot_token "YOUR_DISCORD_BOT_TOKEN"

Keep the token privateThe token is read only on the server. Never commit it to a public repo or a replicated/shared cfg. Without a token a default Discord avatar is used.

Other sections

Two config blocks have their own dedicated guides:

Weekly Events

Announce events with images.

Admin Contact

Wire up the report button.