🎁STARTER PACK

Here check the installation guide

INSTALLATION GUIDE

1. Download from KEYMASTER and Unzip the forge-starter.pack.zip and place this folder in your server's resource folder.

2. Add the resource to your server start config: ensure forge-starter,the name of the folder must not be changed or the resource will not function correctly.

3. Install the SQL that comes with the script.

4. Clear the cache of your server and also of your own FiveM.

5. Reboot the entire server with the forge script well ensured in your server.cfg.

6. Do not rename this script, this may cause it to fail when opening the interface.

CONFIG

The following will explain all the settings, one of the most important things that I recommend you spend a few minutes to understand in order to offer your users the best possible experience.

CONFIG

Fill all the CONFIG very carefully.

Config = { }

--  _____ _____ _   _ ______ _____ _____ _   _______  ___ _____ _____ _____ _   _
-- /  __ \  _  | \ | ||  ___|_   _|  __ \ | | | ___ \/ _ \_   _|_   _|  _  | \ | |
-- | /  \/ | | |  \| || |_    | | | |  \/ | | | |_/ / /_\ \| |   | | | | | |  \| |
-- | |   | | | | . ` ||  _|   | | | | __| | | |    /|  _  || |   | | | | | . ` |
-- | \__/\ \_/ / |\  || |    _| |_| |_\ \ |_| | |\ \| | | || |  _| |_\ \_/ / |\  |
--  \____/\___/\_| \_/\_|    \___/ \____/\___/\_| \_\_| |_/\_/  \___/ \___/\_| \_/

Config.Framework = 'esx' -- Choose between 'esx' or 'qbcore'
Config.SQLWrapper = 'oxmysql' -- Options: 'ghmattimysql', 'mysql-async', 'oxmysql'
Config.UseTarget = false -- If you set it to false, floating text will be displayed
Config.TargetSystem = 'qb-target' -- Choose between 'qb-target' or 'ox_target'
Config.UseStarterPack = true -- Set true to make the button appear in the UI and be usable
Config.UseRoleBasedStarter = false -- Set true to show role selection (CIVILIAN/CRIMINAL) instead of the default single starter pack
Config.UseVehicleStarter = true -- Set true to make the button appear in the UI and be usable
Config.UseGuideBook = true -- Set true to make the button appear in the UI and be usable
Config.UseGuidebookItem = false -- Set to true to enable guidebook as usable item
Config.GuidebookItem = "guidebook" -- Name of the item to use as guidebook

-- Starter Pack Options
Config.StarterPack = {
    Male = { 
        { Name = 'bread', Quantity = 4 }, 
        { Name = 'phone', Quantity = 1 }
    },
    Female = { 
        { Name = 'bread', Quantity = 4 }, 
        { Name = 'phone', Quantity = 1 }
    },
    Money = {
        cash = 1000,
        bank = 1000
    }
}

-- Role-Based Starter Pack Options (used when Config.UseRoleBasedStarter = true)
-- Each role has its own items, money, and gender-specific configuration
-- Only ONE role can be claimed per character
Config.StarterPackRoles = {
    Civilian = {
        Male = {
            { Name = 'bread', Quantity = 5 },
            { Name = 'water', Quantity = 5 },
            { Name = 'phone', Quantity = 1 }
        },
        Female = {
            { Name = 'bread', Quantity = 5 },
            { Name = 'water', Quantity = 5 },
            { Name = 'phone', Quantity = 1 }
        },
        Money = {
            cash = 1500,
            bank = 2000
        }
    },
    Criminal = {
        Male = {
            { Name = 'lockpick', Quantity = 2 },
            { Name = 'bread', Quantity = 3 },
            { Name = 'phone', Quantity = 1 }
        },
        Female = {
            { Name = 'lockpick', Quantity = 2 },
            { Name = 'bread', Quantity = 3 },
            { Name = 'phone', Quantity = 1 }
        },
        Money = {
            cash = 2500,
            bank = 500
        }
    }
}

-- Vehicle Starter Options
Config.VehicleStarter = {
    VehicleInGarage = false, -- If false, it will be a street vehicle with keys. If true, the player owns the vehicle and it can be stored in the garage
    VehicleModels = {
        { Model = "blista", Probability = 0.5 }, -- 50% chance (100% is 1.0)
        { Model = "club", Probability = 0.4 }, -- 40% chance (100% is 1.0)
        { Model = "zentorno", Probability = 0.1 } -- 10% chance (100% is 1.0)   
    }
}
--Add configurable garage provider and defaults
Config.Garage = {
    -- Provider options:
    --   'esx_default'       → ESX owned_vehicles
    --   'qbcore_default'    → QBCore player_vehicles
    --   'jg_advanced_esx'   → ESX + JG Advanced Garages (owned_vehicles with in_garage/garage_id)
    --   'jg_advanced_qb'    → QBCore + JG Advanced Garages (player_vehicles with in_garage/garage_id)
    --   'okok_esx'          → ESX + okokGarage (owned_vehicles with okok columns)
    --   'okok_qb'           → QBCore + okokGarage (player_vehicles with okok columns)
    --   'cd_esx'            → ESX + CD Garage (owned_vehicles with cd columns)
    --   'cd_qb'             → QBCore + CD Garage (player_vehicles with cd columns)
    --   'codem_esx'         → ESX + CodeM Garage (owned_vehicles with stored/parking/favorite)
    --   'codem_qb'          → QBCore + CodeM Garage (player_vehicles with stored/parking/favorite)
    --   'vms_garagesv2_esx' → ESX + VMS Garages V2 (uses vms_garagesv2 exports)
    --   'vms_garagesv2_qb'  → QBCore + VMS Garages V2 (uses vms_garagesv2 exports)
    --   'op_garages'        → OP Garages (vehicle added as owned, player can use any garage)
    Provider = 'esx_default',
    Defaults = {
        esx_default = {
        },
        qbcore_default = {
            garage = 'pillboxgarage',
            state = 0
        },
        jg_advanced_esx = {
            in_garage = 1,
            garage_id = 'Legion Square'
        },
        jg_advanced_qb = {
            in_garage = 1,
            garage_id = 'Legion Square'
        },
        okok_esx = {
            parking = nil,
            doorcondition = nil,
            windowcondition = nil,
            tyrecondition = nil,
            favourite = 0,
            impoundTime = nil,
            location = nil,
            reason = nil,
            sharedwith = '[]',
            vehiclename = nil
        },
        okok_qb = {
            parking = nil,
            doorcondition = nil,
            windowcondition = nil,
            tyrecondition = nil,
            favourite = 0,
            impoundTime = nil,
            location = nil,
            reason = nil,
            sharedwith = '[]',
            vehiclename = nil
        },
        cd_esx = {
            in_garage = 1,
            garage_id = 'A',
            garage_type = 'car',
            job_personalowned = '',
            property = 0,
            impound = 0,
            impound_data = '',
            name = nil
        },
        cd_qb = {
            in_garage = 1,
            garage_id = 'A',
            garage_type = 'car',
            job_personalowned = '',
            property = 0,
            impound = 0,
            impound_data = '',
            name = nil
        },
        codem_esx = {
            stored = 1,
            parking = 'Garage A',
            favorite = '0'
        },
        codem_qb = {
            stored = 1,
            parking = 'Garage A',
            favorite = '0'
        },
        vms_garagesv2_esx = {
            impoundId = 'Impound1' -- Default impound ID for VMS Garages V2
        },
        vms_garagesv2_qb = {
            impoundId = 'Impound1' -- Default impound ID for VMS Garages V2
        },
        op_garages = {
            -- OP Garages - Vehicle is added as owned in player_vehicles/owned_vehicles
            -- Player can save/retrieve from any OP Garages zone on the map
            garage = 'pillboxgarage' -- Default garage name for QBCore
        }
    }
}
-- Vehicle Spawn Locations (supports multiple spawn points to prevent collisions)
-- If multiple players claim vehicles simultaneously, they will spawn at different locations
-- The system uses round-robin rotation to distribute vehicles across available spawn points
Config.VehicleSpawn = {
    -- Multiple locations format (recommended for servers with concurrent claims):
    {
        position = vector3(-1040.4397, -2727.0789, 19.8712),
        heading = 241.3119
    },
    {
        position = vector3(-1046.2606, -2723.9783, 20.0318),
        heading = 238.9994
    },
    -- Add more spawn locations below to prevent vehicle collisions:
    -- {
    --     position = vector3(x, y, z),
    --     heading = heading_value
    -- },
    -- Example with multiple locations:
    -- {
    --     position = vector3(-1045.0, -2730.0, 19.8712),
    --     heading = 241.3119
    -- },
    -- {
    --     position = vector3(-1035.0, -2724.0, 19.8712),
    --     heading = 241.3119
    -- },
}

-- Backward compatibility: If you want to use the old single location format, uncomment below:
-- Config.VehicleSpawn = vector3(-1040.4397, -2727.0789, 19.8712)
-- Config.VehicleSpawnHeading = 241.3119

-- Guide Book Settings
Config.GuideBook = {
    AdminPermissions = { 'god', 'admin' }, -- Users who can access admin mode and add posts in-game
    Categories = { -- The categories that will appear in the GuideBook and that admins will be able to select to create posts. 
        { name = 'WELCOME' },
        { name = 'TUTORIAL' },
        { name = 'JOBS' }
    }
}

Config.GuidebookAnimation = {
    enabled = true, -- Use animation when reading the guidebook
    dict = "missheistdockssetup1clipboard@base", -- which animation dictionary to use
    anim = "base", -- animation name
    prop = {
        enabled = true, -- Use a prop when reading the guidebook
        model = "prop_novel_01", -- prop model
        bone = 18905, -- bone id
        position = vector3(0.12, 0.008, 0.03), -- prop position
        rotation = vector3(0.0, 0.0, 0.0) -- prop rotation
    }
}

-- Location Settings
Config.Location = {
    position = vector3(-1039.4341, -2731.4712, 20.1695), -- Coordinate to open the UI
    interactionDistance = 2.0, -- Distance to interact with the NPC
    markerSettings = {
        enabled = true, -- Display a marker
        type = 21, -- Marker type
        colorR = 255, -- Red component of marker color
        colorG = 255, -- Green component of marker color
        colorB = 255, -- Blue component of marker color
        alpha = 200, -- Marker transparency
        useCustomHeight = true, -- Activate custom height
        heightOffset = 1.0 -- Units to raise the marker
    },
    blipSettings = {
        enabled = true, -- Display a blip on the map
        id = 835, -- Blip ID
        color = 5, -- Blip color
        scale = 0.7, -- Blip scale
        display = 2, -- Blip display type
        name = 'Starter Help' -- Blip name
    },
    npcSettings = {
        enabled = true, -- Enable or disable NPC presence
        heading = 209.1426, -- NPC heading
        model = 'a_m_y_business_03', -- NPC model
        playAnimation = true, -- Enable or disable NPC animation
        animationScenario = 'WORLD_HUMAN_CLIPBOARD' -- Scenario to play
    }
}

-- UI Settings
Config.UI = {
    colors = { -- Change the colors of the UI
        color1 = '#ff0451',        -- Main color (hover buttons, borders, accents)
        color2 = '#7f0027',        -- Secondary color (hover text)
        color3 = '#ff0451',        -- Button background color
        textColor = '#ffffff',     -- Main text color
        guidebookBackground = '#000000',  -- Guidebook content area background
        guidebookTextColor = '#FFFFFF'    -- Text color inside the guidebook
    },
    translations = { -- Translates UI texts
        starterp = 'STARTER PACK',
        vehiclep = 'VEHICLE',
        guidebookp = 'GUIDEBOOK',
        starterp2 = 'STARTER PACK',
        starterdesc = 'The <span>City Council</span> offers you, as an incentive to live in the city, a package of essentials to get you started in the city.',
        claimitem = 'Claim',
        starterveh = 'STARTER VEHICLE',
        startervehdesc = 'The <span>Transport Consortium</span> will temporarily lend you a State vehicle to start moving around the city. Remember this vehicle is given to you by the state. Remembered in the voting!',
        claimvehicle = 'Claim',
        adminbtn = 'Admin Mode',
        exitadmin = 'Exit Admin Mode',
        addbtn = 'Add a new one',
        guidebookt = 'GUIDEBOOK',
        gpsmark = 'Gps Mark',
        delete = 'Delete',
        sure1 = 'Sure?',
        yes1 = 'Yes',
        no1 = 'No',
        save1 = 'Save',
        sure2 = 'Sure?',
        saveconfirm = 'Yes',
        no2 = 'No',
        category1 = 'CATEGORY',
        gpsmark2 = 'Gps Mark',
        yes3 = 'Yes',
        no3 = 'No',
        content1 = 'Content',
        alreadyClaimed = 'Already Claimed',
        roleSelectTitle = 'CHOOSE YOUR PATH',
        roleSelectDesc = 'The <span>City Council</span> allows you to choose your starting path. Select wisely, this choice defines your initial resources.',
        civilianBtn = 'CIVILIAN',
        criminalBtn = 'CRIMINAL',
        civilianDesc = 'Start as a law-abiding citizen with essential supplies to build an honest life in the city.',
        criminalDesc = 'Start on the other side of the law with tools of the trade and street cash.',
        alreadyClaimedRole = 'You have already chosen a path.'
    }
}

-- Translations for Various Messages
Config.Translations = {
    openMenuText = 'Press ~INPUT_CONTEXT~ to open Starter menu',
    openMenuTarget = 'Open the Starter menu',
    itemMissing = 'You don\'t have the needed items',
    alreadyClaimedItem = "You have already claimed the starter pack items.",
    alreadyClaimedVehicle = "You have already claimed the starter vehicle.",
    receivedStarterPack = 'You have received your starter pack. Check your inventory!',
    receivedStarterVehicle = 'You have received a car from the State.',
    gpsMark = 'A route has been marked on your GPS',
    alreadyClaimed = 'You have already claimed this reward.',
    alreadyClaimedRole = 'You have already chosen your starting path.',
    invalidCoordinates = 'Invalid coordinates',
    postCreated = 'Post created successfully.',
    postUpdated = 'Post updated successfully.',
    postDeleted = 'Post deleted successfully.',
    guidebookOpened = 'Guidebook opened.',
    noPermission = "You don't have permission to perform this action.",
    adminModeEntered = 'You have entered Admin Mode. You can now add new posts or edit/delete existing ones.',
    allSpawnLocationsOccupied = 'All vehicle spawn locations are currently occupied. Please try again later.',
    invalidSpawnPosition = 'Error: Invalid spawn position. Please try again.'
}

-- Functions
Config.Functions = {

    DrawText = function(text) -- Customize floating text UI
        AddTextEntry('ALERT_MESSAGE', text)
        BeginTextCommandDisplayHelp('ALERT_MESSAGE')
        EndTextCommandDisplayHelp(0, false, false, -1)
    end,

    Notify = function(text, notifyType, length) -- Notification system (framework or custom)
        -- Normalize message to string to avoid showing references like 'table: 0x..' or unexpected values
        local message
        if type(text) == 'string' then
            message = text
        elseif type(text) == 'number' then
            message = tostring(text)
        elseif type(text) == 'table' then
            -- Try to serialize table; fallback to tostring
            local ok, encoded = pcall(function() return json and json.encode(text) or nil end)
            message = (ok and encoded) or tostring(text)
        else
            message = tostring(text or 'Notification')
        end

        -- Prefer framework-native notifies if available
        if Config.Framework == 'esx' and ESX and ESX.ShowNotification then
            ESX.ShowNotification(message)
            return
        end

        if Config.Framework == 'qbcore' and QBCore and QBCore.Functions and QBCore.Functions.Notify then
            -- QBCore: message[, type[, length]]
            if notifyType ~= nil or length ~= nil then
                QBCore.Functions.Notify(message, notifyType, length)
            else
                QBCore.Functions.Notify(message)
            end
            return
        end

        -- Fallback native notification (works on both frameworks)
        BeginTextCommandThefeedPost('STRING')
        AddTextComponentSubstringPlayerName(message)
        EndTextCommandThefeedPostTicker(false, false)
    end,

    -- Add function for vehicle keys for esx and qb
    -- All export calls are fully wrapped in pcall to prevent "No such export" errors
    VehicleKeys = function(vehicle)
        local plate = GetVehicleNumberPlateText(vehicle)
        local model = GetEntityModel(vehicle)

        -- Helper: safely attempt an export call, returns true if successful
        local function tryExport(fn)
            local ok, err = pcall(fn)
            return ok
        end
        
        -- VMS Garages V2 - Uses wasabi_carlock or other key systems
        if Config.Garage and (Config.Garage.Provider == 'vms_garagesv2_esx' or Config.Garage.Provider == 'vms_garagesv2_qb') then
            if tryExport(function() exports.wasabi_carlock:GiveKey(plate) end) then return end
            if Config.Framework == 'qbcore' then
                TriggerEvent('vehiclekeys:client:SetOwner', plate)
                return
            end
            return
        end
        
        if Config.Garage and (Config.Garage.Provider == 'okok_esx' or Config.Garage.Provider == 'okok_qb') then
            TriggerServerEvent('okokGarage:GiveKeys', plate)
            return
        elseif Config.Garage and (Config.Garage.Provider == 'cd_esx' or Config.Garage.Provider == 'cd_qb') then
            TriggerServerEvent('cd_garage:AddKeysOwnedVehicle', plate, model)
            return
        elseif Config.Garage and (Config.Garage.Provider == 'codem_esx' or Config.Garage.Provider == 'codem_qb') then
            -- Try common key systems used with CodeM Garage
            -- qb-vehiclekeys (QBCore native) - try first if using QBCore
            if Config.Framework == 'qbcore' then
                TriggerEvent('vehiclekeys:client:SetOwner', plate)
                return
            end
            -- MrNewbVehicleKeys
            if tryExport(function() exports.MrNewbVehicleKeys:GiveKeysByPlate(plate) end) then return end
            -- qs-vehiclekeys
            local vehicleName = GetDisplayNameFromVehicleModel(model)
            if tryExport(function() exports['qs-vehiclekeys']:GiveKeys(plate, vehicleName) end) then return end
            -- wasabi_carlock
            if tryExport(function() exports.wasabi_carlock:GiveKey(plate) end) then return end
            -- cd_garage as a fallback if present
            TriggerServerEvent('cd_garage:AddKeysOwnedVehicle', plate, model)
            return
        elseif Config.Garage and Config.Garage.Provider == 'op_garages' then
            -- OP Garages - uses common key systems
            -- QBCore native vehicle keys
            if Config.Framework == 'qbcore' then
                TriggerEvent('vehiclekeys:client:SetOwner', plate)
                return
            end
            -- ESX key systems
            -- MrNewbVehicleKeys
            if tryExport(function() exports.MrNewbVehicleKeys:GiveKeysByPlate(plate) end) then return end
            -- qs-vehiclekeys
            local vehicleName = GetDisplayNameFromVehicleModel(model)
            if tryExport(function() exports['qs-vehiclekeys']:GiveKeys(plate, vehicleName) end) then return end
            -- wasabi_carlock
            if tryExport(function() exports.wasabi_carlock:GiveKey(plate) end) then return end
            return
        end
        if Config.Framework == 'esx' then
            -- ESX generic fallbacks for popular key systems
            -- MrNewbVehicleKeys
            if tryExport(function() exports.MrNewbVehicleKeys:GiveKeysByPlate(plate) end) then return end
            -- qs-vehiclekeys
            local vehicleName = GetDisplayNameFromVehicleModel(model)
            if tryExport(function() exports['qs-vehiclekeys']:GiveKeys(plate, vehicleName) end) then return end
            -- wasabi_carlock
            if tryExport(function() exports.wasabi_carlock:GiveKey(plate) end) then return end
            -- cd_garage fallback
            TriggerServerEvent('cd_garage:AddKeysOwnedVehicle', plate, model)
        elseif Config.Framework == 'qbcore' then
            -- QBCore default vehicle keys (most common, try first)
            TriggerEvent('vehiclekeys:client:SetOwner', plate)
        end
    end
    
}

SERVER_OPEN

QB.SQL

ESX.SQL

If you want to edit the aesthetics or design. You have the HTML open so you can modify the style and everything as you want.

The script is RESPONSIVE for all resolutions as well.