Configuration

🎮 nc-pausemenu | Discord Support

Both config.lua and server_config.lua are escrow-ignored — freely editable.

config.lua (Client/Shared)

Server Branding

Config.ServerName = 'My Server'          -- Displayed at bottom-left
Config.ServerSub = 'discord.gg/myserver' -- Subtitle below server name

Server Logo

Config.Logo = 'https://example.com/logo.png'  -- URL or '' to disable
Config.LogoSize = { width = 64, height = 64 }  -- Size in pixels

The logo appears at the top-left corner of the menu. Set Config.Logo = '' to hide it.

Discord Invite

Config.DiscordInvite = 'https://discord.gg/myserver'

Used in the Support page's "Join Discord" button.

Sound Effects

Config.Sounds = {
    enabled = true,           -- false to disable all sounds
    open = 'NAV_UP_DOWN',     -- Menu open
    close = 'NAV_UP_DOWN',    -- Menu close
    hover = 'NAV_UP_DOWN',    -- Button hover
    click = 'SELECT',         -- Button click
}

Uses GTA5 native PlaySoundFrontend from HUD_FRONTEND_DEFAULT_SOUNDSET.

Common sound names: NAV_UP_DOWN, SELECT, BACK, ERROR, HIGHLIGHT_NAV_UP_DOWN

Menu Button Order

Config.MenuOrder = {
    'continue',
    'map',
    '---',              -- divider line
    'playerlist',
    '---',
    'news',
    'changelog',
    'support',
    '---',
    'settings',
    'keybinds',
    'keybindguide',
    '---',
    'disconnect',
    'quit',
}

Remove items to hide them. Change order to rearrange.

Keybind Guide

Config.KeybindGuide = {
    { key = 'F1', description = 'Open Phone' },
    { key = 'F2', description = 'Open Inventory' },
    { key = 'T', description = 'Open Chat' },
    { key = 'Z', description = 'Toggle Voice Range' },
    { key = 'E', description = 'Interact' },
    -- Add as many as you want
}

These are displayed on the visual keyboard layout when the Key Guide panel is opened.

Support Section

Config.Support = {
    discord = 'https://discord.gg/myserver',
    rules = {
        'Respect all players and staff.',
        'No cheating or exploiting.',
        'Follow RP guidelines.',
    },
    faq = {
        {
            question = 'How do I report a player?',
            answer = 'Use /report or open a Discord ticket.',
        },
    },
}

server_config.lua (Server-only)

This file is server-side only — safe for sensitive data like tokens.

Discord Bot

ServerConfig.DiscordBotToken = 'YOUR_BOT_TOKEN'

Required for News & Changelog. Get a token from Discord Developer Portal.

Channel IDs

ServerConfig.NewsChannelId = '123456789'       -- News channel
ServerConfig.ChangelogChannelId = '987654321'  -- Changelog channel

Enable Developer Mode in Discord → Right-click channel → Copy ID.

Message Limit

ServerConfig.MessageLimit = 10   -- 1 to 100

How many recent messages to fetch per channel. Higher = more posts shown, but slower fetch.

Cache Duration

ServerConfig.CacheDuration = 300  -- seconds (300 = 5 minutes)

How long to cache Discord data before re-fetching. Lower = more up-to-date, but more API calls.

Locale

Edit ui/dist/locale.json to change all UI text. See Locale for full reference.