Documentation

Setup

Install and configure Wheel Clamp.

#Dependencies

Install oxmysql and zyke_lib, and configure the framework and inventory providers in zyke_lib. See Dependencies.

#Resource & Items

Place zyke_wheelclamp and zyke_wheelclamp_assets in your server's resources folder under those names. zyke_wheelclamp_assets streams the clamp props.

Copy the matching definitions from zyke_wheelclamp/extras/items/ox_inventory.txt or zyke_wheelclamp/extras/items/qb-core.txt into your configured inventory. They add clamp_triangle, clamp_claw, clamp_disc, clamp_windscreen, and clamp_key.

Copy every icon from extras/items/images/256/ into the inventory's image directory, including the _open, _cut, _released, and _smashed images that show how a picked-up clamp came off. extras/items/images/256/artwork/ holds alternative icons with the same names.

On ox_inventory, leave consume unset on the clamps and the key so the usable-item callback runs. Lockpicking uses the stock lockpick item, so no definition ships for it. The qb-core clamp_key is not usable; on QBCore, keys work through the "Remove wheelclamp" option on the clamp instead.

Item names must match Config.Settings.wheelclamp.clamps, keyItem, and lockpicking.items. If you rename an item, update the vendor entries too.

#Configuration

Edit shared/unlocked/config.lua. Review the jobs under jobRequirements and officer, the release fees under notice and windscreen, the society accounts that receive the fees, and the Police Supply ped under vendor. Use the Config reference for current defaults.

Optional resources are detected when started: Lockpick, zyke_anglegrinder 0.3.2 or newer, zyke_sounds 0.7.0 or newer, a supported phone, and zyke_laptop. See Dependencies.

Garages and qbx_garages keep clamps on stored vehicles on their own. For any other garage, follow Vehicle Properties.

For Discord logs, set a webhook URL in zyke_lib/webhooks/wheelclamp.lua for each action. Empty URLs are skipped.

Custom action restrictions belong in client/unlocked/can_checks.lua and server/unlocked/can_checks.lua. Enforce trusted restrictions on the server. See Can-Check Hooks.

#Start Order

Start your configured providers and their dependencies before Wheel Clamp:

cfg
ensure oxmysql
ensure zyke_lib
ensure zyke_wheelclamp_assets
ensure zyke_wheelclamp

The zyke_wheelclamp_clamps database table is created on first start.

With interaction = "target", start ox_target or qb-target before Wheel Clamp as well.

Avoid restarting zyke_wheelclamp_assets while clamps are out, as it can crash clients that still show the props. Restarting zyke_wheelclamp itself is safe.

#Verify Gameplay

Take a clamp from the Police Supply ped at Mission Row as on-duty police, use it on foot and fit it to a parked car. Check that you receive a clamp_key, that the clamped wheel holds the car in place, and that "Read clamp notice" shows the fee. Then use the key, or the "Remove wheelclamp" option, to take the clamp off and check that it returns to your inventory.