Configuration

config/config.lua

Global Settings

boolean

default:"false"

Shows polyzones created in-game. Useful when testing shop interaction zones.

string

default:"en"

Locale file to use (e.g. 'en'). Matching locale files live under locales/.

string

default:"auto"

Framework adapter. Options: 'auto', 'qb', 'qbox', 'esx', or 'custom'. Custom requires editing stubs in opensource/client and opensource/server.

string

default:"new"

ESX version when using ESX. Options: "new" or "old".

string

default:"auto"

Inventory adapter. Options: "auto", "ox", "qb", "origen", "tgiann", "esx", "lj", "ps", "codem", or "custom".

string

default:"ox"

Notification system. Options: "ox", "qb", "esx", or "custom".

string

default:"ox"

Progress bar system. Options: "ox", "qb", or "custom".

string

default:"circle"

Ox progress bar style only. Options: "circle" or "bar".

table

Dispatch settings for suspicious sales. Resource can be 'auto' or a supported dispatch name; set to "other" / custom and edit opensource if unsupported.

Dispatch = {
    Resource = 'auto',
    Title = 'Suspicious Sale',
    Message = 'A Suspicious sale was made',
    Code = '10-69',
    Blip = {
        Text = 'Suspicious Sale',
        Color = 1,
        Sprite = 69,
        Scale = 0.8
    }
}

string

default:"auto"

Interaction system. Options: 'auto', 'ox_target', 'qb-target', 'drawtext', or 'worldinteract' (interact).

number

default:"38"

Key code for drawtext interactions. 38 is [E] by default.

string

default:"OX"

Drawtext UI style. Options: "OLDQB", "QB", or "OX".

string

default:"$"

Currency symbol shown in the sell menu UI.

string

default:"auto"

Path to inventory item images. "auto" detects common inventory image folders.

table

default:"{[\"police\"] = true}"

Jobs counted for PoliceCount checks and dispatch alerts.

PoliceJobs = {["police"] = true, ["fbi"] = true}

boolean

default:"false"

Enable XP awards on sell when items define an Exp field.

boolean

default:"false"

When true, XP is granted via the client AddExp event. When false, the server AddExp opensource hook runs (default pickle_xp).

table

Optional sell progress bar and animation.

ProgressbarConfig = {
    Enable = false,
    Duration = 2000,
    Text = 'Selling...',
    Animation = {
        Enable = true,
        NPCSync = true,
        Dict = 'mp_common',
        Anim = 'givetake1_b',
    }
}

boolean

default:"false"

When true, shop coordinates are read from config/sv_config.lua (Locations) instead of client config — useful to protect coords from dumpers.

table

Table of shop definitions keyed by shop id (e.g. 'pawnshop', 'suspiciousbuyer'). See structure below.

Shop Structure

Each entry in Config.Shops is a full shop. Concise example:

['myshop'] = {
    ["MenuTitle"] = 'My Shop',
    ["TargetIcon"] = 'fas fa-dollar-sign',
    ["TargetText"] = 'Sell Products',
    ["TargetSize"] = 1.5,
    ["TargetDistance"] = 1.0,
    ["OnlyShowItemsInInventory"] = false,

    ["Coords"] = vec4(412.15, 315.22, 102.13, 210.65),
    -- Or an array of vec4 for a random spawn location:
    -- ["Coords"] = { vec4(...), vec4(...) },

    ["Ped"] = {
        Enable = false,
        Model = `a_m_m_business_01`,
        -- IdleAnimation, SuccessfulAnimation, PedSuccessfulAnimation...
    },

    ["TimeFrame"] = {
        Enable = true,
        Time = {open = 9, close = 22},
    },

    ["PoliceCount"] = 0,

    ["Blip"] = {
        Enable = true,
        Text = "My Shop",
        Sprite = 605,
        Color = 0,
        Scale = 0.8,
    },

    ["Items"] = {
        ['goldbar'] = {
            Label = "Gold Bar",
            Price = 100,
            -- DispatchChance = 60,
            -- ["DisableMoney"] = false,
            -- ["DirtyMoney"] = { Enable = true, Item = "black_money", MetaData = false },
            -- ["ItemReward"] = { Enable = true, Item = "pawnshopcoin", Amount = 1 },
            -- ["Volume"] = { Enable = true, AmountUntilDropInPrice = 10, DropInPrice = 10 },
            -- ["Exp"] = 5,
        },
    },

    ["BulkSale"] = {
        Enable = false,
        BulkAmount = 10,
        ExtraCash = 10, -- % bonus cash when selling BulkAmount or more
    },
}

Field	Purpose
`MenuTitle` / target fields	Menu title, icon, text, size, distance; `OnlyShowItemsInInventory` filters the menu
`Coords`	Single `vec4` or array of `vec4` (one random location)
`Ped`	Optional NPC: model, idle/success animations (`AdvancedAnimation` uses a fixed give/take when enabled)
`TimeFrame`	Open/close hours; closed shops notify on interact
`PoliceCount`	Minimum police online to use the shop
`Blip`	Map blip settings
`Items`	Sellables: `Price`, optional `DirtyMoney`, `ItemReward`, `Volume`, `Exp`, `DispatchChance`, `DisableMoney`
`BulkSale`	Extra cash % when selling at least `BulkAmount` of an item

presets/

Use LoadPreset(name, data) in files under presets/ to add or overwrite shops in Config.Shops. The built-in "example" preset name is skipped by design — rename your preset when copying it.

config/sv_config.lua

When ServerCoords = true, define locations here:

Locations = {
    ['pawnshop'] = vec4(412.15, 315.22, 102.13, 210.65),
    ['suspiciousbuyer'] = {
        vec4(259.51, 2584.91, 43.95, 9.83),
        vec4(1915.52, 3735.22, 31.64, 206.85),
    },
}

config/logs.lua

Optional sale logging:

boolean

default:"false"

Enable or disable logging.

string

default:"discord"

Logging service: "discord", "fivemerr", "fivemanage", or "custom" (edit opensource server hooks).

string

default:""

Discord webhook URL or Fivemerr/Fivemanage API key.

Getting Started

Project X Bridge

Paid Resources

Free Resources

config/config.lua

Global Settings

Shop Structure

presets/

config/sv_config.lua

config/logs.lua