Installation

This guide will walk you through installing prp-boosting on your FiveM server.

Installation steps

1

Download the resource

Download prp-boosting, prp-boosting-assets and prp-minigames from the CFX portal and place it in your resources folder.

2

Add to server.cfg

Add prp-boosting to your server.cfg after all dependencies.

ensure oxmysql
ensure ox_lib
ensure prp-bridge
ensure prp-minigames
ensure prp-boosting-assets
ensure prp-boosting

3

Database

The script creates the required tables automatically on first start via oxmysql, or you can run the queries manually.

4

Add items

Add the required items to your inventory resource — see Items below.

5

Configure sh_config.lua

Open sh_config.lua to configure level thresholds, prestige milestones, and target vehicles per class.

6

Configure sv_config.lua

Open sv_config.lua to configure class unlock levels, group size, payments, mission pools, VIN scratch, prestige perks, and the contract marketplace.

7

Optional: inventory icons

Custom inventory icons are included in the installation/inventory icons folder. Copy them to your inventory resource's image directory if you'd like to use them.

Items

Add all required items to your inventory resource using the format appropriate for your setup.

Add the items below to your ox_inventory into data/items.lua.

["lockpick"] = {
    label = "Lockpick",
    weight = 50,
    stack = true,
},
["pdm_blowtorch"] = {
    label = "Blowtorch",
    weight = 300,
    stack = false,
},
["bolt_cutter"] = {
    label = "Bolt Cutter",
    weight = 500,
    stack = false,
},
["diving_angle_grinder"] = {
    label = "Angle Grinder",
    weight = 800,
    stack = false,
},
["empty_fake_id"] = {
    label = "Empty Fake ID",
    weight = 50,
    stack = false,
},
["fake_id"] = {
    label = "Fake ID",
    weight = 50,
    stack = false,
},
["boosting_bank_key"] = {
    label = "Bank Key",
    weight = 50,
    stack = false,
},
["boosting_jewelery_key"] = {
    label = "Jewelry Key",
    weight = 50,
    stack = false,
},
["boosting_pdm_key"] = {
    label = "PDM Key",
    weight = 50,
    stack = false,
},
["boosting_obd_d"] = {
    label = "Very Basic OBD Tools",
    weight = 100,
    stack = false,
},
["boosting_obd_c"] = {
    label = "Basic OBD Tools",
    weight = 100,
    stack = false,
},
["boosting_obd_b"] = {
    label = "Semi Advanced OBD Tools",
    weight = 100,
    stack = false,
},
["boosting_obd_a"] = {
    label = "Advanced OBD Tools",
    weight = 100,
    stack = false,
},
["boosting_obd_s"] = {
    label = "Premium OBD Tools",
    weight = 100,
    stack = false,
},
["boosting_obd_x"] = {
    label = "OBD Tools",
    weight = 100,
    stack = false,
},
["boosting_vinscratch_d"] = {
    label = "Vin Scratch Contract (D)",
    weight = 10,
    stack = true,
},
["boosting_vinscratch_c"] = {
    label = "Vin Scratch Contract (C)",
    weight = 10,
    stack = true,
},
["boosting_vinscratch_b"] = {
    label = "Vin Scratch Contract (B)",
    weight = 10,
    stack = true,
},
["boosting_vinscratch_a"] = {
    label = "Vin Scratch Contract (A)",
    weight = 10,
    stack = true,
},
["boosting_vinscratch_s"] = {
    label = "Vin Scratch Contract (S)",
    weight = 10,
    stack = true,
},
["boosting_contract_d"] = {
    label = "Boosting Contract (D)",
    weight = 10,
    stack = true,
},
["boosting_contract_c"] = {
    label = "Boosting Contract (C)",
    weight = 10,
    stack = true,
},
["boosting_contract_b"] = {
    label = "Boosting Contract (B)",
    weight = 10,
    stack = true,
},
["boosting_contract_a"] = {
    label = "Boosting Contract (A)",
    weight = 10,
    stack = true,
},
["boosting_contract_s"] = {
    label = "Boosting Contract (S)",
    weight = 10,
    stack = true,
},
["boosting_scrap"] = {
    label = "Scrap",
    weight = 100,
    stack = false,
},
["boosting_scrap_bonnet"] = {
    label = "Bonnet",
    weight = 100,
    stack = false,
},
["boosting_scrap_boot"] = {
    label = "Boot",
    weight = 100,
    stack = false,
},
["boosting_scrap_door_dside_f"] = {
    label = "Door",
    weight = 100,
    stack = false,
},
["boosting_scrap_door_dside_r"] = {
    label = "Door",
    weight = 100,
    stack = false,
},
["boosting_scrap_door_pside_f"] = {
    label = "Door",
    weight = 100,
    stack = false,
},
["boosting_scrap_door_pside_r"] = {
    label = "Door",
    weight = 100,
    stack = false,
},
["boosting_scrap_wheel_lf"] = {
    label = "Wheel",
    weight = 100,
    stack = false,
},
["boosting_scrap_wheel_lr"] = {
    label = "Wheel",
    weight = 100,
    stack = false,
},
["boosting_scrap_wheel_rf"] = {
    label = "Wheel",
    weight = 100,
    stack = false,
},
["boosting_scrap_wheel_rr"] = {
    label = "Wheel",
    weight = 100,
    stack = false,
},
["boosting_hack_a"] = {
    label = "Green Pendrive",
    weight = 10,
    stack = true,
},
["boosting_hack_b"] = {
    label = "Blue Pendrive",
    weight = 10,
    stack = true,
},
["boosting_hack_c"] = {
    label = "Aqua Pendrive",
    weight = 10,
    stack = true,
},
["boosting_hack_d"] = {
    label = "White Pendrive",
    weight = 10,
    stack = true,
},
["boosting_hack_s"] = {
    label = "Purple Pendrive",
    weight = 10,
    stack = true,
},
["boosting_hack_x"] = {
    label = "Red Pendrive",
    weight = 10,
    stack = true,
},
["boosting_tablet"] = {
    label = "Boosting Tablet",
    weight = 100,
    stack = false,
},

TIP

Item names for lockpick, pdm_blowtorch, bolt_cutter, diving_angle_grinder, and other items can be customised in the mission config files under server/missions/. Match them to whatever item names your server already uses.

Weapons

Add all required weapons to your inventory resource using the format appropriate for your setup.

Add items listed below to your ox_inventory into data/weapons.lua.

-- Briefcase (weapon)
['WEAPON_BRIEFCASE'] = {
    label = 'Briefcase',
    weight = 500,
    durability = 0.0,
},