Documentation

Setup

Install and configure the angle grinder.

#Dependencies

Install zyke_lib and configure the framework and inventory providers there. The Hardware Supplier is used through ox_target or qb-target, and the motor sound needs Sounds. See Dependencies.

#Resource & Items

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

Copy the matching definitions from zyke_anglegrinder/extras/items/ox_inventory.txt into ox_inventory/data/items.lua, or from zyke_anglegrinder/extras/items/qb-core.txt into qb-core/shared/items.lua. The bundled definitions include anglegrinder, the three discs anglegrinder_disc, anglegrinder_disc_pro, and anglegrinder_disc_elite, their broken items anglegrinder_disc_broken, anglegrinder_disc_pro_broken, and anglegrinder_disc_elite_broken, and anglegrinder_battery.

Copy every icon from extras/items/images/256/ into the inventory's image directory, not only the ones named after items. The grinder's icon switches between them to show the fitted disc, a broken disc, or a missing battery. extras/items/images/256/artwork/ holds an optional stylized set with the same file names.

Keep anglegrinder and anglegrinder_battery non-stackable/unique. The grinder stores its fitted disc and battery in metadata, and each battery keeps its own charge.

Older versions used grinder and grinder_* item names. When upgrading, follow extras/items/README.md: replace the item definitions and icons, rename the items in your shops and other resources, and rename stored items in your database. On grinders, also rename the discItem and image metadata values from grinder to anglegrinder. The resource does not migrate stored items.

#Configuration

Edit shared/unlocked/config.lua. Review the item names, starter parts, disc tiers, the minigame, witnesses, keybinds, and the Hardware Supplier. Use the Config reference for current defaults.

Custom action restrictions belong in client/unlocked/can_checks.lua and server/unlocked/can_checks.lua. Enforce trusted restrictions on the server. Your own busy logic, such as handcuffs or carrying, goes in IsPlayerHandsBusy() in client/unlocked/can_checks.lua.

Connect your dispatch resource in OnIllegalGrind in server/unlocked/hooks.lua. For Discord logs, copy extras/webhooks/anglegrinder.lua to zyke_lib/webhooks/anglegrinder.lua and set a URL for each action you want logged.

#Start Order

Start your configured providers and their dependencies before the grinder:

cfg
ensure ox_target
ensure zyke_sounds
ensure zyke_lib
ensure zyke_anglegrinder

ox_target (or qb-target) and zyke_sounds are optional; leave out the ones you do not use. Start resources that integrate with the grinder, such as zyke_wheelclamp, after it.

The console warns on start about any configured item missing from your inventory.

#Verify Gameplay

Buy a grinder from the Hardware Supplier, or give yourself an anglegrinder, and use it. With the grinder out, run /grindexample to run an example grind in front of you; it needs the command ACE permission. Check the disc and battery percentages on the keybind panel afterwards.

To cut something real, approach a target from a supported resource, aim at its dot, and press E. See Using the Grinder.