Configuration

All configuration is in config.lua (not escrowed).

Core Settings

lua

Config.Language    = 'en'      -- 'en' | 'es'
Config.Debug       = false
Config.MenuCommand = 'guards'  -- command to open the menu
Config.MenuKeybind = 'F3'      -- default keybind (rebindable in FiveM settings)

Permissions

lua

Config.AdminOnly   = false                              -- restrict the menu to admins
Config.AdminGroups = { 'admin', 'god', 'superadmin' }   -- groups treated as admin

When Config.AdminOnly is true, access is checked server-side against ACE permissions and your framework's admin groups.

Limits & Behavior

lua

Config.MaxPeds = 50            -- max guards per player

Config.DefaultAggressionTarget = 'players'  -- 'players' | 'npcs' | 'both'
Config.NPCTargetRange          = 100.0      -- NPC engagement range (m)

Config.EnableFormations    = true
Config.FormationDistance   = 2.5            -- spacing between guards (m)

Config.EnableThreatScan    = true
Config.ThreatScanRadius    = 50.0           -- threat scan radius (m)
Config.ThreatScanInterval  = 2000           -- threat scan interval (ms)

Config.EnableVehicleActions = true          -- enter/exit vehicle actions
Config.EnableSyncedPeds     = true          -- sync guards to other players

Config.NotificationSystem   = 'default'     -- 'default' | 'ox_lib' | 'custom'

Models & Weapons

Config.PedModels and Config.Weapons are preset lists (each entry has a label and a value) used to populate the spawn menu. Add, remove, or reorder entries freely.

Keybind

The menu opens with /guards or the F3 key by default. Players can rebind the key in Settings → Key Bindings → FiveM.