Documentation

Setup

Install and configure Safe Crack.

#Dependencies

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

#Resource & Items

Place the resource in your server's resources folder as zyke_safecrack.

Copy the stethoscope definition from zyke_safecrack/extras/items/ox_inventory.txt into ox_inventory/data/items.lua, or from zyke_safecrack/extras/items/qb-core.txt into qb-core/shared/items.lua. No item image is included; add a stethoscope.png to your inventory's image folder.

The stethoscope is not sold or given anywhere by default. Add it to a shop or another source so players can obtain it.

To play without the stethoscope, set Config.Items.stethoscope = false. Then also set requireStethoscope = false on every tier, including the default vault tier. A tier that requires the stethoscope can never be started while the item is disabled.

#Configuration

Edit shared/config.lua. Review the command permission, the attempt limits, the relocker duration, and the safe tiers. Use the Config reference for current defaults, and Safe Tiers to add your own tiers.

Texts are in locales/. Reactions to started and finished attempts belong in server/hooks.lua. These files are unencrypted and safe to edit.

#Start Order

Start zyke_lib and its providers before Safe Crack, and Safe Crack before any resource that uses it:

cfg
ensure zyke_lib
ensure zyke_safecrack

#Verify Gameplay

Set Config.Settings.debug = true and restart the resource. As a player with Config.Settings.commandPermission, run /safecracktest store to open a practice dial in front of you. It opens nothing. See Cracking a Safe for the controls.

While the practice dial is open, run /safecode from the F8 console to print its combination to the server console.

Set debug back to false when you are done.

#Connect Your Safes

Safe Crack places no safes on its own. Start it from the resource that owns your safes. See Integrating With Other Resources.