⚙️Configuration

Discover how to config your script.

Configuration Guide

All configuration is handled in zr-config/zr-config.lua. Below are the main options and how to use them.

Framework Selection

• The script auto-detects your framework: QBCore, QBox, ESX, or standalone.

Admin Groups

• Config.AdminGroups: List of group names that have admin access to menu editing features.

  • Example:

    Config.AdminGroups = {
        'god',
        'admin',
        'mod'
    }

Languages

• Config.DefaultLocale: Default language code (e.g., 'en').

• Config.AvailableLocales: List of enabled languages (must match files in zr-nui/zr-assets/locales/).

• Config.LocaleNames: Display names for each language code.

Notifications

• Config.MaxNotifications: Maximum number of notifications stored in memory.

Navigation Pages

• Config.EnabledPages: Show/hide pages in the menu. Set to true or false for each page.

Player Info Display

• Config.DisplayOptions: Control which stats/info are shown in the menu (cash, bank, player name, etc).

Support Relay Link

• Config.SupportRelayLink: URL for the support/Discord button.

Social Networks

• Config.SocialNetworks: List of social links (Discord, Instagram, Twitter, Website, etc). Set enabled = false to hide.

Staff Roles

• Config.StaffRoles: Define staff roles and their colors for the staff page.

Example: Enabling/Disabling a Page

Config.EnabledPages = {
    resume = true,
    worldMap = true,
    settings = true,
    keybinds = true,
    faq = true,
    staff = true,
    notifications = true,
    support = true,
    changelog = true,
    disconnect = true,
    quit = true
}

---

For advanced options, see comments in the config file. Always restart the resource after making changes!