# Interface

{% tabs %}
{% tab title="Instalation" %}

* If your server has other interface resources installed, remove them from the resource directory to avoid compatibility issues with [UrantixInterface](https://urantix.com/fivem/scripts/interface).
* Copy the [UrantixInterface](https://urantix.com/fivem/scripts/interface) script folder to your server's resource directory.
* Open your `server.cfg` file in a text editor and add the following line to ensure the script starts with the server:
  * `ensure UrantixInterface`
  * Restart your server to apply the changes and load the [UrantixInterface](https://urantix.com/fivem/scripts/interface).
    {% endtab %}

{% tab title="Dependencies" %}

<table><thead><tr><th width="255.333251953125">Resource</th><th width="271.6666259765625">Version</th><th>Links</th></tr></thead><tbody><tr><td>interact-sound </td><td>Latest</td><td><a href="https://github.com/plunkettscott/interact-sound">Download</a></td></tr><tr><td>ox_lib</td><td>3.33.0+</td><td><a href="https://github.com/overextended/ox_lib/releases/tag/v3.33.0">Download</a></td></tr></tbody></table>
{% endtab %}

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

```lua
Config = {
    Editable = { -- You can adapt everything in "./public"
        Framework = "qbcore", -- esx, qbcore
        Language = "en", -- es
        Notify = "UrantixInterface", -- UrantixInterface, ox_lib, qbcore, esx
        Voice = "pma-voice", -- pma-voice
    },
    Init = {
        HideHudCommand = "toggleinterface", -- Command to hide the UI
        MinimapOnFoot = false, -- Make it so that while you are on foot, you have the minimap activated.
    },
    Status = {
        min_show = {
            health = '49',
            armor = '1',
            hunger = '49',
            thirst = '49',
            stamina = '75',
            oxygen = '99',
        }
    },
    Components = {
        Logo = true,
        Info = true,
        Status = true,
        VoiceUI = true,
        CarHud = true,
        Notify = true,
        TextUI = true,
        Progressbar = true,
        DeathUI = true,
        WeaponUI = true,
    },
    Logo = {
        Url = "",
    },
    CarHud = {
        SeatBeltKey = "B",
        LimiterKey = "L",
        DriftKey = "K",
        CruiseKey = "N",
        PutBeltSound = true, -- Make a sound for you and the people around you when you put on your seatbelt.
    },
    Notify = {
        Type = {
            primary = { icon = 'https://cdn.lordicon.com/vspbqszr.json' },
            info = { icon = 'https://cdn.lordicon.com/yxczfiyc.json' },
            success = { icon = 'https://cdn.lordicon.com/oqdmuxru.json' },
            error = { icon = 'https://cdn.lordicon.com/nqtddedc.json' },
            warning = { icon = 'https://cdn.lordicon.com/vihyezfv.json' },
        },
        Color = {
            ['~w~'] = { type = 'color', replace = 'rgba(206, 206, 206, 1)' },
            ['~r~'] = { type = 'color', replace = 'rgba(255, 0, 0, 1)' },
            ['~g~'] = { type = 'color', replace = 'rgba(37, 211, 102,1)' },
            ['~b~'] = { type = 'color', replace = 'rgba(29, 161, 242,1)' }, 
            ['~y~'] = { type = 'color', replace = 'rgba(255, 255, 0, 1)' },
            ['~p~'] = { type = 'color', replace = 'rgba(114, 137, 218, 1)' },
            ['~o~'] = { type = 'color', replace = 'rgba(255, 127, 0, 1)' },
            ['~c~'] = { type = 'color', replace = 'rgba(0, 255, 255, 1)' },
            ['~m~'] = { type = 'color', replace = 'rgba(255, 0, 255, 1)', },
            ['~u~'] = { type = 'color', replace = 'rgba(0, 0, 255, 1)' },
            ['~s~'] = { type = 'end', replace = '</span>' },
            ['\n'] = { type = 'end', replace = '<br>' },
        },
    },
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: 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://urantix.gitbook.io/urantix-docs/fivem-scripts/interface.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.