⚙️Configuration

Configuration guide of Gold Panning Script.

Config.lua

Config = {}

Config.Framework = "auto" -- Determines which framework to use: auto, esx, or qb
Config.Language = "en" -- en, de, fr, es, pt, it, nl, pl, sv, ar, jp, zh, he, fi
Config.Target = "auto" -- Target system: "auto", "ox_target", "qb-target", or false
Config.Tutorial = true -- this allows players to send a one-time informational message to understand the script
Config.waterTime = 7000 -- time to fill plate with water
Config.placeEverywhere = false -- if this is false, the player can only place the table around the river blip.

Config.Items = {
    table = "purify_table",
    pan = "gold_pan",
    gold_nugget = "gold_nugget"
}

Config.Time = 10000 -- this determines how many mili seconds it should shake
Config.Reward = { -- this process determines the gold piece that will give the minimum and maximun at the end of the process
    min = 1,
    max = 3
}

Config.Table = {
    model = "bkr_prop_weed_table_01b",
    time = 4000 -- the time it will take to install it on the ground (progressbar)
}

Config.Sell = { -- https://docs.fivem.net/docs/game-references/ped-models/
    coords = {
        vec4(1081.9049, -1985.6462, 29.8896, 45.7552),
        -- vec4(0, 0, 0, 0),
    },
    npc = "s_m_y_dockwork_01",
    price = 500, -- price a nugget gold
}

Config.Blips = {
    sell = {
        sprite = 605,
        scale = 0.7,
        color = 5,
        visible = true
    },
    river = {
        coords = {
            vec3(-1172.4408, 4372.1841, 6.2629),
            -- vec3(0, 0, 0)
        },
        sprite = 618,
        scale = 0.7,
        color = 5,
        visible = true
    }
}

Config.CustomNotify = true -- set to true to use custom notifications
Config.Functions = {
    ["helpNotify"] = function(message, icon)
        if Config.CustomNotify then
            -- custom help notify here
            lib.showTextUI(message, {
                position = "right-center",
                icon = icon,
                style = {
                    borderRadius = 1,
                    whiteSpace = 'pre-line'
                }
            })
        else
            AddTextEntry('stg', message)
            BeginTextCommandDisplayHelp('stg')
            EndTextCommandDisplayHelp(0, false, false, 2000)
        end
    end,
    ["hideHelpNotify"] = function()
        if Config.CustomNotify then
            -- custom hide help notify here
            lib.hideTextUI()
        else
            ClearAllHelpMessages()
        end
    end,
    ["notify"] = function(type, message)
        if Config.CustomNotify then
            -- custom notify here
            lib.notify({
                title = getMessage('success'),
                description = message,
                type = type,
                duration = 5000,
            })
        else
            local Framework, frameworkName = getFramework()
            if frameworkName == "esx" then
                Framework.ShowNotification(message)
            else
                Framework.Functions.Notify(message)
            end
        end
    end,
}