Configuration

Customize spawn locations, interface languages, map behavior, and third-party HUD integrations for your FiveM server.

---

System Core (Customize Table)

Global operational settings for the spawn selector.

Customize = {
    Locale = 'en',
    Framework = nil,
    
    Map = {
        ClusterDistance = 3.5,
    },
    
    Client = {
        SetUI = function(visible) 
        -- HUD integration logic
        end,
    },
    
    Locations = {
        -- Spawn points
    }
}

Locale

Sets the interface language.

• Supported: 'en', 'de', 'bg', 'es', 'fr', 'it', 'pt', 'tr', 'other'

Tip: Want to add your own translation? Set this to 'other' and follow the Custom Language Setup guide.

Framework

Defines the server framework.

• Options: nil (Auto-detect - Recommended), 'QBCore', 'ESX', 'Qbox'

---

Map Settings (Customize.Map)

Controls the visual grouping behavior of spawn points on the map interface.

ClusterDistance

Determines how close two markers must be to merge into a single cluster.

• Type: number

• Default: 3.5

Tip: Set a lower number for less clustering. This is useful if you have multiple custom spawn points packed tightly in a specific area (like city center).

---

Client Integrations (Customize.Client)

Control UI visibility to prevent HUD overlap during the spawn selection phase.

SetUI(visible)

Triggered automatically. Use this function to hide/show your server's custom HUD via exports or client events.

SetUI = function(visible)
    -- Default integration with uz_PureHud
    if GetResourceState('uz_PureHud') == 'started' then
        exports['uz_PureHud']:SetHudVisibility(visible)
    end
    
    -- Add your server's specific HUD export/event below:
    -- Example: exports['my_custom_hud']:ToggleDisplay(visible)
end,

---

Spawn Locations (Customize.Locations)

Define the specific points where players can choose to spawn.

Structure Requirements

Property	Type	Description
icon	string	Supports FontAwesome ('fa-solid fa-city'), SVG files ('Apartments.svg'), or direct Image URLs.
name	string	Display name of the spawn area.
coords	vec4	Exact world coordinates (x, y, z, heading).

Example Implementation

Locations = {
    {
        icon = 'fa-solid fa-city',
        name = 'Legion Square',
        coords = vec4(195.17, -933.77, 29.7, 144.5)
    },
    {
        icon = 'fa-solid fa-tree',
        name = 'Paleto Bay',
        coords = vec4(80.35, 6424.12, 31.67, 45.5)
    },
    {
        icon = 'Apartments.svg',
        name = 'Motels',
        coords = vec4(327.56, -205.08, 53.08, 163.5)
    }
}

SVG Setup: If you are using custom .svg files, ensure they are correctly placed inside your resources/icons/ directory for the UI to render them.