Configuration Guide

All core setup lives in shared/config.lua.

Basic settings

The first values most owners change are:

  • Config.Debug

  • Config.AdminRole

  • Config.ItemRestrictions

  • Config.SellPercentage

  • Config.MaxSellPercentage

circle-exclamation

Shop definitions

Config.PawnShops controls config-based shops.

Each shop usually defines:

  • ped location and model

  • stash ID

  • blip settings

  • ownership settings

  • for-sale sign location

  • customer interaction location

  • employee computer location

  • garage locations

  • worker limits and default permissions

  • selected categories

  • optional special items

Pawn settings

Config.PawnSystem controls the global pawn flow.

Key values:

  • enabled

  • pawnPercentage

  • buybackPercentage

  • expiryHours

  • maxPawnsPerPlayer

  • maxPawnPercentage

The normal sell flow is separate from pawning.

Check:

  • Config.SellPercentage

  • Config.MaxSellPercentage

Shop levels

Shops gain XP over time.

Use Config.ShopLevels to define level names and XP thresholds.

Use Config.ComputerUpgradeLevel if you gate the upgraded computer behind progression.

Item categories

Config.ItemCategories defines what shops buy and what each item is worth.

Each category entry normally includes:

  • item name

  • base price

Example groups from the packaged docs include:

  • household items

  • jewellery

  • precious metals

Shop vehicles

Config.ShopVehicles controls fleet purchases.

Typical vehicle settings:

  • label

  • model

  • price

  • insurance cost

  • level requirement

  • max owned

  • starter vehicle flag

  • storage display values

Loyalty system

Config.CustomerLoyalty controls memberships and perks.

Important fields:

  • tiers

  • subscriptionIntervalDays

  • gracePeriodDays

  • autoRenew

  • loyaltyPoints

Common tier perks include:

  • sell bonus

  • pawn bonus

  • priority service

  • exclusive deals

  • free appraisals

Worker permissions

Use Config.DefaultWorkerPermissions for new hires.

The built-in permission groups cover:

  • basic shop access

  • management actions

  • log access

  • exports

  • supplier network

  • email access

  • vehicles

  • loyalty

If you want faster setup, use Config.PermissionPresets.

Last updated