Configuration

All config files are in the config/ directory.

File	Scope	Description
config.lua	Client + Server	Locale, commands, keybindings, map
server.lua	Server only	Bootstrap, spectate, TURN/ICE
player_actions.lua	Server only	Custom player action buttons

config.lua

Config = Config or {}

-- Locale: 'en', 'zh', etc.
Config.locale = 'en'

-- Debug logging
Config.debug = false

-- Keybinding configuration
-- Key values: '' = no default binding (players bind via Settings > Key Bindings)
-- Common keys: F1-F24, HOME, END, PAGEUP, PAGEDOWN, INSERT, DELETE, PAUSE
-- Full reference: https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/

-- Admin panel
Config.toggleCommand  = 'eadmin'              -- Command name
Config.toggleKeyLabel = 'Toggle Admin Panel'  -- Key Bindings label
Config.toggleKey      = ''                    -- Default key
Config.toggleKeybind  = false                 -- Show in Settings > Key Bindings

-- Support panel
Config.supportCommand  = 'support'
Config.supportKeyLabel = 'Open Support Panel'
Config.supportKey      = ''
Config.supportKeybind  = false

-- NoClip
Config.noClipCommand   = 'noclip'
Config.noClipKeyLabel  = 'Toggle NoClip'
Config.noClipKey       = 'PAGEDOWN'
Config.noClipKeybind   = true

-- Map tile URL (empty = use local tiles)
-- e.g. 'https://cdn.example.com/eadmin-map'
-- Directory structure: tiles/{z}/{x}/{y}.png, satellite-tiles/{z}/{x}/{y}.png
Config.mapTileBaseUrl = ''

server.lua

Server-only, never sent to clients. Safe for secrets.

Config.server = Config.server or {}

-- ACE required for first-launch bootstrap ('admin', 'command', 'superadmin')
Config.server.bootstrapAce = 'command'

-- Spectate module
Config.server.spectate = {
    maxWatchersPerTarget = 3,    -- Max admins spectating one player
    maxActiveSpectates   = 5,    -- Max sessions per admin (1-10)
    -- Capture quality (higher = better quality, more bandwidth)
    -- Presets: 480p (854x480@15fps,800kbps) | 540p (960x540@15fps,1000kbps) | 720p (1280x720@15fps,2000kbps)
    captureWidth  = 960,         -- 320-1920
    captureHeight = 540,         -- 180-1080
    captureFps    = 15,          -- 5-30
    bitrateKbps   = 1000,        -- 0 = auto, recommended: 800-2000
}

-- Players module
Config.server.players = {
    multiGroup = true,           -- QBX multi-job/gang from player_groups table
}

-- Data retention
Config.server.activity  = { retentionDays = 90 }
Config.server.moneyLogs = { retentionDays = 30 }

-- TURN/ICE for spectate WebRTC
Config.server.turn = {
    enabled    = false,
    required   = false,          -- Block spectate when TURN unavailable

    -- Cloudflare TURN credentials
    tokenId    = '',
    apiToken   = '',
    ttlSeconds = 3600,
    maxTtlSeconds    = 86400,
    cacheSkewSeconds = 60,

    -- Custom STUN/TURN servers (always included alongside Cloudflare)
    customIceServers = {
        -- { urls = 'stun:your-server:3478' },
        -- { urls = 'turn:your-server:3478?transport=udp', username = '...', credential = '...' },
    },

    -- Fallback STUN when no TURN available
    fallbackStun = {
        'stun:stun.cloudflare.com:3478',
        'stun:stun1.l.google.com:19302',
        'stun:stun2.l.google.com:19302',
    },
}

When enabled = false, spectate uses STUN-only (peer-to-peer). Set required = true to block spectate without TURN. For self-hosted TURN, add to customIceServers and keep Cloudflare disabled.

player_actions.lua

Hiding built-in actions

Config.playerActions = Config.playerActions or {}
Config.playerActions.hidden = {
    -- 'revive', 'heal', 'feedTarget', 'relieveTargetStress', 'setArmor',
    -- 'teleportTo', 'bringHere', 'spectate', 'clothingMenu',
    -- 'setCharacterName', 'repairVehicle', 'giveVehicleKeys',
    -- 'freeze', 'jail', 'cuff', 'warn', 'kill', 'kick', 'ban',
}

Custom actions

Each action needs: id, label, category, icon, execute(actorSrc, targetSrc, data).

Available data fields in execute():

• data.citizenid - always present

• data[dataKey] - user input values (if inputs configured)

• Bridge.GetCharacterName(targetSrc) - character name

• GetPrimaryIdentifier(targetSrc) - license2/license

Icons: any Lucide name in kebab-case. Unrecognized names fall back to puzzle.

Config.playerActions.custom = {
    {
        id         = 'superHeal',
        label      = 'Super Heal',
        category   = 'health',           -- health|teleport|identity|vehicle|punishment|custom
        icon       = 'heart-pulse',
        singleOnly = false,
        onlineOnly = true,
        destructive = false,
        permission = 'players.customHeal',  -- Optional RBAC key
        execute = function(actorSrc, targetSrc, data)
            exports['myResource']:superHeal(targetSrc)
            return true
        end,
    },
}

Input types

Actions can collect user input via input (single field) or inputs (multiple fields).

Type	Description	Extra fields
text	Text field	placeholder, required
number	Number slider	min, max, placeholder
textarea	Multi-line text	placeholder
select	Single select	options: {value, label}[]
multiselect	Multi select	options: {value, label}[]

-- Single input
input = { type = 'number', label = 'Level', dataKey = 'level', min = 1, max = 100 },

-- Multiple inputs
inputs = {
    { type = 'select', label = 'Type', dataKey = 'type', options = { ... } },
    { type = 'number', label = 'Amount', dataKey = 'amount', min = 1, max = 10000 },
    { type = 'text',   label = 'Reason', dataKey = 'reason', required = false },
},