Installation

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

Installation steps

1

Download the resources

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

2

Add to server.cfg

Add the resources to your server.cfg.

ensure oxmysql
ensure ox_lib
ensure prp-bridge
ensure prp-pettycrime-assets
ensure prp-pettycrime

prp-pettycrime-assets must be started before prp-pettycrime.

3

Add items

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

4

Database

Import package spawn locations — see Database below.

5

Webhook

Set SvConfig.LogWebhook to your Discord webhook URL in config/server.lua.

6

Configure economy

Adjust loot tables, cooldowns, and minigame options to fit your server's economy.

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.

WARNING

prp-pettycrime-assets must be started before prp-pettycrime. It streams all custom animations (pickpocket, mailbox steal, post box lockpick, envelope open, glitterbomb, package pickup) and custom package props (pr_pettybox_01–05).

Database

The porch_pirate_locations table is created automatically on resource start via oxmysql.

Default package spawn locations are seeded automatically on first start if the table is empty (defaultLocations.insert = true in config/server.lua). No manual SQL import is required.

To manage spawn locations in-game after first start, use the /ppadmin command.

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.

-- Mail items
['envelope'] = {
    label = 'Envelope',
    weight = 10,
},
['catalog_envelope'] = {
    label = 'Catalog Envelope',
    weight = 20,
},
['letter'] = {
    label = 'Letter',
    weight = 5,
},

-- Porch Pirate packages
['pp_small_1'] = {
    label = 'Small Package',
    weight = 500,
    stack = false,
},
['pp_small_2'] = {
    label = 'Small Package',
    weight = 500,
    stack = false,
},
['pp_small_3'] = {
    label = 'Small Package',
    weight = 500,
    stack = false,
},
['pp_medium_1'] = {
    label = 'Medium Package',
    weight = 1000,
    stack = false,
},
['pp_large_1'] = {
    label = 'Large Package',
    weight = 2000,
    stack = false,
},

-- Misc
["lockpick"] = {
    label = "Lockpick",
    weight = 300
},

INFO

Package item names follow the pattern {packageItemPrefix}_{lootTableName}_{itemSubfix}. With the default prefix pp, the items are pp_small_1, pp_small_2, pp_small_3, pp_medium_1, and pp_large_1. If you change packageItemPrefix in config/server.lua, update your item names accordingly.

INFO

The lockpick item is used for letter boxes and post boxes but is not defined in this resource - it is expected to already exist in your inventory from another resource or your base setup.

Admin Commands

Command	Permission	Description
/ppadmin	group.admin	Opens the Porch Pirate admin menu to manage package spawn locations
/bhadmin	group.admin	Opens the Blackhat NPC admin menu to view and change their current location