Configuration

Complete configuration guide for the Boyraz Spawn Selector system. Customize spawn locations, framework settings, and client integrations.

Documentation Sections

• System Configuration

• Spawn Locations

• Client Integrations

---

System Configuration (Customize Table)

Global system parameters and operational settings.

Customize = {
    Locale = 'en',
    Framework = nil,
    
    Client = {
        SetUI = function(visible) 
        -- ...
        end,
    },
    
    Locations = {
        -- ... 
    }
}

Locale

Determines the language for the spawn selector interface.

• Type: string

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

• Default: 'en'

Example:

Locale = 'en',  -- English

---

Framework

Specifies your server's framework. Set to nil for automatic detection.

• Type: nil | string

• Values: nil (auto-detect), 'QBCore', 'ESX', 'Qbox'

• Default: nil

Example:

Framework = nil,  -- Automatic framework detection

Recommended: Leave as nil to allow automatic framework detection. Only set manually if you experience compatibility issues.

---

Client Integrations (Customize.Client)

Client-side integration functions for third-party resources.

SetUI

Function to control UI/HUD visibility during spawn selection.

Parameters:

• visible (boolean) - true to show UI, false to hide

Default Implementation:

SetUI = function(visible)
    -- Integration with uz_PureHud
    if GetResourceState('uz_PureHud') == 'started' then
        exports['uz_PureHud']:SetHudVisibility(visible)
    end
    
    -- Add your own HUD integration here
    -- Example: exports['your_hud']:ToggleHud(visible)
end,

Custom Integration Examples:

ESX HUD

SetUI = function(visible)
    if GetResourceState('esx_hud') == 'started' then
        exports['esx_hud']:SetDisplay(visible)
    end
end,

QB HUD

Custom HUD

---

Spawn Locations (Customize.Locations)

Define predefined spawn points for players to choose from.

Location Structure

Each location must include the following properties:

Property	Type	Required	Description
icon	string	✅	Icon identifier for the location
name	string	✅	Display name of the location
description	string	✅	Brief description shown to players
coords	vec4	✅	Spawn coordinates (x, y, z, heading)

Default Configuration

Locations = {
    {
        icon = '',
        name = 'Legion Square',
        description = 'Downtown Los Santos - Popular meeting spot',
        coords = vec4(195.17, -933.77, 29.7, 144.5)
    },
    {
        icon = '',
        name = 'Paleto Bay',
        description = 'Quiet northern town with scenic views',
        coords = vec4(80.35, 6424.12, 31.67, 45.5)
    },
    {
        icon = '',
        name = 'Motels',
        description = 'Budget accommodation in the city',
        coords = vec4(327.56, -205.08, 53.08, 163.5)
    },
}

Adding Custom Locations

To add new spawn locations, simply add a new table entry to the Locations array:

Locations = {
    -- Existing locations...
    
    {
        icon = '',
        name = 'Sandy Shores',
        description = 'Desert town with airstrip access',
        coords = vec4(1836.11, 3688.02, 34.27, 210.5)
    },
    {
        icon = '',
        name = 'Vespucci Beach',
        description = 'Beachfront location near the pier',
        coords = vec4(-1203.78, -1566.37, 4.61, 125.0)
    },
}

Tip: You can add unlimited spawn locations. Players will be able to scroll through all available options.

---

Icon Configuration

The icon property supports custom icon identifiers. Configure icons based on your UI system.

Example Icons:

icon = '🏢',  -- Building emoji
icon = '🏖️',  -- Beach emoji  
icon = '🏠',  -- House emoji
icon = 'location',  -- Custom icon identifier

Icon System: The icon format depends on your UI implementation. Contact support for custom icon integration.

---

Coordinate Reference

The coords property uses the vec4 format:

coords = vec4(x, y, z, heading)

• x, y, z: World coordinates

• heading: Player facing direction (0-360 degrees)

Finding Coordinates

To get coordinates for your spawn locations, use one of these methods:

TxAdmin Method

Using TxAdmin Console (Recommended - Universal)

1. Join your server and navigate to the desired location

2. Press F8 to open the console

3. Type: getcoords or getpos

4. Copy the coordinates displayed (format: x, y, z, heading)

5. Convert to vec4 format: vec4(x, y, z, heading)

Alternative:

• Open TxAdmin panel

• Go to Live Console

• Use the Teleport feature to save locations

In-Game Commands

Script Method

Heading Matters: Make sure to set the heading correctly so players face the right direction when they spawn.

---

Complete Configuration Example

Customize = {
    ---Localization language
    ---@type 'en'|'de'|'bg'|'es'|'fr'|'it'|'pt'|'tr'
    Locale = 'en',
    
    ---Framework detection
    ---@type nil|'QBCore'|'ESX'|'Qbox'
    ---Set to nil for automatic detection
    Framework = nil,
    
    ---Client-side integrations
    Client = {
        ---Toggle UI visibility (HUD/Interface)
        ---@param visible boolean True to show UI, false to hide
        SetUI = function(visible)
            if GetResourceState('uz_PureHud') == 'started' then
                exports['uz_PureHud']:SetHudVisibility(visible)
            end
        end,
    },
    
    ---Predefined spawn locations for players
    Locations = {
        {
            icon = '',
            name = 'Legion Square',
            description = 'Downtown Los Santos - Popular meeting spot',
            coords = vec4(195.17, -933.77, 29.7, 144.5)
        },
        {
            icon = '',
            name = 'Paleto Bay',
            description = 'Quiet northern town with scenic views',
            coords = vec4(80.35, 6424.12, 31.67, 45.5)
        },
        {
            icon = '',
            name = 'Motels',
            description = 'Budget accommodation in the city',
            coords = vec4(327.56, -205.08, 53.08, 163.5)
        },
        {
            icon = '',
            name = 'Sandy Shores',
            description = 'Desert town with airstrip access',
            coords = vec4(1836.11, 3688.02, 34.27, 210.5)
        },
    }
}

---

Best Practices

Performance Tips:

• Keep descriptions concise and clear

• Test each spawn location in-game before deploying

• Ensure coordinates are accurate and safe (no spawning in walls)

• Balance the number of locations (5-10 is ideal)

Avoid:

• Spawn points in restricted areas

• Coordinates that spawn players underground

• Too many locations (can overwhelm players)

• Duplicate location names