Installation

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

Installation steps

1

Download the resources

Download both prp-policeutils and prp-policeutils-assets from the CFX portal and place them in your resources folder.

2

Add to server.cfg

Add both resources to your server.cfg after all dependencies, with the assets resource before the main script.

ensure ox_lib
ensure prp-bridge
ensure prp-scanner-assets
ensure prp-scanner
ensure prp-policeutils-assets
ensure prp-policeutils

3

Add items

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

4

Configure modules

Open the shared/ config files: spikes_config.lua (jobs, weapons, items, length), gps_config.lua (progress bar, prop, items), flashbang_config.lua (durations, ranges, volumes), smokegrenade_config.lua (duration, size, visibility).

5

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 items listed below to your ox_inventory into data/items.lua.

-- Spike strips
["spikesbox"] = {
    label = "Spike Strip Box",
    weight = 2000,
    stack = false
},
["spikebox_pilot"] = {
    label = "Spike Strip Remote",
    weight = 200,
    stack = false
},
-- GPS trackers
["placeable_gps"] = {
    label = "GPS Tracker",
    weight = 100,
    stack = false
},
["shootable_gps"] = {
    label = "GPS Tracker (Shootable)",
    weight = 50,
    stack = true,
},

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.

['WEAPON_FLASHBANG'] = {
    label = 'Flashbang',
    weight = 400,
    throwable = true,
},

['WEAPON_GPSLAUNCHER'] = {
    label = 'GPS Launcher',
    weight = 3400,
},

['WEAPON_SMOK2GRENADE'] = {
    label = 'Smoke Grenade',
    weight = 400,
    throwable = true,
},

-- Optional
--['WEAPON_FREEZEGRENADE'] = {
--    label = 'Freeze Grenade',
--    weight = 400,
--    throwable = true,
--},
--
--['WEAPON_HELLGRENADE'] = {
--    label = 'Hell Grenade',
--    weight = 400,
--    throwable = true,
--},
--
--['WEAPON_FREEZESMOKE'] = {
--    label = 'Freeze Smoke',
--    weight = 400,
--    throwable = true,
--},
--
--['WEAPON_FIREWORKGRENADE'] = {
--    label = 'Firework Grenade',
--    weight = 400,
--    throwable = true,
--},

Optional grenade variants

The following additional weapon variants are also supported and can be added if needed: WEAPON_FREEZEGRENADE, WEAPON_HELLGRENADE, WEAPON_FREEZESMOKE, WEAPON_FIREWORKGRENADE.