shared/config.lua

Edit options in shared/config.lua. Framework, inventory, notify, job, and skill bridges live in client/edit.lua and server/edit.lua. Do not put that logic in this file.

Restart gs_metaldetect after you change config. Item spawn names here must match Items. Player loop: Using the detector.

Debug, framework, locale, inventory

Config.Debug = false
Config.Framework = "auto"   -- qbcore | qbox | esx | custom
Config.Locale = 'en'        -- en | es | pt | de | fr | pl
Config.Inventory = "auto"   -- ox_inventory | custom

Sites

The server builds a pool of buried targets at start, then slowly replaces collected ones.

Config.Sites = {
    total = 100,
    maxTargetsRange = 120.0,
    respawnIntervalMs = 15 * 60 * 1000,
    respawnBatch = 4,
    maxActive = 120,
}

There is no database. All sites are in memory and reset on resource restart.

Hotspot blips

Optional map markers for type = 'hotspot' zones only. General zones never get a blip.

Config.HotspotBlips = {
    enabled = true,
    requireDetector = true,
    sprite = 485,
    color = 46,
    scale = 0.65,
    shortRange = true,
    showRadius = true,
    radiusAlpha = 80,
}

Battery

Charge is stored on the detector item (metadata.charge on ox_inventory, info.charge on QBCore). Using a battery while a detector is equipped writes a new charge and consumes one battery.

Config.Battery = {
    item = 'battery',
    installCharge = 100,
    drainIntervalMs = 12000,
}

A dead detector still equips. The LCD shows NO PWR and digging is blocked until a battery is installed.

Detectors

Each row is one usable item. Use the item to equip or put away. Add more rows if you want extra tiers.

Config.Detectors = {
    {
        item = 'metaldetector',
        label = 'Basic Detector',
        rangeMultiplier = 1.0,
        digRadius = 2.5,
        drainPerTick = 3.0,
    },
}

Bundled defaults: Basic 1.0 / 3.0 drain, Advanced 1.25 / 2.0, Pro 1.5 / 1.0.

Prop

World model in the player's hand while scanning. The ytyp is requested from stream/. If the model is missing, the client shows error.model_missing.

Config.Prop = {
    model = `w_am_metaldetect`,
    bone = 18905,
    offset = vector3(0.15, 0.1, 0.0),
    rotation = vector3(270.0, 90.0, 80.0),
    animDict = 'mini@golfai',
    animClip = 'wood_idle_a',
    animFlag = 49,
}

Scan

Signal bars, facing, keys, and dig timing.

Config.Scan = {
    bars = {
        { dist = 100.0, bars = 0, wait = 9000 },
        { dist = 80.0, bars = 1, wait = 7500 },
        -- closer rows...
        { dist = 0.0, bars = 10, wait = 400 },
    },
    facingDegrees = 25.0,
    digControl = 38,
    stopControl = 75,
    audioControl = 140,
    digRadius = 2.5,
    digCooldownMs = 2500,
}

bars: keep rows sorted far to near. The client walks the list and uses the first row where current distance is greater than dist. bars is LCD fill (0 to 10). wait is milliseconds between beeps. Closer sites beep faster.

Effective distance is realDistance * zone.difficulty / detector.rangeMultiplier. A hotspot at difficulty = 1.0 with a Pro detector (1.5) feels closer than a difficulty = 1.35 inland zone with a Basic detector.

These are control indexes, not ox_lib keybinds. Players rebind them in GTA Settings.

Loot

When a player digs, the server picks a pool, then a drop inside that pool.

Config.Loot = {
    bands = {
        common = 72,
        uncommon = 22,
        valuable = 6,
        hotspotValuableBonus = 3,
    },
    common = {
        { 'metalscrap', {12, 22}, 32, 'SCRAP' },
    },
    uncommon = { -- ...
    },
    valuable = { -- ...
    },
}

bands are relative odds, not percents. Default 72 + 22 + 6 = 100, so common is 72% inland. In a type = 'hotspot' zone, hotspotValuableBonus is added to the valuable weight (6 + 3 here). Skill lootWeightMultipliers can scale any of those four keys (see server/edit.lua).

Each drop can be a list or a table:

{ 'metalscrap', {12, 22}, 32, 'SCRAP' }
-- item, count (number or {min, max}), weight inside this pool, LCD reading

{ item = 'rolex', count = 1, weight = 8, reading = 'GOLD' }

Loot items are not in items/items.lua. Only detectors and battery are. If CanCarryItem fails, the dig is rejected and the site stays.

Zones

Sites spawn inside these circles. Add, remove, or move rows to fit your map.

{ name = 'vespucci_beach', type = 'hotspot', coords = vector3(-1433.52, -1323.54, 3.55), radius = 95.0, weight = 14, difficulty = 1.0 },

Related: Integrations for job gates and skill scaling.