Installation

Download

Purchase with your own Cfx / Keymaster account. Download from Keymaster. You can transfer the grant to another account from Keymaster if needed.

Escrow errors: FiveM/RedM Asset Escrow.

Keep the resource folder named gs_metaldetect (or gs_metaldetect-project). ensure below uses gs_metaldetect.

Dependencies (required)

No MySQL. Dig sites live in memory and respawn from Config.Sites.

Optional

Start ox_inventory before gs_metaldetect if you use it. Inventory is detected automatically. See Integrations.

Asset order

Start after ox_lib, your framework, and your inventory:

ensure ox_lib
ensure ox_inventory   # skip if you do not use it
ensure qb-core        # or qbx_core / es_extended
ensure gs_metaldetect

Items

Paste the detector and battery defs from items/items.lua (or import items/esx.sql on ESX default inventory). Skip battery if you already have that item. Names must match Config.Detectors and Config.Battery.

Full paste blocks: Items.

Framework and inventory

-- Detects qb-core → qbx_core → es_extended
Config.Framework = "auto"

-- Detects ox_inventory when started, otherwise the framework inventory
Config.Inventory = "auto"

Config.Locale = 'en'

For "custom", fill the hooks in client/edit.lua and server/edit.lua.

Quick config checklist

Config.Debug = false
Config.Framework = "auto"
Config.Inventory = "auto"
Config.Locale = 'en'
Config.Battery.item = 'battery'
-- Config.Detectors[].item must match your inventory spawn names

Next

• Using the detector
• Items
• Advanced configuration