Installation

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

Installation steps

1

Download the resources

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

2

Add to server.cfg

Add both resources to your server.cfg. prp-atmrob-assets must be ensured before prp-atmrob.

ensure ox_lib
ensure prp-bridge
ensure prp-atmrob-assets
ensure prp-minigames
ensure prp-atmrob

3

Add items

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

4

Configure sh_config.lua

Open config/sh_config.lua to set the supported ATM models and item names.

5

Configure sv_config.lua

Open config/sv_config.lua to configure cooldowns, loot tables, police requirements, alerts and per-method options.

6

Configure cl_config.lua

Open config/cl_config.lua to configure the vehicle blacklist and the rope pull multiplier.

7

Optional: webhook

Set Config.LogWebhookurl in config/sv_config.lua to log robbery events to Discord.

8

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.

["atm_hack_device"] = {
    label = "Hacking Device",
    weight = 100,
    stack = false,
    metadata = {
        durability = 100,
    },
},
["atm_bomb"] = {
    label = "Small Explosive",
    weight = 200,
    stack = false,
},
["metal_rope"] = {
    label = "Metal Rope",
    weight = 500,
    stack = false,
},

TIP

The atm_hack_device uses a durability metadata field. Make sure your inventory resource supports item metadata if you want durability tracking to work correctly.

WARNING

prp-atmrob-assets streams the custom ATM prop models (prop_fleeca_atm, prop_atm_02, prop_atm_03, prop_fleeca_atm_boom). If it is not started before prp-atmrob, the custom models will not load and the script will not function correctly.