Browse docs

Configuration

Find the Lua settings for language, the dealer, equipment, search areas, rewards, progression and administrator access.

Treasure Hunt is configured in the resource's config/ directory. Edit the existing entries, keep a backup and restart sky_treasurehunt after saving. It does not register an in-game configurator or a /jobconfig section.

Configuration files

Paths below are relative to the installed sky_treasurehunt folder.

FileSettings
config/config.luaMaster switch, locale, dealer, detector and shovel tiers, detector progression, general skills, terrain, controls and audio
config/server.luaPayment account, detector sale prices, dealer limits and admin permissions
config/loot.luaDetector reward pools, weights and find-tier requirements
config/hotzones.luaOptional detector polygons and their loot-profile selection
config/magnet.lua / config/magnet_server.luaMagnet equipment, casting, skills, inland/sea pools and sale prices
config/diving.lua / config/diving_server.luaScuba sets, clothing, air, recovery, skills, rewards and sale prices
config/trash.lua / config/trash_server.luaSupported bin models, interaction, search time, skills, rewards and sale prices
config/water.luaServer water boundaries for environmental validation
config/findprops.lua / config/diving_props.luaFind-model mappings and presentation
config/album.luaItem identities counted in the shared album
config/locales/en.lua / config/locales/de.luaPlayer-facing text and built-in item names
config/integration/admin.luaThe permission and optional admin-duty check

Language and enabled activities

Config.Locale = "en" is the default. Use "de" for German, or Sky.Config.locale to follow Sky Base. Choose the matching inventory template separately: changing the resource locale does not rename entries inside another inventory's catalogue.

Config.Enabled controls the resource's gameplay. Config.Shop.enabled, Config.Magnet.enabled, Config.Diving.enabled, Config.Trash.enabled, Config.Hotzones.enabled and Config.General.enabled control their respective systems. Detector settings live under Config.Search, Config.Terrain, Config.Gear and Config.SkillTree.

Dealer placement

The default dealer is near the Vespucci docks. Edit the existing locations list to move it or add another counter:

config/config.lua — Config.Shop.locations
locations = {
    { x = -758.66674, y = -1522.25369, z = 5.05, heading = 22.86561 },
},

The dealer spawns one metre below the configured z value; the default ground level is approximately 4.05. Check the NPC position on your map after moving it. model chooses the NPC, blip controls its map marker, and interactDistance and serverDistance control interaction and server validation. Keep the server distance large enough for the intended interaction.

The shop supports the configured Sky target provider and the proximity key. Changing Config.Keys sets default bindings; players may already have their own saved FiveM bindings.

Prices and equipment

Equipment prices and purchase requirements are in Config.Gear.detectors, .shovels, .magnets and .scuba. Higher tiers still need to be purchased after the matching skill is learned.

ServerConfig.Shop.Currency accepts money, cash or bank; use the account supported by your framework setup. Sell prices are owned by the server and extended by the method-specific *_server.lua files. General skills can modify the player's final purchase and sale prices.

Reward weights are relative weights among eligible finds, not fixed percentages. Tier requirements, terrain, water type, skills and discovery protection can change the final chance. Adjust rewards, sale prices and progression together, and try the resulting player journey before opening the server.

Search areas and custom maps

The default allowed routing bucket is 0, controlled by Config.Search.allowedBuckets. Explicitly add other buckets if your server uses them for these activities.

Detector searches use suitable ground across the map; hotzones are optional modifiers rather than the only searchable areas. Config.Terrain.excludedAreas can exclude circular areas. Water activities use config/water.lua; custom water maps need matching server boundaries as well as suitable in-game water and ground. Add custom bin model names to Config.Trash.models.

Administrator access

The default permission is sky_treasurehunt.admin. See Commands for access setup and the exact scope of the level and skill-reset commands.

If you enable ServerConfig.Admin.requireDuty, implement ServerConfig.IsAdminOnDuty for your admin system. Its supplied implementation returns false, so enabling the duty requirement without connecting that function denies in-game administration.