General

Details

General configuration used throughout the whole shops resource.

Configuration file

config/general.lua
return {
    --[[
         If true, the script will not check for updates on startup.
    ]] --
    ---@type boolean
    disableVersionCheck = false,

    --[[
         If true, debug zones gonna be shown.
    ]]
    ---@type boolean
    debug = false,

    --[[
       This defines categories labels and icons for them.
    ]] --
    ---@type Category[]
    categories = {
        ['food'] = { label = 'Food', icon = 'fas fa-utensils' },
        ['drink'] = { label = 'Drink', icon = 'fas fa-bottle-water' },
        ['alcohol'] = { label = 'Alcohol', icon = 'fas  fa-martini-glass'}
    },

    --[[
         Metadata fields to show in the item tooltip (in the UI).
    ]] --
    ---@type table<string, string>
    showMetadata = {
        foo = "Bazinga",
        crush = "Crushed",
    },

    --[[
        This defines default icon for item, if default icon is invalid or not set.
    ]] --
    ---@type string
    unknownImage = 'unknown.png',

    --[[
        If true, items will be blurred, instead of just graying out the unavailable ones.
    ]]
    ---@type boolean
    blurUnavailableItems = false,

    --[[
        This function will be called to calculate the price flactuation.
    ]] --
    ---@param itemName string
    ---@param price number
    ---@param type '"buy"' | '"sell"'
    ---@return number
    flactuation = function(itemName, price, type)
        --Do whatever calculation you want here.
        local min = 100
        local max = 120

        return math.ceil(
            price * (math.random(min, max) / 100)
        )
    end,

    --[[
        If true, players will be able to purchase items even if they are over their weight limit.
    ]]
    ---@type boolean
    allowOverweightPurchase = false,

    --[[
        This defines blip text formatting. For example, if you're using custom font,
        you can use something like this: `<FONT FACE = "Inter">%s</FONT>`.
        It makes it easier for you.
    ]]
    ---@type string
    blipText = '%s'
}