Installation

Installation

Requirements

• QBCore or Qbox framework
• ox_lib — UI and utilities
• ox_inventory — item management
• ox_target — interaction zones (or qb-target)
• xsound — 3D positional audio (optional — can be disabled in config)

Step 1 — Upload the resource

Place the rm-recycling folder into your server's resources directory:

resources/
  [rm-scripts]/
    rm-recycling/

Step 2 — Add to server.cfg

ensure ox_lib
ensure ox_inventory
ensure ox_target
ensure qbx_core   # or qb-core for QBCore
ensure xsound
ensure rm-recycling

Make sure rm-recycling is started after all dependencies.

Step 3 — Configure

Open config.lua and set:

• Framework & inventory — Config.Framework ('qbox' or 'qbcore'), Config.Target ('ox_target' or 'qb-target')
• Recycler locations — prop-based or coords-only locations with optional blips
• Recycling recipes — input items, processing time, and output items per slot
• Sound settings — hosted MP3 URL, volume, and distance

Open sv_config.lua and set:

• Discord webhooks — separate URLs for input logs, recycled logs, claimed logs, and session summaries
• Server name — shown in Discord embed footers

See Configuration for the full reference.

Step 4 — Add items to ox_inventory

Every item used in your recipes must exist in ox_inventory/data/items.lua:

['metalscrap'] = { label = 'Metal Scrap', weight = 300 },
['plastic']    = { label = 'Plastic',     weight = 100 },
['aluminum']   = { label = 'Aluminum',    weight = 400 },

Step 5 — Stream prop models

If using prop-based recyclers, the models bzzz_prop_recycler_a and bzzz_prop_recycler_b must be streamed on your server. If you don't want to use props, use the coords-only recycler type instead.

Step 6 — Restart your server

Perform a full server restart. The recycler prop and map blip (if enabled) should appear at each configured location.

Troubleshooting

Config file reference