ADMIN OVERLAY

If you want detailed documentation, view to your README.md file in script package

Config Preview:

Config = {}

-- DON'T CHANGE THIS! Current version of the script
Config.Version = '1.0.0'

-- Language settings
Config.Language = 'en' -- Available: 'en', 'cs', 'de', 'es', 'fr' | You can add more languages in Config.Locales

-- Admin groups that can access the overlay
Config.AdminGroups = {
    -- ESX Groups
    'admin',
    'superadmin',
    -- QB Groups
    'god',
    'admin',
    -- Add more groups here
    'moderator'
}

-- Key to toggle overlay
Config.DefaultKey = 'F5'

-- Command to toggle overlay
Config.Command = 'adminoverlay'

-- Toggle methods configuration
Config.ToggleMethods = {
    command = true,     -- Enable command toggle
    event = true,       -- Enable event toggle
    keybind = true,     -- Enable keybind toggle
    export = true       -- Enable export toggle
}

-- Elements visibility configuration
Config.ShowElements = {
    playerIds = true,    -- Show player server IDs
    playerNames = true,  -- Show player names
    vehicleInfo = true,  -- Show vehicle information
    coordinates = true,  -- Show coordinates
    heading = true,      -- Show heading
    fps = true,          -- Show FPS counter
    distance = true,     -- Show distance to player
    health = true,       -- Show player health
    armor = true         -- Show player armor
}

-- Hotkey configuration
Config.Hotkeys = {
    copyVec3 = 'F3',     -- Copy vec3 coordinates
    copyVec4 = 'F4',     -- Copy vec4 coordinates (with heading)
    copyHeading = 'F6'   -- Copy only heading
}

-- Maximum distance to display information
Config.DisplayDistance = 100.0

-- Preset positions for UI elements
Config.PresetPositions = {
    ['top-left'] = {x = 0.005, y = 0.005},      -- Top left
    ['top-right'] = {x = 0.985, y = 0.005},     -- Top right
    ['bottom-left'] = {x = 0.005, y = 0.96},    -- Bottom left
    ['bottom-right'] = {x = 0.985, y = 0.96},   -- Bottom right
    ['center-left'] = {x = 0.005, y = 0.5},     -- Center left
    ['center-right'] = {x = 0.985, y = 0.5},    -- Center right
    ['top-center'] = {x = 0.5, y = 0.005},      -- Top center
    ['bottom-center'] = {x = 0.5, y = 0.96},    -- Bottom center
    ['center'] = {x = 0.5, y = 0.5}             -- Center
}

-- UI element positions configuration
Config.Positions = {
    fps = Config.PresetPositions['top-left'],  -- FPS counter position
    copyInstructions = {
        vec3 = {x = 0.005, y = 0.90},          -- Vec3 copy instruction position
        vec4 = {x = 0.005, y = 0.93},          -- Vec4 copy instruction position
        heading = {x = 0.005, y = 0.96}        -- Heading copy instruction position
    },
    playerInfo = {
        nameOffset = 1.2,                      -- Player name offset
        vehicleOffset = 1.7,                   -- Vehicle info offset
        healthOffset = 0.7,                    -- Health info offset
        armorOffset = 0.4,                     -- Armor info offset
        distanceOffset = 0.5                   -- Distance info offset
    },
    debugInfo = Config.PresetPositions['top-right'] -- Debug info position
}

-- Color configuration
Config.Colors = {
    default = {r = 255, g = 255, b = 255, a = 255},   -- Default color
    highlight = {r = 255, g = 255, b = 0, a = 255},    -- Highlight color
    warning = {r = 255, g = 150, b = 0, a = 255},      -- Warning color
    error = {r = 255, g = 0, b = 0, a = 255},          -- Error color
    success = {r = 0, g = 255, b = 0, a = 255},        -- Success color
    info = {r = 0, g = 200, b = 255, a = 255},         -- Info color
    health = {r = 0, g = 200, b = 0, a = 255},         -- Health color
    armor = {r = 0, g = 100, b = 255, a = 255}         -- Armor color
}

-- Text color codes for GTA formatting
Config.TextColors = {
    white = "~w~",
    red = "~r~",
    green = "~g~",
    blue = "~b~",
    yellow = "~y~",
    purple = "~p~",
    grey = "~c~",
    black = "~u~",
    orange = "~o~"
}

-- UI text color configuration
Config.UIColors = {
    label = Config.TextColors.white,         -- Label color (default: white)
    value = Config.TextColors.yellow,        -- Value color (default: yellow)
    bracket = Config.TextColors.white,       -- Bracket color (default: white)
    hotkey = Config.TextColors.yellow,       -- Hotkey color (default: yellow)
    healthGood = Config.TextColors.green,    -- Good health color (default: green)
    healthBad = Config.TextColors.red,       -- Bad health color (default: red)
    armorGood = Config.TextColors.blue,      -- Good armor color (default: blue)
    armorBad = Config.TextColors.red         -- Bad armor color (default: red)
}

-- Text style configuration
Config.TextStyles = {
    scale = 0.35,                  -- Text scale
    font = 4,                      -- Text font
    color = Config.Colors.default, -- Default text color
    shadow = true,                 -- Enable text shadow
    outline = true                 -- Enable text outline
}

-- Notification configuration
Config.Notifications = {
    type = 'native',       -- Notification type: 'native', 'esx', 'qb', 'sasa', 'mythic', 'ox'
    position = 'top-right', -- Notification position
    duration = 3000,       -- Notification duration in ms
    sound = true           -- Enable notification sound
}

-- Performance configuration
Config.Performance = {
    updateInterval = 100,         -- FPS update interval in ms
    playerUpdateInterval = 500,   -- Player info update interval in ms
    maxDrawDistance = 100.0,      -- Maximum distance to draw info
    smoothFPS = true,             -- Enable FPS smoothing
    cacheEntities = true,         -- Enable entity caching
    optimizeDrawing = true,       -- Enable drawing optimization
    maxVisiblePlayers = 20,       -- Maximum number of visible players
    renderQuality = 'high',       -- Render quality: 'low', 'medium', 'high'
    showThroughWalls = true       -- Show player info through walls
}

-- Localization strings
Config.Locales = {
    ['en'] = {
        ['id'] = 'ID',
        ['name'] = 'Name',
        ['pos'] = 'Pos',
        ['heading'] = 'Heading',
        ['distance'] = 'Distance',
        ['health'] = 'Health',
        ['armor'] = 'Armor',
        ['vehicle'] = 'Vehicle',
        ['engine'] = 'Engine',
        ['body'] = 'Body',
        ['fps'] = 'FPS',
        ['copy_vec3'] = 'Copy Vec3',
        ['copy_vec4'] = 'Copy Vec4',
        ['copy_heading'] = 'Copy Heading',
        ['vec3_copied'] = 'Vec3 coordinates copied!',
        ['vec4_copied'] = 'Vec4 coordinates copied!',
        ['heading_copied'] = 'Heading copied!',
        ['overlay_enabled'] = 'Overlay Enabled',
        ['overlay_disabled'] = 'Overlay Disabled',
        ['no_permission'] = 'You do not have permission to use this feature'
    },
    ['cs'] = {
        ['id'] = 'ID',
        ['name'] = 'Jméno',
        ['pos'] = 'Pozice',
        ['heading'] = 'Směr',
        ['distance'] = 'Vzdálenost',
        ['health'] = 'Zdraví',
        ['armor'] = 'Brnění',
        ['vehicle'] = 'Vozidlo',
        ['engine'] = 'Motor',
        ['body'] = 'Karoserie',
        ['fps'] = 'FPS',
        ['copy_vec3'] = 'Kopírovat Vec3',
        ['copy_vec4'] = 'Kopírovat Vec4',
        ['copy_heading'] = 'Kopírovat Směr',
        ['vec3_copied'] = 'Vec3 souřadnice zkopírovány!',
        ['vec4_copied'] = 'Vec4 souřadnice zkopírovány!',
        ['heading_copied'] = 'Směr zkopírován!',
        ['overlay_enabled'] = 'Overlay Zapnuto',
        ['overlay_disabled'] = 'Overlay Vypnuto',
        ['no_permission'] = 'Nemáte oprávnění používat tuto funkci'
    },
    ['de'] = {
        ['id'] = 'ID',
        ['name'] = 'Name',
        ['pos'] = 'Position',
        ['heading'] = 'Richtung',
        ['distance'] = 'Entfernung',
        ['health'] = 'Gesundheit',
        ['armor'] = 'Rüstung',
        ['vehicle'] = 'Fahrzeug',
        ['engine'] = 'Motor',
        ['body'] = 'Karosserie',
        ['fps'] = 'FPS',
        ['copy_vec3'] = 'Vec3 kopieren',
        ['copy_vec4'] = 'Vec4 kopieren',
        ['copy_heading'] = 'Richtung kopieren',
        ['vec3_copied'] = 'Vec3-Koordinaten kopiert!',
        ['vec4_copied'] = 'Vec4-Koordinaten kopiert!',
        ['heading_copied'] = 'Richtung kopiert!',
        ['overlay_enabled'] = 'Overlay aktiviert',
        ['overlay_disabled'] = 'Overlay deaktiviert',
        ['no_permission'] = 'Du hast keine Berechtigung, diese Funktion zu nutzen'
    },
    ['es'] = {
        ['id'] = 'ID',
        ['name'] = 'Nombre',
        ['pos'] = 'Posición',
        ['heading'] = 'Dirección',
        ['distance'] = 'Distancia',
        ['health'] = 'Salud',
        ['armor'] = 'Armadura',
        ['vehicle'] = 'Vehículo',
        ['engine'] = 'Motor',
        ['body'] = 'Carrocería',
        ['fps'] = 'FPS',
        ['copy_vec3'] = 'Copiar Vec3',
        ['copy_vec4'] = 'Copiar Vec4',
        ['copy_heading'] = 'Copiar Dirección',
        ['vec3_copied'] = '¡Coordenadas Vec3 copiadas!',
        ['vec4_copied'] = '¡Coordenadas Vec4 copiadas!',
        ['heading_copied'] = '¡Dirección copiada!',
        ['overlay_enabled'] = 'Overlay activado',
        ['overlay_disabled'] = 'Overlay desactivado',
        ['no_permission'] = 'No tienes permiso para usar esta función'
    },
    ['fr'] = {
        ['id'] = 'ID',
        ['name'] = 'Nom',
        ['pos'] = 'Position',
        ['heading'] = 'Direction',
        ['distance'] = 'Distance',
        ['health'] = 'Santé',
        ['armor'] = 'Armure',
        ['vehicle'] = 'Véhicule',
        ['engine'] = 'Moteur',
        ['body'] = 'Carrosserie',
        ['fps'] = 'FPS',
        ['copy_vec3'] = 'Copier Vec3',
        ['copy_vec4'] = 'Copier Vec4',
        ['copy_heading'] = 'Copier Direction',
        ['vec3_copied'] = 'Coordonnées Vec3 copiées !',
        ['vec4_copied'] = 'Coordonnées Vec4 copiées !',
        ['heading_copied'] = 'Direction copiée !',
        ['overlay_enabled'] = 'Overlay activé',
        ['overlay_disabled'] = 'Overlay désactivé',
        ['no_permission'] = "Vous n'avez pas la permission d'utiliser cette fonction"
    }
}