Every setting in config.lua

The property list is in config.server-only.lua and has its own page. Everything else is in config.lua.

General

Setting Default What it does
Config.Debug false Extra logging, and the door setup commands (see Doors & keys).
Config.Webhook false A Discord webhook for purchases, transfers, lock changes, lockpicking and taxes.
Config.KeyItem "key" The key item. A property type or property can use its own with keyItem.
Config.OwnerNeedsKey true false lets an owner open their property without carrying a key.
Config.DoorSales true Buy unowned properties at the door. Turned off automatically when another script takes over sales.
Config.PromptDistance 2.0 How close (in metres) a player needs to be for the door and buy prompts.
Config.SyncDistance 30.0 Doors are kept in their right state inside this range.
Config.Prompts.Storage "INPUT_INTERACT_OPTION1" The key for Open Storage.
Config.MaxOwned { house = 1, ranch = 1 } How many of each type one character can own. Types not listed have no limit.
Config.DoorPrompt { business = true } Types that get a Lock / Unlock prompt at the door for anyone with access. Every other type uses the key item.
Config.Storage { house = true, ranch = true } Types whose storage tr-properties handles. Leave a type out if another script handles its storage.
Config.MasterJobs {} Jobs that can open every lockable property, e.g. { { name = "realtor" } }.

Property types

Defaults for every property of a type. A property can still override any of them.

Config.PropertyTypes = {
    house = { storagePrefix = "houseID_" },
    ranch = { storagePrefix = "ranchID_", keyItem = "key_ranch" },
}

Any property field works here, e.g. lockpick, storageLockpick or keyItem.

Blips

Config.Blips = {               -- default blip per type; types not listed get none
    house = { sprite = "blip_proc_home", label = "House" },
    ranch = { sprite = "blip_fence_building", label = "Ranch" },
}

Config.BlipModifiers = {       -- defaults for every blip
    forSale = "BLIP_MODIFIER_FOR_SALE", -- unowned and has a price
    owned = "BLIP_MODIFIER_LOCKED",     -- owned by someone else
    mine = false,                       -- yours, or you carry a key that fits
}

A blip is built from Config.BlipModifiers, then Config.Blips[type], then the property's own blip, each overriding the last. Without a label, the property's own label is used. Set false on any modifier to show none.

Taxes

Config.Taxes = {
    ChargeWeeklyTaxes = true,
    IntervalDays = 7,               -- days between collections
    GiveCharacterLienSales = true,  -- pay the old owner part of the price when a property is taken
    LienSalesPercentage = 0.80,
    TaxAmount = {                   -- per collection, by type; 0 or missing = no tax
        house = 200.0,
        ranch = 500.0,
        business = 0.0,
    },
}

Taxes are collected two minutes after the server starts, from every property that's due. If the owner can't pay, the property is released and goes back on the market, and (with GiveCharacterLienSales) the old owner is paid LienSalesPercentage of its price. Properties owned by a job aren't taxed.

The money itself is taken and paid by Config.Functions.ChargeTax and PayLienSale (below).

Locksmith

Config.Locksmith = {
    jobs = { { name = "blacksmith", minGrade = 2 } },
    cost = { { item = "iron" } },            -- per key copy or lock change
    locations = {                            -- use a key here to copy it
        ["valentineBlacksmith"] = vector3(-361.21, 802.66, 116.16),
    },
}

See Doors & keys for what a locksmith can do.

Lockpicking

Config.Lockpick = {
    item = "lockpick",      -- false turns lockpicking off
    distance = 1.5,         -- how close to the door
    timeout = 120,          -- seconds the minigame may take
    removeOnFail = true,    -- a failed attempt uses up the lockpick
    relockUnowned = 30,     -- minutes until a picked door on an unowned property locks again; false = until restart
    storage = true,         -- false: no storage can be picked; a { minigame settings } table: every storage uses those
    animLoop = { 0.21, 0.53 }, -- the part of the picking animation that loops (0 = start, 1 = end)
    minigame = {            -- jo.minigame.lockpick settings
        animPostFx = "OJDominoBlur",
    },
}

minigame takes anything jo_libs' lockpick minigame understands, e.g. pins. A door or storage can override it with its own lockpick.

Functions

The parts that depend on your inventory or bank live here, so you can change them without touching the script:

Function What it does
KeyLocks(src, item) Returns { [lockUid] = true } for every key of that item the player carries. The default reads VORP's inventory.
ChargeTax(charid, amount) Takes a tax from the character's bank. Returns true if it was paid.
PayLienSale(charid, amount) Pays a lien sale into the character's bank. Returns true if it was paid.

The defaults for ChargeTax and PayLienSale use a tr_bank table. Replace them for your banking script.