Configuration

Config.AdminAce = "command"             -- Who can save the server default HUD
Config.AllowPlayerCustomisation = true  -- false = players get the server default and can't open /hud

Config.Menu = {
    command     = "hud",
    editCommand = "hudedit",
    keybind     = { enabled = false, defaultKey = "F7" },
}

Config.Cinematic = {
    enabled = true,
    command = "cinematic",
    keybind = {
        enabled    = true,   -- Registers a rebindable key
        defaultKey = "",     -- "" = unbound until the player sets one
    },
}

Config.VehicleControl = {
    enabled = true,
    command = "vehcontrol",   -- "" = no command
    keybind = {
        enabled    = true,
        defaultKey = "F6",
    },
    passengers       = "own", -- "own" | "all" | "none"
    seatSwapMaxSpeed = 3.0,   -- m/s
    blockedClasses   = { [8] = true, [13] = true, [21] = true }, -- Motorcycles, bicycles, trains
}

Config.Builder = {
    enabled      = true,
    command      = "hudbuilder",
    ace          = "command",   -- Who can open the builder
    playerChoice = true,        -- false = everyone gets the default design, no picking in /hud
}

Config.UpdateRates = {
    player   = 250,   -- Health, armour, needs, money, voice
    vehicle  = 60,    -- Speed, rpm, gear, fuel...
    location = 400,   -- Street, zone, postal, speed limit
    compass  = 50,
    weapon   = 100,   -- Only while armed
}

Config.HideDefaultComponents = { 1, 2, 3, 4, 6, 7, 8, 9, 13, 17, 20 }  -- GTA HUD parts hidden while the HUD is up

Config.HideWhen = {
    pauseMenu       = true,
    cinematicCamera = true,
    dead            = false,
    inventoryOpen   = true,   -- LocalPlayer.state.invOpen (ox_inventory / qb-inventory)
}

Config.Minimap = {
    enabled          = true,   -- false = leave the minimap alone
    hideHealthArmour = true,   -- Remove GTA's health / armour bars under the map
    offset           = { x = 0.0, y = 0.0 },  -- Fine-tune if the map sits a pixel off
    -- shapes = { ... }        -- Native layout per shape; rarely needs changing
}

Config.DashScreen = {
    enabled          = true,
    command          = "dashscreen",       -- Player on / off toggle
    adjustCommand    = "dashscreenadjust", -- Live positioning tool
    saveAce          = "command",          -- Who may save positions for everyone
    firstPersonOnly  = true,
    passengers       = true,
    hideOverlay      = { "speedometer", "vehicleStatus", "speedLimit" }, -- {} keeps the whole HUD

    auto = { ... },                        -- Automatic placement, see below
    noScreenClasses = { [8] = true, [13] = true, [14] = true, [15] = true, [16] = true, [21] = true },
    models = {
        [`neon`] = { offset = vec3(0.44, 0.62, 0.33), rotation = vec3(-24.0, 0.0, 1.0) },
        -- [`blista`] = false,             -- No screen in this model
    },
}

Config.Seatbelt = {
    provider = "auto",   -- "auto" | "qbx_seatbelt" | "kartik-mechanic" | "internal" | "none"
    warningInterval = 15, -- Seconds before the first unbuckled / no-helmet chime, and between chimes
    internal = {
        key                 = "B",
        ejectSpeedUnbuckled = 20.0,  -- m/s
        ejectSpeedBuckled   = 60.0,  -- m/s
        disableExit         = true,  -- Block leaving the vehicle while buckled
    },
    noSeatbeltClasses = { [8] = true, [13] = true, [14] = true, [15] = true, [16] = true, [21] = true },
}

Config.CruiseControl = { provider = "auto", key = "Y" }  -- "auto" | "qbx_smallresources" | "internal" | "none"

Config.Indicators = {
    enabled    = true,
    left       = "LEFT",
    right      = "RIGHT",
    hazards    = "UP",
    autoCancel = true,   -- Cancel after the turn
}

Config.Stress = {
    enabled       = true,
    disableForLEO = true,
    speeding = { enabled = true, minSpeed = 50.0, minSpeedUnbuckled = 30.0, interval = 10000, amount = { 1, 3 } },
    shooting = { enabled = true, chance = 0.1, amount = { 1, 3 }, whitelistedWeapons = { ... } },
    effects  = { ... },   -- Screen effects per stress level
}

Config.CustomStatuses = {
    max        = 48,   -- Most statuses that can exist at once
    updateRate = 50,   -- ms between UI updates while any exist

    -- Statuses that exist from the start; scripts then only call setStatusValue
    presets = {
        -- nitro = { label = "Nitro", icon = "flame", color = "#22d3ee", value = 0, context = "vehicle", mode = "auto", autoShow = "notEmpty", order = 75 },
    },
}

Config.Postals = {
    enabled  = true,
    file     = "data/postals.json",   -- The postal map
    commands = { "postal", "p" },     -- {} for no navigation commands
}

[{ "x": 0.0, "y": 0.0, "code": "100" }]

Config.Notifications = {
    provider = "ox_lib",   -- "ox_lib" | "custom" (edit bridge/notification/client/notification.lua)
    title    = "HUD",
    duration = 4000,
    position = "top-right",
}

Config.Options = {
    theme           = { allowed = "all", default = "signal",   locked = false },
    panels          = { allowed = "all", default = "floating", locked = false },
    weapon          = { allowed = "all", default = "signal",   locked = false },
    status          = { allowed = "all", default = "signal",   locked = false },
    statusShape     = { allowed = "all", default = "rounded",  locked = false },
    speedometer     = { allowed = "all", default = "signal",   locked = false },
    motorcycle      = { allowed = "all", default = "car",      locked = false },
    evSpeedometer   = { allowed = "all", default = "volt",     locked = false },
    boatSpeedometer = { allowed = "all", default = "helm",     locked = false },
    speedLimitSign  = { allowed = "all", default = "us",       locked = false },
    aircraft        = { allowed = "all", default = "analogue", locked = false },
    bicycle         = { allowed = "all", default = "cadence",  locked = false },
    train           = { allowed = "all", default = "transit",  locked = false },
    units           = { allowed = "all", default = "mph",      locked = false },
    mapShape        = { allowed = "all", default = "square",   locked = false },
}

speedometer = { allowed = { "signal", "vector", "ember" }, default = "ember", locked = false },

Config.DefaultSettings = {
    general = {
        timeFormat = "24h",               -- "24h" | "12h"
    },
    -- When each map element shows: "always" | "vehicle" | "foot" | "never"
    map = {
        minimap     = "always",
        compass     = "always",
        location    = "always",           -- Street name and area
        postal      = "always",
        postalStyle = "widget",           -- "widget" (own panel) | "inline" (on the street name line)
        frameWidth  = 0,                  -- Outline around the minimap in px, 0-6 (0 = none)
        frameColor  = "",                 -- Outline / glow colour, "" = the theme accent
        frameShadow = "none",             -- "none" | "shadow" | "glow"
    },
    waypoint = {
        mode          = "always",         -- Distance to the waypoint (only while one is set)
        color         = "#a44cf2",        -- Also recolours the GPS route and waypoint blip
        compassMarker = true,             -- Mark the waypoint on the compass
    },
    info = {
        idStyle     = "hash",             -- Server ID: "hash" (#12) | "label" (ID 12) | "badge"
        moneyFormat = "full",             -- "full" ($1,250,000) | "short" ($1.25M)
        icons       = false,              -- true = wallet / bank icons instead of the words
    },
    voice = {
        style = "ring",                   -- Mic indicator: "ring" | "bars" | "dot" | "minimal"
        label = true,                     -- TALKING / range text beside the indicator
    },
}