Documentation

Setup

Install and configure Mugging.

#Download

Download Zyke's Mugging from your CFX portal under Granted Assets. If it is missing from your portal, see Lacking Entitlement.

#Dependencies

Install ox_lib, zyke_lib, and a target resource such as ox_target or qb-target. Configure the framework, inventory, and target in zyke_lib. See Dependencies.

#Resource

Place the resource in your server's resources folder as zyke_mugging. Keep the folder name as it is.

#Items

Mugging has no items of its own. The loot tables in shared/unlocked/loottables.lua hand out items such as cash, goldchain, diamond_ring, and joint. Every item in them must exist in your inventory, so remove or rename the ones your server does not have.

#Configuration

Edit shared/unlocked/config.lua. Review the police requirement, the cooldown, the chance that a victim fights back, and the notifications. Use the Config reference for the current defaults.

By default, at least one player with the police job must be online before anyone can be robbed. Set policeRequirement.requirement = 0 while testing. Set debug = false before going live.

#Start Order

Start the dependencies before Mugging:

cfg
ensure ox_lib
ensure ox_target
ensure zyke_lib
ensure zyke_mugging

Replace ox_target with your target resource if you use another one.

#Verify Gameplay

Aim a weapon at a local on foot and rob them through your target. Search them and check that you receive loot from the loot table.