> For the complete documentation index, see [llms.txt](https://savana.gitbook.io/savanascripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://savana.gitbook.io/savanascripts/scripts/hud/config.md).

# Config

{% tabs %}
{% tab title="config.lua" %}

```lua
config = {
    framework = "qb",
    logo = "https://media.discordapp.net/attachments/1154439628753993728/1154514788555173938/image.png", -- You can change your server logo here.
    Delay = 500,
    speedMultiplier = 3.6,
    SeatbeltKey = "k",
    pingDelay = 15, 
    fuel = "ox", -- {"qbus_fuel", "ox", "legacy", "savana-fuel","x-fuel"} (By default "qbus_fuel", "ox", "legacy", "savana-fuel","x-fuel" can be used. You can integrate the fuel export you use from base.lua to k.getFuel as you wish.)
    interactSound = false, -- If you are using Esx, interactsound should be false.
    minimapscale = 1000, -- (Minimap Zoom level) Enter values between 1-1000 (Recommended: 750-1000)
    seatbeltnotify = true, -- It sends a notification that your seat belt is not fastened. If you want to turn it off, you can do it wrong.
    notifytimer = 10000, -- Set a time limit to signal that the belt is not fastened. 1000 = 1 second
    seatbeltwarnsound = true, -- If the seat belt is not fastened, it warns the driver with a sound when 50 km/h is reached. You can make it false to turn it off.
    seatBeltLoopnotify = true, -- It sends a notification every time the player removes and connects the belt. You can false to turn this off.



    VehClassStress = { -- Enable/Disable gaining stress from vehicle classes in this table
        ['0'] = true, -- Compacts
        ['1'] = true, -- Sedans
        ['2'] = true, -- SUVs
        ['3'] = true, -- Coupes
        ['4'] = true, -- Muscle
        ['5'] = true,  -- Sports Classics
        ['6'] = true, -- Sports
        ['7'] = true, -- Super
        ['8'] = true, -- Motorcycles
        ['9'] = true, -- Off Road
        ['10'] = true, -- Industrial
        ['11'] = true,  -- Utility
        ['12'] = true,  -- Vans
        ['13'] = false, -- Cycles
        ['14'] = false, -- Boats
        ['15'] = false, -- Helicopters
        ['16'] = false, -- Planes
        ['18'] = false, -- Emergency
        ['19'] = false, -- Military
        ['20'] = false, -- Commercial
        ['21'] = false  -- Trains
    },

    Status = {
        {
            name= 'mic',
            value = 0,
            colors = {
                primary= '#04FA00',
                secondary= '#fff',
                iconColor= '#000',
                strokeColor= '#ffffff50'
            },
            icon = "FaMicrophone",
            display = true
        },
        {
            name= 'health',
            value = 0,
            colors = {
                primary= '#46DFC3',
                secondary= '#0EFFD3',
                iconColor= '#000',
                strokeColor= '#46DFC31A'
            },
            icon = "FaHeart",
            display = true
        },
        {
            name = 'armor',
            value = 0,
            colors = {
                primary= '#46DFC3',
                secondary= '#0EFFD3',
                iconColor= '#000',
                strokeColor= '#46DFC31A'
            },
            icon = "FaShieldAlt",
            display = true
        },
        {
            name= 'hunger',
            value = 100,
            colors = {
                primary= '#CB991A',
                secondary= '#FFBB0E',
                iconColor= '#000',
                strokeColor= '#FFBB0E1A'
            },
            icon = "FaHamburger",
            display = true
        },

        {
            name= 'thirst',
            value = 100,
            colors = {
                primary= '#CB991A',
                secondary= '#FFBB0E',
                iconColor= '#000',
                strokeColor= '#FFBB0E1A'
            },
            icon = "FaTint",
            display = true
        },
        {
            name= 'oxygen',
            value = 0,
            colors = {
                primary= '#D21386',
                secondary= '#FF0E9F',
                iconColor= '#000',
                strokeColor= '#FF0E9F47'
            },
            icon = "FaLungs",
            display = true
        },
        {
            name = 'stress',
            value = 0,
            colors = {
                primary= '#D21386',
                secondary= '#FF0E9F',
                iconColor= '#000',
                strokeColor= '#FF0E9F47'
            },
            icon = "FaBrain",
            display = true

        }
    },

    Lang = {
        ["cruise_unavailable"] = "Cruise control unavailable",
        ["cruise_activated"] = "Cruise Activated: ",
        ["cruise_deactivated"] = "Cruise Deactivated",
        ["belt_installed"] = "Seat Belt Installed",
        ["belt_removed"] = "Seat Belt Removed",
        ["belt_info"] = "Fasten Your Seat Belt",

        ["save"] = "Save",
        ["restore"] = "Restore",
        ["title"] = "Hud Settings",
        ["title_description"] = "Savana Scripts",

        ["mapdisplay"] = "Map Display",
        ["alwaysdisplaymap"] = "Always Map",
        ["mapborder"] = "Map Border",
        ["maptype"] = "Map Type",
        ["cinematic"] = "Cinematic",
        ["speedtype"] = "Speed Type",
        ["delay"] = "FPS",
        ["showinfobox"] = "Show Info Box",
        ["infoboxtype"] = "Info Box Type",
        ["image"] = "Server Image",
        ["selectedHud"] = "Hud",
        ["show"] = "Show",
        ["hide"] = "Hide",
        ["high"] = "High",
        ["low"] = "Low",
        ["circle"] = "Circle",
        ["square"] = "Square",
        ["type 1"] = "Type 1",
        ["type 2"] = "Type 2",
        ["square 1"] = "Square 1",
        ["square 2"] = "Square 2",
        ["circular 1"] = "Circular 1",
        ["circular 2"] = "Circular 2",
        
        ["mic"] = "Mic",
        ["health"] = "Health",
        ["armor"] = "Armor",
        ["hunger"] = "Hunger",
        ["thirst"] = "Thirst",
        ["oxygen"] = "Oxygen",
        ["stress"] = "Stress",
    },



    -- custom icons
        --cash,
        --bag,
        --ping
        --users
    
    -- if you want more icons you can get 
    --https://react-icons.github.io/react-icons/icons?name=fa
    informationBoxs = {
        {
            icon = "cash",
            value = function()
                local x = config.framework == "esx" and "money" or "cash"
                return k.GetPlayerMoney(x)
            end,
            label = "Cash",
            name = "cash",
        },
        {
            icon = "cash",
            value = function()
                return k.GetPlayerMoney("bank")
            end,
            label = "Bank",
            name = "bank"
        },
        {
            icon = "ping",
            value = function()
                return LocalPlayer.state['ping']
            end,
            label = "Ping",
            name = "ping"
        },
        {
            icon = "users",
            value = function()
                return GetPlayerServerId(PlayerId())
            end,
            label = "Id",
            name = "id"
        },
        {
            icon = "bag",
            value = function()
                if config.framework == 'qb' then
                    PlayerData = QBCore.Functions.GetPlayerData()
                    while PlayerData == nil do
                        PlayerData = QBCore.Functions.GetPlayerData()
                        Wait(1000)
                    end
                    if PlayerData.job ~= nil then
                        return PlayerData.job.name
                    end
                elseif config.framework == 'esx' then
                    return ESX.GetPlayerData().job.name
                end
            end,
            label = "Job",
            name = "job",
            col_span = 2
        },
    }
}

```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://savana.gitbook.io/savanascripts/scripts/hud/config.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
