Installation Guide

This document explains the full config.lua file used by the HUD resource. Every section is described in detail so server owners can easily customize the HUD to their needs.

---

Configuration

---

Framework detection & cache key

Go to pinkFrog_hud/shared/config.lua and select your framework: ESX / QBOX / QBCore

Config = {}

Config.frameworkType = 'ESX'
-- Available options:
-- 'ESX' | 'QBCore' | 'QBOX' | 'custom'
-- For 'custom', edit:
-- client/custom/client_editable.lua
-- server/server_editable.lua

Config.CacheKey = 'pinkFrog_hud'

frameworkType Defines which framework the HUD should integrate with.

CacheKey Unique key used to store per-player HUD settings (positions, scale, toggles).

---

Main Accent Color

Config.mainColor = 'linear-gradient(185deg, #FF87D3 1%, #FF173E 100%)'

Defines the main accent color used across the HUD editor and UI.

Supported formats:

• Single color: hex / rgb / rgba

• Two colors separated by | to create a gradient

• Full CSS gradient string

---

HUD Command & Default Style

Config.commandToEnableSettings = 'hud'
Config.DefaultStyle = 2

• commandToEnableSettings – chat command that opens the HUD editor

• DefaultStyle – default HUD style index

---

HUD Styles

Config.Styles = {
    [1] = 'square',
    [2] = 'circle',
    [3] = 'bar',
    [4] = 'flat hexagon',
    [5] = 'hexagon'
}

These styles are selectable by the player inside the HUD editor.

---

Radar Visibility

Config.displayRadarOnlyInVehicle = true

If enabled, the minimap will only be visible while inside a vehicle.

---

Vehicle HUD

Config.VehicleHud = {
    Designs = {
        simple = 'simple',
        extended = 'extended',
        bordered = 'bordered'
    },

    defaultDesign = 'extended',

    speedUnit = 'mph',

    speedMultiplierKmh = 1.0,
    speedMultiplierMph = 0.621371,

    displayInBikeOtherSpeedo = true,
    displayInHeliOtherSpeedo = true,
    displayInPlaneOtherSpeedo = true,
    displayInBoatOtherSpeedo = true
}

Designs Available speedometer layouts shown in the editor.

speedUnit

• kmh

• mph

speedMultiplier Used if your framework sends speed values in a different unit.

displayInXOtherSpeedo Uses alternative speed widgets for bikes, boats, helicopters, and planes.

---

Seatbelt System

Config.Belt = {
    enabled = true,
    helperIcon = true,
    toggleKey = 'B'
}

• Shows seatbelt status on HUD

• Optional warning icon when belt is off

• Can work standalone or be integrated with other belt scripts

---

Vehicle Mileage (Odometer)

Config.Mileage = {
    enabled = true
}

Displays vehicle mileage in the speedometer. Requires mileage logic connection in client/custom/client_editable.lua.

---

Minimap Base Position

Config.Minimap = {
    ['base'] = {
        ['minimap']       = { x = -0.0045, y = 0.0020, w = 0.1500, h = 0.188888 },
        ['minimap_mask']  = { x = 0.0200,  y = 0.0300, w = 0.1110, h = 0.159000 },
        ['minimap_blur']  = { x = -0.0300, y = 0.0220, w = 0.2660, h = 0.237000 }
    }
}

Defines the default minimap position after reset. Editor offsets are applied on top of these values.

---

Voice & Proximity

Config.Voice = {
    talkingColor = '#00c3ff',

    modePercents = {
        whisper = 15,
        normal = 50,
        shouting = 100
    },

    debugPrintProximity = false,
    debugPrintProximityIntervalMs = 2000,
    proximityKey = 'F5'
}

Controls microphone indicator and proximity levels.

---

Cinematic Mode

Config.Cinematic = {
    barSize = 12,
    hideHud = true
}

Adds cinematic black bars and optionally hides the HUD.

---

Identity Panel

Config.Identity = {
    logoUrl = 'assets/logo.png',
    jobToggleInPanel = true,
    secondaryMode = 'ssn'
}

• Server logo support

• Job display toggle

• Optional secondary ID:

  • none

  • cid

  • ssn

---

Crosshair

Config.Crosshair = {
    defaultUrl = 'https://cdn-icons-png.flaticon.com/512/1545/1545211.png',
    defaultScale = 0.6
}

Custom NUI crosshair with URL and scaling.

---

Stress System

Config.StressSystem = {
    enabled = true,
    color = '#FFFFFF',

    decay = {
        enabled = true,
        intervalMs = 5000,
        amount = 1
    },

    crosshair = {
        enabled = true,
        levels = {
            [0]   = { rotSpeedDeg = 0.0,  scaleMul = 1.00, opacity = 1.00 },
            [50]  = { rotSpeedDeg = 5.5,  scaleMul = 1.05, opacity = 0.86 },
            [100] = { rotSpeedDeg = 14.0, scaleMul = 1.12, opacity = 0.68 }
        }
    }
}

Adds a stress HUD element and affects crosshair behavior dynamically.

---

Vehicle Crash Stress

Config.carImpact = {
    enabled = true,
    engineDropPercent = 0.5,
    stressAdd = 6,
    cooldownMs = 1200,
    pollIntervalMs = 250,
    onlyDriver = true,
}

Adds stress, effects, and optional damage on vehicle impacts.

Includes:

• First-person force

• Camera shake

• Screen blink

• Temporary control freeze

• Sound effects

---

Blood Effects

Config.bloodEffects = {
    enabled = true,
    pollIntervalMs = 80,
    cooldownMs = 0,
}

Displays blood overlays depending on:

• Current health %

• Damage taken in one hit

Supports persistent low-health pulsing effect.

---

Player HUD Elements

Config.Elements = {
    health  = { color = '#EB131E', enabled = true },
    armor   = { color = '#95A5A6', enabled = true },
    hunger  = { color = '#FF7700', enabled = true },
    thirst  = { color = '#0066FF', enabled = true },
    stamina = { color = '#FCE00F', enabled = true },
    oxygen  = { color = '#2ECC71', enabled = true },
    mic     = { color = '#FFFFFF', enabled = true }
}

Each element can be:

• Enabled / disabled

• Color customized

• Repositioned in editor

---

Vehicle HUD Elements

Config.VehicleElements = {
    fuel   = { color = '#F39C12', enabled = true },
    light  = { color = '#FFFFFF', enabled = true },
    engine = { color = '#c32700ff', enabled = true }
}

---

Hide Default GTA HUD

Config.HideHud = {
    cash = true,
    mpCash = true,
    weaponIcon = true,
    streetName = true,
    areaName = true,
    vehicleClass = true,
    vehicleName = true,
    reticle = true
}

Removes default GTA HUD components for a clean RP UI.

---

Editor Preview Values

Config.TestVehicleValues = {
    fuel = 5,
    light = 100,
    engine = 40
}

Used only in the HUD editor preview.

---

UI & Translations

Config.UI = {
    locale = 'en',
    translations = {
        en = { ... },
        pl = { ... }
    }
}

Supports multiple languages. You can freely add new locales and translate all editor strings.