Configuration

metal detecting is set up in three files that ship open: config.lua (the Config table), logs.lua (Logs) and strings.lua (Strings). One setting lives elsewhere, the text prompt system, in client/functions.lua. Changes apply after restart lation_detecting.

The sections below follow config.lua from top to bottom. The defaults are the values it ships with.

Config.SetupCopy Anchor Link

The custom options do nothing until you add your code in client/functions.lua, which ships open.

Config.DetectingCopy Anchor Link

Who can detectCopy Anchor Link

The shopkeepers and blips for a job are set up as the player loads in, so a player given the job later sees them after they rejoin.

WhereCopy Anchor Link

As it ships:

soil_check = true,
soil_type = {
    [-1595148316] = true, -- Sand/beach
},
restricted_areas = {
    [1] = { coords = vec3(0, 0, 0), radius = 20 },
},
designated_areas = {
    enabled = false,
    areas = {
        [1] = { coords = vec3(0, 0, 0), radius = 50 },
    }
},

The ground is read just ahead of the player's feet, once a second. To find a ground's hash, turn on Config.Setup.debug, take a detector out on it and read Currently detecting on soil type: in F8, then add that number to soil_type. Only the player's ground is checked: a find can be placed anywhere within the detector's radius, off the sand too.

A blocked area refuses the detector when it is used and puts it away when a player walks in. Designated areas are checked once the detector is out: outside them it is put away with You cannot metal detect in this area. The server checks both again before it hands over a find.

While detectingCopy Anchor Link

The detector beeps only within 35 m of a find. How often is set by GetBeepTime in client/functions.lua: every 3.5 seconds from 30 to 35 m, then every 3, 2.5 and 2 seconds for each 5 m closer, then the meters times 150 ms under 15 m.

LevelsCopy Anchor Link

The script is built for five levels, one per detector: the shop has a row for each and the stats menu counts to 5. Change the numbers, not how many there are.

Config.ShopsCopy Anchor Link

Two shops with the same options, Config.Shops.detectors and Config.Shops.sellShop. Each shopkeeper appears when a player comes within 65 m.

The sell shop has two more:

items = {
    ['md_bottlecap'] = 5,
    -- ...
    ['md_presidentialwatch'] = 5000
},

Config.DetectorsCopy Anchor Link

One entry per detector, in level order: Config.Detectors[1] is the Beginner's Beacon, Config.Detectors[5] the Archaeo Ace.

math.random in cooldown runs once, as the script loads on each player's game, so a player keeps one search time per detector until they rejoin. A fixed number works the same way.

The detector names, descriptions, pictures and the Radius, Depth and Accuracy bars in the shop are in strings.lua under Strings.ContextMenu.detector_shop, as level1 to level5. The bars are descriptions only and don't change anything.

Loot tablesCopy Anchor Link

Each detector's loot lists the items it can find:

['md_goldring'] = { chance = 2, quantity = { min = 1, max = 1 }, addXP = 750 },

Every dig turns up one item from the table, in its quantity; there are no empty digs. Take an item out of a detector's table and that detector never finds it. To add a find of your own, add the item to your inventory and its picture, named after the item, to install/images/, list it in each detector's loot, and give it a price in Config.Shops.sellShop.items so it can be sold.

To check the odds before players do, turn on Config.Setup.debug and run /simulate <detector> <count> in game, such as /simulate 3 1000. It rolls that many finds on that detector's table and prints how many of each item came up in F8. Nothing is given.

The default tables, as weight and XP for each detector. The weights add up to 1,348, 1,589, 1,555, 1,440 and 1,505.

Config.ShovelCopy Anchor Link

If you move the shovel to the detector shop, keep both shops on the same account: the player's balance is checked against the sell shop's.

Config.AnimationsCopy Anchor Link

Text promptsCopy Anchor Link

The prompts (Searching.., Distance, E - Start Digging, Error and the shop's Shop) use the system named at the top of client/functions.lua, not one in config.lua:

-- Options: 'lation_ui', 'ox_lib', 'jg-textui', 'okokTextUI', 'qbcore' & 'custom'
local textui = 'ox_lib'

LogsCopy Anchor Link

logs.lua sets what is logged and where. Every log names the player and their identifier.

With Config.Setup.debug on and Fivemanage or Fivemerr picked, the debug lines are sent there too.

LanguageCopy Anchor Link

Every message, prompt, menu row, dialog and log line is in strings.lua. Edit it to reword or translate.

Lines with %s get a value put in their place, for example 'You have x%s and they sell for $%s each'. The notification title, Metal Detecting, is set in ShowNotification in client/functions.lua, and item names come from your inventory's labels.