Configuration
What you can edit
Section titled “What you can edit”| Open (edit freely) | Protected by escrow |
|---|---|
config.lua |
The rest of the Lua code |
server/handlers.lua, client/handlers.lua |
|
sql/, the documentation |
|
locales/ (every text players read in game) |
|
html/ (interface: templates, styles, translations) |
At a glance
Section titled “At a glance”Everything is in config.lua, commented section by section:
| Section | What it controls |
|---|---|
Config.Command, OpenKey, AdminCommand, DefaultLang |
Opening the UI, default language |
Config.ServerFee, MinPrice, MaxPrice, BumpCost, Featured |
Economy and fees |
Config.MaxListingsPerPlayer, MaxImagesPerListing, BannedItems |
Listing limits and blocked items |
Config.DeliveryBuyerFee |
Extra paid for a non-preferred delivery mode |
Config.Auction, Config.Auctions |
Durations, increments, anti-snipe, blind/proxy/Dutch/reverse |
Config.Rarities, ItemRarities, Categories, ItemCategories |
Rarities, categories and manual overrides |
Config.Photo |
Photo hosting, quality and free camera |
Config.ItemIcons |
Where item icons come from |
Config.MeetupPoints, Config.Markers |
Pickup points and world markers |
Config.Gameplay |
Flash sales, bundles, NPC courier, insurance and robberies |
Config.SkillCheck |
The robbery minigame |
Config.InPersonTrade, Config.Barter |
Meetups and trades |
Config.Storefront, Refunds, Verified, Reports, Wishlist |
Social features |
Config.RateLimits, Cleanup |
Anti-spam and data cleanup |
Config.Discord, Config.Admin |
Logs and admin access |
Config.Notify, Config.OnDeliveryRobbed |
Your notifications and your police alert |
Every option is explained below.
Commands and access
Section titled “Commands and access”Config.Command = 'market'Config.OpenKey = 'F6'Config.AdminCommand = 'marketadmin'
This lets players open the marketplace with F6 or /market, and the admin panel with /marketadmin.
The admin panel requires the ACE permission marketplace.admin. If the
server’s admin group is group.admin, add this to server.cfg:
add_ace group.admin marketplace.admin allowDefault language
Section titled “Default language”Config.DefaultLang = 'en'
Each player’s language is stored in their profile and everything they read
follows it. Config.DefaultLang is used for players who have not chosen one
and for texts that are not for a single player (see section 24).
Economy
Section titled “Economy”Config.ServerFee = 0.05Config.MinPrice = 10Config.MaxPrice = 10000000Config.Featured.Cost = 5000Config.BumpCost = 500
The system applies a server fee, a minimum and maximum price, a cost to feature and a cost to bump.
Auctions
Section titled “Auctions”Config.Auction controls:
- Minimum and maximum duration.
- Minimum bid increment.
- Minimum percentage increment.
- Anti-snipe.
Limits and cleanup
Section titled “Limits and cleanup”Config.MaxListingsPerPlayerConfig.MaxImagesPerListingConfig.PageSizeConfig.RateLimitsConfig.Cleanup
These values set how many listings each player can have, how many images are allowed and the automatic data cleanup.
Shop name
Section titled “Shop name”Config.ShopName controls:
- Minimum length.
- Maximum length.
- Pattern of valid characters.
Avatar colours
Section titled “Avatar colours”Config.AvatarColors defines the palette available for the profile.
Blocked items
Section titled “Blocked items”Config.BannedItems prevents publishing disallowed items such as money or black money.
Inventory backend
Section titled “Inventory backend”Config.InventoryBackend = 'auto'
The system tries to detect the available backend.
Categories and rarities
Section titled “Categories and rarities”Categories
Section titled “Categories”Categories group items by type:
- weapons
- ammo
- food
- drinks
- substances
- vehicles
- tools
- materials
- electronics
- clothing
- other
Each category has:
labellabels.eslabels.enicon
Assigning each item to its category is automatic: on start the server
enumerates the ox_inventory catalogue (or ESX’s items table) and applies
name patterns (defined in server/categories.lua). The resulting map is sent
to the NUI when the UI opens.
Config.ItemCategories remains an optional override to force the category of
specific items whose name does not match any pattern, or to reassign items that
are miscategorised by default.
Rarities
Section titled “Rarities”Rarities define value tiers and a minimum price:
- common
- uncommon
- rare
- epic
- legendary
Each rarity has:
- colour
- minimum price
- label
labels.eslabels.en
This is used both for visual filters and for price restrictions.
Settings to change with care
Section titled “Settings to change with care”Config.ItemIcons.UrlPatterns: controls the visual image fallbacks.Config.DeliveryBuyerFee: changes the cost of each delivery mode.Config.Gameplay.NPCDelivery: affects the balance of NPC purchases.Config.InPersonTrade: governs the in-person trade experience.Config.RateLimits: prevents spam and abuse.Config.Cleanup: affects automatic maintenance.Config.Reports.Reasons: defines the valid report reasons.