Home/Documentation/Vitality Shredder
World interactions / 5.9.4

Vitality Shredder

Bring the industrial shredder online, configure inventory adapters and recipes, and manage persistent machines.

Requirements

The shredder supports several inventory resources through ShredderConfig.Inventory, including ox, QB, QS, CodeM, Core, PS, LJ, Origen and TGIANN. An inventory backend with persistent output storage is required for the default setup.

Interaction supports target resources such as ox_target and qb-target, with an in-resource fallback. Persistence uses FiveM KVP by default, or optional oxmysql for MySQL mode.

Installation

  1. Place vrp-scrap-shredder into server resources.
  2. Start the selected inventory and targeting resources first.
  3. Edit the readable config.lua for inventory selection, creator access, recipes, and persistence.
  4. Add the shredder to server.cfg and restart the server.
cfg
ensure vrp-scrap-shredder

No SQL import is required for the default KVP persistence mode. If selecting mysql, configure and start oxmysql; the resource can create shredder-owned tables.

Inventory and persistence

The default ShredderConfig.Inventory.mode = 'auto' detects the first started supported backend from its configured priority list. Set an exact resource name if you want to force a specific adapter.

config.lua
ShredderConfig.Inventory.mode = 'auto'
ShredderConfig.Persistence.mode = 'kvp'

The processed output is stored in the selected inventory's persistent machine stash. Output capacity, stash slots, weight limits, and collection-only behavior are adjustable.

Recipes and Creator

Define input/output inventory items in ShredderConfig.Recipes and confirm the item names exist in the chosen inventory. Configure machine categories using ShredderConfig.RecipeGroups.

config.lua example
ShredderConfig.Recipes = {
  {
    id = 'car_door',
    label = 'Scrap Car Door',
    inputItem = 'car_door',
    inputModel = 'prop_car_door_01',
    outputItem = 'metalscrap',
    outputModel = 'industrial_scrap_shredder_v28_chunk',
    outputMin = 2,
    outputMax = 4
  }
}

Creator access is controlled through ShredderConfig.CreatorAccess using txAdmin, QBOX, or ACE permissions. Authorized staff can open /shreddercreator to manage machines and recipes.

in-game commands
/shreddercreator
/spawnshredder
/deleteshredder
/toggleshredder

The spawn/delete/toggle helpers should be tested with your intended staff access rules before opening a public server.

Troubleshooting

  • Cannot process items: ensure both input and output item names exist in the active inventory and recipes are configured.
  • Inventory not detected: check startup order or set ShredderConfig.Inventory.mode explicitly.
  • Machines disappear after restart: review KVP/MySQL persistence mode and resource logs.
  • Cannot use Creator: check CreatorAccess mode and authorized txAdmin/QBOX/ACE groups.
  • Visual assets fail: replace the complete resource with its streamed models and check the FiveM console for model errors.

Still need assistance?

Include your resource version and any relevant console errors when asking for help.

Get support ↗All documentation