Configuration

Guide

The config.lua file controls all aspects of the arena system. This guide explains each section and how to customize them.

Basic Settings

-- Language setting (available: 'en', 'cz')
lang = 'en',

Available Languages:

• 'en' - English

• 'cz' - Czech

Commands

commands = {
    leave = 'leavearena',        -- Command to leave arena
    killstreak = 'killstreak'    -- Command to toggle killstreak effects
},

Usage:

• Players use /leavearena to exit any arena lobby

• Players use /killstreak to disable/enable killstreak sound effects and notifications

Arena Announcements

arena_message = {
    toggle = true,               -- Enable/disable auto messages
    interval = 5 * 60000         -- Message interval (5 minutes)
},

How It Works:

• When enabled, server broadcasts arena player count to all players

• Interval is in milliseconds (60000 = 1 minute)

• Set toggle = false to disable announcements

Gameplay Settings

-- Respawn time after death (only for FFA and TDM modes)
respawn_time = 3, -- seconds

-- Starting routing bucket ID for lobbies
starting_bucket = 100,

Options:

• respawn_time: Delay before respawning after death (FFA/TDM only)

• starting_bucket: First routing bucket ID. Each lobby gets unique bucket for isolation.

Boundary System

-- Prevents players from leaving arena area
boundary_warning_time = 5,      -- Seconds before killing player
boundary_immunity_time = 3,     -- Seconds of immunity after spawn

How Boundaries Work:

1. Player leaves defined map boundary

2. Warning notification appears with countdown

3. After boundary_warning_time, player is eliminated

Killstreak System

killstreaks = {
    { kills = 2,  label = 'DOUBLE KILL',      sound = 'doublekill.mp3' },
    { kills = 3,  label = 'MULTI KILL',       sound = 'multikill.mp3' },
    { kills = 4,  label = 'DOMINATING',       sound = 'dominating.mp3',     reward = 'armor', amount = 100 },
    { kills = 5,  label = 'HOLY SHIT',        sound = 'holyshit.mp3',       reward = 'speed', seconds = 30 },
    -- ... more killstreaks
},

killstreak_volume = 0.1,  -- Sound volume (0.0 - 1.0)

Killstreak Parameters:

• kills: Number of kills needed

• label: Text displayed to player

• sound: Sound file name (place in xsound sounds folder, it's optional, make it false to disable)

• reward: (Optional) 'armor' or 'speed'

• amount: Armor amount to add (for armor reward)

• seconds: Duration in seconds (for speed reward)

Available Rewards:

• armor - Adds armor to player (max 100)

• speed - Increases run speed temporarily

Kill Rewards

kill_reward = {
    health = 50,    -- HP restored per kill
    armor = 50      -- Armor restored per kill
},

Options:

• health: HP added per kill (max 200 total HP)

• armor: Armor added per kill (max 100 total armor)

• Set to false to disable specific reward

NPC Locations

peds = {
    [1] = {
        model = 'U_M_Y_RSRanger_01',                        -- Ped model
        coords = vector4(-548.37, -950.08, 23.42, 212.60),  -- X, Y, Z, Heading
        scenario = 'WORLD_HUMAN_GUARD_STAND',               -- Animation scenario
        blip = {
            sprite = 437,           -- Blip icon
            color = 0,              -- Blip color
            scale = 0.7,            -- Blip size
            label = 'PVP Arena'     -- Blip label
        }
    },
    -- Add more NPCs by adding [2], [3], etc.
},

Adding Multiple NPCs:

lua

peds = {
    [1] = {
        model = 'U_M_Y_RSRanger_01',
        coords = vector4(-548.37, -950.08, 23.42, 212.60),
        -- ... settings
    },
    [2] = {
        model = 's_m_y_marine_01',
        coords = vector4(100.0, -200.0, 30.0, 180.0),
        -- ... settings
    },
}

Game Modes Configuration

FFA Lobbies (Free For All)

ffa_lobbies = {
    {
        id = 'gov_ffa',                      -- Unique lobby identifier
        name = 'Government Facility FFA',     -- Display name
        description = 'Instant respawn, any weapon, no teams',
        map = 'gov',                         -- Map ID (from maps table)
        maxPlayers = 16,                     -- Maximum players
        
        -- Optional: Weapon restrictions
        allowedWeapons = {
            `WEAPON_PISTOL`,
            `WEAPON_COMBATPISTOL`
        }
    },
    -- Add more FFA lobbies
},

FFA Lobby Features:

• Every player fights alone

• Instant respawn after death

• Players spawn at random FFA spawn points

• Optional weapon restrictions

TDM Lobbies (Team Deathmatch)

tdm_lobbies = {
    {
        id = 'gov_tdm',
        name = 'Government Facility TDM',
        map = 'gov',
        maxPlayersPerTeam = 10,     -- 10v10 = 20 total players max
        
        -- Optional: Weapon restrictions
        allowedWeapons = {
            `WEAPON_ASSAULTRIFLE`
        }
    },
    -- Add more TDM lobbies
},

TDM Lobby Features:

• 2 teams competing

• Players spawn at team-specific spawn points

• Instant respawn after death

• Team markers

Showdown Lobbies (Rounds/Elimination)

showdown_lobbies = {
    {
        id = 'gov_rounds',
        name = 'Government Facility Showdown',
        map = 'gov',
        maxPlayersPerTeam = 5,      -- 5v5 format
        roundsToWin = 5,            -- First team to 5 rounds wins
        roundTime = 120,            -- Max 120 seconds per round
    },
    -- Add more Showdown lobbies
},

Showdown Lobby Features:

• Elimination-based rounds

• Round starts with 5 second countdown

• First team to win X rounds wins match

• Full HUD showing round info, scores, alive players

Maps Configuration

maps = {
    {
        id = 'gov',                    -- Unique map identifier
        
        boundaries = {
            points = {
                vector2(2485.15, -303.34),
                vector2(2528.73, -302.64),
                -- ... more points
            },
            minZ = 90.0,  -- Minimum height
            maxZ = 96.0   -- Maximum height
        },
        
        -- FFA spawn points (random)
        spawns = {
            vector4(2502.04, -458.28, 93.09, 175.75),
            vector4(2515.32, -455.20, 93.09, 187.09),
            -- ... more spawns
        },
        
        -- Team 1 spawn points (TDM/Showdown)
        team1_spawns = {
            vector4(2527.20, -311.66, 92.99, 189.92),
            -- ... more spawns
        },
        
        -- Team 2 spawn points (TDM/Showdown)
        team2_spawns = {
            vector4(2517.57, -459.51, 92.99, 0.00),
            -- ... more spawns
        }
    },
    -- Add more maps
}

Creating Boundary Points

Method 1: In-Game Coordinates

1. Stand at boundary edge

2. Note your coordinates

3. Add as vector2(x, y) to points array

4. Continue around perimeter

Tips:

• More points = more accurate boundary

• Keep points in clockwise or counter-clockwise order

• Test boundaries with Debug = true in ic_lib config

Adding New Maps

{
    id = 'my_custom_map',
    
    boundaries = {
        points = {
            vector2(100.0, 100.0),
            vector2(200.0, 100.0),
            vector2(200.0, 200.0),
            vector2(100.0, 200.0),
        },
        minZ = 30.0,
        maxZ = 50.0
    },
    
    spawns = {
        vector4(150.0, 150.0, 35.0, 0.0),
        vector4(160.0, 150.0, 35.0, 0.0),
        -- Add 10-20 spawn points minimum
    },
    
    team1_spawns = {
        vector4(110.0, 150.0, 35.0, 90.0),
        vector4(115.0, 150.0, 35.0, 90.0),
        -- Add 7-15 spawn points
    },
    
    team2_spawns = {
        vector4(190.0, 150.0, 35.0, 270.0),
        vector4(185.0, 150.0, 35.0, 270.0),
        -- Add 7-15 spawn points
    }
}

Debug Mode

Enable in ic_lib/shared/config.lua:

Debug = true

Debug Features:

• Visual boundary lines drawn in-game

• Console logs

• Helpful for map creation and testing

Advanced Customization

Custom Revive Function

Edit open_sv.lua to support custom ambulance scripts:

function HealthAndArmour(playerId, armor)
    -- your code
end

Custom Join/Leave Logic

Edit open_sv.lua for custom behavior:

function CanPlayerJoinLobby(playerId)
    -- Check if player has VIP rank
    if not HasVIPAccess(playerId) then
        Framework.ShowNotification(playerId, "VIP Only!", 'error')
        return false
    end
    return true
end

function PlayerJoinedLobby(playerId)
    -- Give weapons on join
    GiveWeaponToPed(GetPlayerPed(playerId), `WEAPON_ASSAULTRIFLE`, 250, false, true)
end