CONFIGURATION#

CORE SETTINGS#

Enable Jail Check#

config/config.lua
Copy
Config.EnableJailCheck = true

Description: Determines whether the spawn selector checks if a player is currently jailed.

• true (default): If player is jailed, spawn selector is skipped and they remain in jail
• false: Spawn selector always appears, even if jailed (can break jail scripts)

Enable Last Location#

config/config.lua
Copy
Config.EnableLastLocation = true

Description: Allows players to spawn at their last logout location.

• true (default): "Last Location" option appears in spawn selector
• false: Players must always choose from defined spawn points

How it works:

• Retrieves player's coordinates from last logout
• Generates camera preview automatically
• Shows as first option in spawn selector

Default VRP Spawn#

config/config.lua
Copy
Config.DefaultVRPSpawn = vector3(-206.2997, -1014.8234, 30.1381)

Description: Fallback spawn location for VRP framework when last location cannot be retrieved.

• Only used with VRP framework
• Other frameworks (QB, ESX) use their own fallback systems
• Change this to your server's default spawn point

SPAWN LOCATIONS#

Main Configuration Structure#

config/config.lua
Copy
Settings.Locations = {
    FirstTitle = 'CHOOSE YOUR SPAWN',
    SecondTitle = "LET'S BEGIN",

    {
        name = 'trainstation',
        label = 'Train Station',
        coords = vector3(-223.3253, -996.7120, 34.0096),
        rot = vector3(0, 0, -139.7158),
        spawn = vector4(-206.3010, -1014.7507, 30.1381, 71.0018),
        image = 'trainstation.webp'
        -- job = {'police'} -- Optional
    },
    -- More locations...
}

Location Properties Explained#

UI Titles#

FirstTitle = 'CHOOSE YOUR SPAWN'
SecondTitle = "LET'S BEGIN"

• FirstTitle: Main heading displayed in spawn selector
• SecondTitle: Subtitle or secondary text
• Customize these to match your server's theme

Adding New Spawn Locations#

/onxcaminfo

config/config.lua
Copy
{
    name = 'myspawn',
    label = 'My Custom Spawn',
    coords = vector3(x, y, z),      -- Camera position from /onxcaminfo
    rot = vector3(rx, ry, rz),      -- Camera rotation from /onxcaminfo
    spawn = vector4(sx, sy, sz, h), -- Where player spawns
    image = 'myspawn.webp'          -- Image in web/assets/
}

onex-spawn/web/assets/myspawn.webp

Job-Restricted Spawns#

Restrict certain spawn locations to specific jobs:

config/config.lua
Copy
{
    name = 'policestation',
    label = 'Police Station',
    coords = vector3(440.5, -981.2, 30.6),
    rot = vector3(0, 0, 90),
    spawn = vector4(442.1, -982.0, 30.6, 180.0),
    image = 'policestation.webp',
    job = {'police', 'sheriff'} -- Only police and sheriff can spawn here
}

How it works:

• Script checks player's job on spawn selector load
• If job doesn't match, spawn is disabled in UI
• Works with all frameworks (QB, ESX, VRP)

QB-APARTMENTS LOCATIONS#

If you're using qb-apartments, configure apartment spawn points:

config/config.lua
Copy
Settings.QBApartmentsLocations = {
    FirstTitle = 'CHOOSE YOUR DESIRED APARTMENT',
    SecondTitle = 'APARTMENT SELECT',

    {
        name = 'apartment1',
        label = 'South Rockford Drive',
        coords = vector3(-690.5970, -1090.0488, 21.1570),
        rot = vector3(0, 0, -115.7110),
        spawn = vector4(-677.6673, -1099.8654, 14.5361, 99.3977),
        image = 'southrockford.PNG',
        customspawn = true
    },

    {
        name = 'apartment2',
        label = 'Morningwood Blvd',
        coords = vector3(-1261.2889, -426.6606, 45.1381),
        rot = vector3(0, 0, -106.7638),
        spawn = vector4(-1281.2041, -425.4779, 34.6393, 124.4317),
        image = 'Morningwood.PNG',
        customspawn = true
    }
}

Important Notes:

• Set customspawn = true for apartment spawns
• name must match apartment identifiers in qb-apartments
• These only appear when player doesn't own an apartment

CUSTOM SPAWN HANDLERS#

DoCustomSpawn Function#

For advanced spawn logic, use the DoCustomSpawn() function:

config/config.lua
Copy
function DoCustomSpawn(data)
    local IndexName = data.name

    -- QB Apartments
    if IndexName == "apartment1" or IndexName == "apartment2" then
        DoScreenFadeOut(50)
        Wait(200)
        TriggerServerEvent("apartments:server:CreateApartment", IndexName, data.label, true)
        Wait(2000)
        DoScreenFadeIn(100)

    -- Your custom spawn logic
    elseif IndexName == "customlocation" then
        -- Custom implementation here
        -- Example: Trigger events, set player data, etc.
    end
end

Parameters:

• data.name - Spawn location identifier
• data.label - Display name
• data.spawn - Spawn coordinates (vector4)
• data.coords - Camera coordinates
• data.rot - Camera rotation

When to use:

• Integrating with housing scripts
• Custom spawn animations
• Server-side spawn verification
• Special spawn conditions

EXAMPLE CONFIGURATIONS#

Basic Server Setup#

config/config.lua
Copy
Config.EnableJailCheck = true
Config.EnableLastLocation = true

Settings.Locations = {
    FirstTitle = 'CHOOSE YOUR SPAWN',
    SecondTitle = "LET'S BEGIN",

    {
        name = 'city',
        label = 'City Center',
        coords = vector3(215.6, -809.2, 30.7),
        rot = vector3(0, 0, 180),
        spawn = vector4(220.5, -810.1, 30.7, 90.0),
        image = 'city.webp'
    },

    {
        name = 'beach',
        label = 'Beach',
        coords = vector3(-1873.4, -1258.1, 13.4),
        rot = vector3(0, 0, -37.4),
        spawn = vector4(-1850.4, -1232.8, 13.0, 321.2),
        image = 'beach.webp'
    }
}

Roleplay Server with Job Restrictions#

config/config.lua
Copy
Settings.Locations = {
    FirstTitle = 'SELECT SPAWN LOCATION',
    SecondTitle = 'WHERE WOULD YOU LIKE TO BEGIN?',

    -- Public spawns
    {
        name = 'legion',
        label = 'Legion Square',
        coords = vector3(215.6, -809.2, 30.7),
        rot = vector3(0, 0, 180),
        spawn = vector4(220.5, -810.1, 30.7, 90.0),
        image = 'legion.webp'
    },

    -- Police only
    {
        name = 'mrpd',
        label = 'Mission Row PD',
        coords = vector3(440.5, -981.2, 30.6),
        rot = vector3(0, 0, 90),
        spawn = vector4(442.1, -982.0, 30.6, 180.0),
        image = 'mrpd.webp',
        job = {'police'}
    },

    -- EMS only
    {
        name = 'hospital',
        label = 'Pillbox Medical',
        coords = vector3(338.8, -583.9, 43.2),
        rot = vector3(0, 0, 180),
        spawn = vector4(341.2, -581.5, 43.2, 270.0),
        image = 'hospital.webp',
        job = {'ambulance', 'doctor'}
    }
}

CONFIGURATION TIPS#