Configuration
aty_housing: Configuration
Overview · Installation · Configuration · Features and commands · Living · Home security · Economy, upgrades and the player market · Furniture, lighting and yards · Apartments, buildings and motels · Exports and events · Webhooks and migration · Troubleshooting
Configuration
Everything is set in shared/config.lua, with two exceptions: light colours (Config.Colours) are in shared/config_colours.lua and yards (Config.Exterior) are in shared/config_exterior.lua. The files are read when the resource starts: restart aty_housing after every change. Unless a row says otherwise, money amounts are whole numbers, distances are metres, stash weights are grams (200000 = 200 kg) and durations say their unit in the option name or description.
The options of these three features are listed with the feature, in the same table style:
- Lighting and colours:
Config.Coloursinshared/config_colours.lua. - Garden and exterior decor:
Config.Exteriorinshared/config_exterior.lua. - Apartments, buildings and motels:
Config.Buildingsat the end ofshared/config.lua.
Core
| Option | Type | Default | Description |
|---|---|---|---|
Config.Debug |
boolean | false |
Prints debug and ready messages to the server console |
Config.Language |
string | 'en' |
Language of in-game texts and the tablet: 'en', 'tr', 'de', 'fr', 'es' or 'pt-br'. Keys missing in a language fall back to English. The furniture catalog also shows Turkish names when this is 'tr'; in the other languages it shows the English names |
Config.Command |
string | 'housing' |
Chat command that opens the housing tablet |
Config.AdminCommand |
string | 'housingadmin' |
Chat command that opens the property creator. /<command> starts a new property, /<command> <id> edits an existing one. The server checks the admin permission first |
Config.AdminPermission |
table | { qb = { 'admin', 'god' }, esx = { 'admin', 'superadmin' } } |
Framework admin permission, checked first: qb-core permission levels and ESX groups. A player holding any listed level or group is a housing admin. {} skips the framework check on that framework |
Config.AdminAce |
string | 'aty_housing.admin' |
ACE permission, the last-resort admin check. It is also checked when the framework says no. Admins create, edit and delete properties and use the Admin tab |
Config.FocusCommand |
string | 'housingfocus' |
Emergency command that releases mouse and keyboard focus if the panel ever gets stuck on screen |
Config.ExitCommand |
string | 'housingexit' |
Emergency command that leaves the property you are in, for when the exit target inside does not show up. The server still checks that you are inside |
Config.FallbackSpawn |
table | { x = -1035.71, y = -2731.87, z = 12.86, w = 0.0 } |
Where a player is put after logging in when the property they were inside was deleted and no entrance was saved with their stay. Default: the QBCore default spawn (airport) |
Config.BucketBase |
number | 200000 |
Routing bucket of an IPL or shell property = BucketBase + property id. Keep it clear of the ranges other scripts use |
Config.AdminBucketBase |
number | 100000 |
While an admin captures inside points they are alone in routing bucket AdminBucketBase + server id. Keep this range (up to +65535) clear of BucketBase and of other scripts' buckets |
Config.ShellSpawn |
table | { x = -3500.0, y = -3500.0, z = 900.0 } |
Where shell interiors are spawned (only on the entering player's screen, inside the property's own bucket). Pick a spot far from map geometry. Not verified in game: change it if a shell clips into anything |
Config.InteriorPointRadius |
number | 40.0 |
Inside points (spawn, exit, stash) of IPL and shell properties must lie within this many metres of the interior (the catalog spawn for an IPL, the shell origin for a shell). The server refuses points outside with point_outside_interior |
Config.RateLimitMs |
number | 500 |
Minimum time (ms) between two requests of the same kind from one player |
Config.DefaultStash |
table | { slots = 50, weight = 200000 } |
Stash size a new property starts with. The creator can change it per property |
Config.Garage.capacity |
number | 10 |
Vehicles per property garage, as offered to garage scripts through GetGarages() |
Config.Garage.requireGaragePoint |
boolean | true |
true = only properties with a garage point set in the creator get a garage. false = every owned or rented property gets one, at its entrance when no garage point is set |
Markers and interaction
| Option | Type | Default | Description |
|---|---|---|---|
Config.InteractMode |
string | 'both' |
How players use property points (entrance, inside exit, stash): 'target' = target eye only (ox_target, qb-target, aty_interactions), 'marker' = walk onto the marker and press E, 'both'. An unknown value counts as 'both' |
Config.InteractDistance |
number | 5.0 |
Maximum distance between the player and a property entrance for the server to accept an action. The server reads positions with a small delay, so keep it a little larger than the target interaction distance |
Config.Markers.enabled |
boolean | true |
false = no markers and no prompts |
Config.Markers.drawDistance |
number | 25.0 |
Pins and rings show within this many metres |
Config.Markers.labelDistance |
number | 8.0 |
The name and status show within this many metres |
Config.Markers.interactDistance |
number | 2.0 |
E works within this many metres ('marker' and 'both'). Kept below Config.InteractDistance |
Config.Markers.ground |
boolean | true |
false = no ring on the floor (the floating prompts stay) |
Config.Markers.pulse |
boolean | true |
false = the ring does not breathe (slow size and alpha pulse) |
Config.Markers.type |
number | 25 |
GTA marker type of the ring; 25 is a thin flat ring |
Config.Markers.size |
table | { x = 1.1, y = 1.1, z = 1.1 } |
Marker size |
Config.Markers.colors |
table | see right | { red, green, blue, alpha } per state: market { 53, 217, 121, 110 } (nobody owns it, for sale or rent), mine { 105, 255, 236, 110 } (you own it, rent it or hold a key), other { 200, 200, 200, 80 }, locked { 255, 78, 78, 110 } (owned by someone else and locked), point { 105, 255, 236, 110 } (inside exit and stash). The ring uses all four values, the prompt uses red, green and blue |
Config.ShowForSaleBlips |
boolean | true |
Show unowned properties that are for sale or rent on the map |
Config.Blips.owned |
table | { sprite = 40, color = 2, scale = 0.8 } |
Blip of properties you own, rent or hold a key to. scale is optional |
Config.Blips.forSale |
table | { sprite = 40, color = 3, scale = 0.65 } |
Blip of unowned properties on the market |
At a marker, press E. A second action key (default G, rebindable under Key Bindings > FiveM) is offered at entrances that have one, for example ringing the doorbell.
Creator
Config.Creator controls the property wizard (/housingadmin and New listing in the tablet).
| Option | Type | Default | Description |
|---|---|---|---|
minEntranceDistance |
number | 2.0 |
Metres a property entrance must keep from every other property's entrance (0 = off) |
maxGarageDistance |
number | 80.0 |
A garage point farther than this from the entrance is a warning in the summary (0 = off) |
doorMatchDistance |
number | 0.5 |
Two MLO door captures of the same model closer than this are the same door (a door already used by another property is an error) |
maxDoorDistance |
number | 50.0 |
An MLO door farther than this from the entrance is an error, for admins too (0 = off) |
tags |
table | garden, pool, view, elevator, furnished, balcony, rooftop, fireplace, basement, security, beach, workshop |
Listing features the creator offers (tablet texts feat_<id>) |
maxTags |
number | 8 |
Tags per property |
garageSlotsMax |
number | 50 |
Highest garage capacity per property (0 in the creator = Config.Garage.capacity). Realtors stay at or below Config.Garage.capacity |
previewSeconds |
number | 120 |
Interior preview and inside-point visit length (0 = until Backspace). The server ends any visit after max(previewSeconds, 120) + 60 seconds, at most 15 minutes |
teleport |
boolean | true |
Admins may jump to captured points |
realtorTier |
boolean | false |
Realtors may change the property tier (bills and robbery follow the tier) |
realtorMlo |
boolean | false |
Realtors may create MLO properties and change MLO doors (MLO doors join the game's door system and lock) |
drafts |
table | { enabled = true, max = 5, keepDays = 30, maxBytes = 16000 } |
Server-side drafts: maximum per character, days before they are removed, size limit per draft |
Ready-made properties (Config.SeedProperties)
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | true |
Create the properties of files on the first start. false = never (properties already created stay) |
files |
table | { 'data/seed/vinewood_hills_lux.json' } |
JSON files inside the resource, in the housingbulkcreate format. Each file runs once per "version"; see Ready-made properties |
Economy and rent
| Option | Type | Default | Description |
|---|---|---|---|
Config.MoneyAccount |
string | 'bank' |
Account used for purchases and rent: 'cash' or 'bank' |
Config.SellBackRatio |
number | 0.7 |
Share of the price the owner paid that is given back when they sell the property back to the market (0.0 to 1.0) |
Config.RentPeriodDays |
number | 7 |
Length of one rent period in days. A property's rent price is charged per period. Decimals work (0.5 = 12 hours) |
Config.RentGraceDays |
number | 2 |
Days a tenant may stay after the rent is due before the property is taken back. Rent is never charged while the tenant is offline (autopay, when enabled under Config.Finance, runs only while they are online) |
Config.RentMaxPrepaidPeriods |
number | 4 |
How many periods a tenant can pay ahead, counted from now. A tenant who is behind pays every missed period at once. Time the server is offline does not count against tenants |
Config.RentCheckMinutes |
number | 10 |
How often (minutes) the server looks for rentals past their grace period |
Config.EvictionClearStash |
boolean | false |
Empty the stash (and the storage furniture stashes) when a tenant is evicted for unpaid rent. aty_inventory only; with other inventories the items stay and a console line prints each stash id. Selling or ending a rental never empties a stash |
Config.Lifecycle.furnitureOnLeave |
string | 'keep' |
What happens to furniture when a property is sold back or a rental ends: 'keep' (it stays for the next owner, no refund) or 'refund' (every piece is removed and the leaver gets Config.Decor.refundRatio of what it cost). Storage furniture stashes always start empty for the next owner; the old ones keep their items under their old ids (printed to the console) |
Config.Lifecycle.clearStashesOnDelete |
boolean | false |
When an admin deletes a property, empty its stash and its storage furniture stashes (aty_inventory only; otherwise their ids are printed for recovery) |
Finance
Loans, bills, property tax, resale lock, player transfers, bank-owned listings, rent deposit and rent-to-own. The server computes every price, plan, fee and schedule; the tablet only previews them.
| Option | Type | Default | Description |
|---|---|---|---|
Config.ResaleLockDays |
number | 30 |
Days after buying (cash, loan, transfer or rent-to-own) during which a property cannot be sold back or transferred. 0 = no lock (the tablet hides the note) |
Config.Finance.enabled |
boolean | true |
false = no loans, bills or transfers (rent keeps working). On a server without finance set this to false; while enabled but not yet loaded, buying, renting and selling answer not_ready |
Config.Finance.account |
string | 'bank' |
Account new owners pay from by default ('bank' or 'cash'). Each owner can change it in the tablet, Finance tab |
Config.Finance.autopayDefault |
boolean | true |
New owners and tenants start with autopay on |
Config.Finance.checkMinutes |
number | 5 |
How often installments, rent autopay and bills are processed |
Config.Finance.loginDelaySeconds |
number | 20 |
After a character loads, wait this long before collecting what built up while they were offline |
Config.Finance.historyMax |
number | 200 |
Payment rows (receipts) kept per property |
Config.Finance.loan.enabled |
boolean | true |
Offer loans |
Config.Finance.loan.minDownPct / maxDownPct |
number | 20 / 90 |
Down payment range, in percent of the price |
Config.Finance.loan.ratePct |
number | 1.5 |
Interest per period (1.5 = 1.5 % per week with periodDays = 7; maximum 25) |
Config.Finance.loan.terms |
table | { 8, 12, 24, 52 } |
Installment counts a buyer can pick |
Config.Finance.loan.periodDays |
number | 7 |
Days between installments (decimals work for testing) |
Config.Finance.loan.maxLoans |
number | 2 |
Open loans one character can have |
Config.Finance.loan.maxPrice |
number | 0 |
Loans only for properties up to this price (0 = any) |
Config.Finance.loan.graceHours |
number | 24 |
Hours after a due date before the installment counts as missed |
Config.Finance.loan.repossessAfterMissed |
number | 3 |
Missed installments that take the property back |
Config.Finance.loan.warnAtMissed |
table | { 1, 2 } |
Missed counts that send a warning notification |
Config.Finance.loan.lateFeePct |
number | 5 |
Fee per missed installment, percent of that installment |
Config.Finance.loan.maxPrepaid |
number | 4 |
Installments that can be paid ahead of schedule |
Config.Finance.loan.creditCheck |
boolean | true |
Refuse a new loan while another loan of the character is behind |
Config.Finance.repossession.clearStash |
boolean | false |
Empty the stash when the bank takes a property back (aty_inventory only; otherwise the items stay under the old stash id, printed to the console) |
Config.Finance.repossession.furniture |
string | 'keep' |
'keep' (the next owner gets it) or 'clear' |
Config.Finance.repossession.bankDiscountPct |
number | 20 |
The property is listed as bank-owned this much cheaper |
Config.Finance.repossession.bankListingDays |
number | 14 |
Days the discount lasts (0 = until someone buys it) |
Config.Finance.bills.enabled |
boolean | true |
Issue bills and property tax |
Config.Finance.bills.periodDays |
number | 7 |
Bills are issued to the owner or tenant every this many days |
Config.Finance.bills.dueDays |
number | 3 |
Days to pay a bill |
Config.Finance.bills.taxPct |
number | 0.25 |
Property tax per period, percent of the property value (what the owner paid, else the sale price). Owners only |
Config.Finance.bills.utilities |
table | tier 1 { power = 150, water = 60, service = 0 }, tier 2 { power = 300, water = 120, service = 250 }, tier 3 { power = 600, water = 240, service = 750 } |
Power, water and service amounts per property tier (1 low, 2 mid, 3 high) |
Config.Finance.bills.tenant |
table | { power = true, water = true } |
Bill kinds a tenant pays (tax = true would bill tenants too) |
Config.Finance.bills.lienAfterOverdue |
number | 0 |
An owned property is taken after this many overdue tax bills (0 = never) |
Config.Finance.bills.keepPaidDays |
number | 30 |
Paid bills stay in the list this many days |
Config.Finance.rent.autopayLeadHours |
number | 12 |
Autopay pays the next rent period this many hours before it runs out |
Config.Finance.rent.depositPeriods |
number | 1 |
Deposit = rent x this many periods, taken when the rental starts and refunded when the tenant ends it (0 = none) |
Config.Finance.rent.rentToOwn |
table | { enabled = true, creditPct = 25 } |
A tenant can buy the rented property; creditPct percent of the rent they paid (and their deposit) is taken off the sale price |
Config.Finance.transfer.enabled |
boolean | true |
Player-to-player transfers (tablet: My properties > Sell / transfer) |
Config.Finance.transfer.feePct |
number | 2 |
Fee taken from the price, paid by the seller |
Config.Finance.transfer.timeoutSeconds |
number | 90 |
Time the buyer has to accept |
Config.Finance.transfer.distance |
number | 5.0 |
Buyer and seller must stand this close |
Config.Finance.transfer.maxPrice |
number | 1000000000 |
Highest price an offer can ask |
Config.Finance.transfer.loanPolicy |
string | 'settle' |
What happens to an open loan: 'settle' (paid from the price at the handover), 'payoff' (must be paid off first) or 'assume' (the buyer takes it over) |
Config.Finance.transfer.furnitureRefundRatio |
number or nil | nil |
Share of the paid price returned for furniture the seller removes. nil = Config.Decor.refundRatio |
Keys and roles
| Option | Type | Default | Description |
|---|---|---|---|
Config.MaxKeys |
number | 5 |
Most keys one property can have (the owner or tenant is not counted) |
Config.KeyGiveDistance |
number | 3.0 |
Maximum distance between the owner or tenant and the player who receives a key. Checked on the server |
Config.RolePresets |
table | coowner = enter, lock, stash, decor, exterior, manageKeys, garage, payBills, security; tenant = enter, lock, stash, garage, payBills; guest = enter, stash, garage |
Default permissions per key role. Used when a key is given without a permission set (the tablet always sends one) and for keys made before roles existed (they are guest keys). Permissions: enter, lock (lock and unlock the door), stash, decor, manageKeys, garage, payBills, security (cameras and alarm; co-owners only by default; a co-owner key saved before this permission existed gets it automatically), upgrades (buy property upgrades; in no preset, so the owner only unless ticked for a key), exterior (decorate the yard outside, see Garden and exterior decor; co-owners by default; a key saved before this permission existed follows its decor setting). Every key needs enter. Guests cannot lock or unlock the door until the owner ticks Lock for them in the tablet's access matrix. Keys saved by an earlier build keep locking (it came with enter), except guest keys that still carry an unchanged guest preset; nothing is rewritten in the database. Only the owner (not a tenant) can make co-owners; a key holder who manages keys can only hand out permissions they have themselves |
Config.KeyExpiryOptions |
table | { 0, 3600, 86400, 259200, 604800 } |
How long a key can last, in seconds, as offered in the tablet (0 = never expires). The server only accepts these values. Expired keys stop working at once and are removed within a minute. A key holder whose own key expires can only give or edit keys that end no later than theirs |
Config.KeyLogMax |
number | 100 |
Key history rows kept per property (give, revoke, edit, lock change, expiry). The tablet shows the newest ones |
Config.ShortNameMax |
number | 24 |
Longest short name (characters) an owner can give a property in the tablet. The server caps it at 32 |
Decor and catalog
Config.Decor controls the Decor Studio (furniture). Prices and per-item limits live in data/props.json (see Data files).
| Option | Type | Default | Description |
|---|---|---|---|
command |
string | 'housingdecor' |
Chat command that opens the Studio inside a property. It needs the decor permission (owner and tenant; key holders when their role has it). /<command> gizmo off switches to mouse-drag moving if the gizmo misbehaves. Standing in a yard outside any interior it opens the yard Studio instead; /<command> yard (or exterior) and /<command> interior pick the mode when both would fit (see Garden and exterior decor) |
gizmo |
boolean | true |
false = never use the move and rotate handles, mouse drag only |
maxObjects |
number | 150 |
Most furniture pieces one property can hold (cart included) |
refundRatio |
number | 0.5 |
Share of the price paid given back when a piece is removed and the layout is saved (0.0 to 1.0) |
historySize |
number | 30 |
Undo steps kept while editing (20 to 100) |
mloRadius |
number | 25.0 |
MLO properties: furniture must stay this many metres from the property's stash point or entrance. IPL and shell use Config.InteriorPointRadius around the interior |
stash |
table | { slots = 30, weight = 100000 } |
Storage furniture marked "stash": true in data/props.json gets this many slots and this weight |
priceMultiplier |
number | 1.0 |
Every catalog price is multiplied by this (0 to 100, 1.0 = the prices in data/props.json). Used for what players see and what they pay; refunds use the price actually paid |
categoryMultipliers |
table | {} |
Extra multiplier per category on top of priceMultiplier, for example { electronics = 1.5, plants = 0.8 }. Categories: seating, tables, beds, storage, lighting, decor, kitchen, bathroom, electronics, plants, rugs, office, outdoor, misc |
maxStashFurniture |
number | 10 |
Most storage furniture pieces (wardrobes, cabinets, safes, fridges ...) one property can hold (0 = no limit) |
maxStashSlots |
number | 250 |
Most inventory slots all storage furniture of one property may add up to (0 = no limit) |
minTier |
number | 1 |
Lowest property tier (1 low, 2 mid, 3 high) that may be decorated at all. 1 = every property. The tablet shows it as "Decor allowed" and the Studio refuses lower tiers, owners included |
Furniture sets
Config.FurnishPresets: a ready furniture set per interior (built shells and catalog interiors). A new property gets its interior's set once, as normal Decor Studio furniture: seats, beds, TVs, fridges and storage work, the owner can move or sell the pieces, and they stay with the property. Sets ship in data/furnish_presets.json (a built shell is matched by its title, a catalog interior by its id). The shipped sets are for the furnished aty_shellcreator samples Bungalow - 2 bedrooms and Family house - 3 bedrooms, which aty_shellcreator publishes on its first start; renaming such a shell unlinks its set. An admin saves the saved furniture of a furnished property as its interior's set with the Decor Studio button Save as furniture set or housingfurnish capture <property id>; a set saved in game wins over the file. Republishing a shell never re-places a set; an admin re-applies one with housingfurnish apply.
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | true |
false = no set is ever placed (the creator hides the switch) |
command |
string | 'housingfurnish' |
Admin and console command (see Commands) |
defaultOn |
boolean | true |
Start state of the creator's Furnish with the furniture set switch |
paidRatio |
number | 0.0 |
Share of the catalog price stored as the price paid of a set piece, which is the refund base when the owner removes it. 0.0 = included in the property price, removing it pays nothing |
waitSeconds |
number | 60 |
How long a new property waits for the furniture table before its set is given up (apply it later with the command) |
Every piece passes the normal Decor Studio rules: it must be in data/props.json, inside the interior (a built shell's rooms), within the per-model max, Config.Decor.maxObjects and the storage limits. A piece that does not fit is skipped and the reason is printed to the server console.
Storage units
Self-storage facilities, rented or bought from the tablet's Storage units tab. Facilities, floors, rows, unit numbers and size tiers are defined in data/storage_facilities.json (see Data files); reload it in game with /housingunits reload. Every option below lives under Config.StorageUnits.
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | true |
false hides the tab and turns every unit action off. Rent clocks stop while it is off and catch up when it is turned on |
command |
string | 'housingunits' |
Admin command (housing admins, see Admin permission): reload, here, list, free <unit key> |
periodDays |
number | 7 |
Length of one rent period in days |
graceDays |
number | 2 |
Days after the due date before the tenant is evicted |
reclaimDays |
number | 3 |
Days an evicted tenant may still pay the arrears (plus a fee) to get the unit back; after that it is freed (0 = at once) |
reclaimFeePct |
number | 25 |
Reclaim fee, percent of one period's rent |
maxPrepaidPeriods |
number | 4 |
How many periods a tenant may pay ahead |
lockWhenLate |
boolean | true |
A tenant past the due date cannot open the unit |
evictionStash |
string | 'keep' |
'keep' = items stay under the old stash id (printed to the console), 'clear' = emptied when the unit is freed after an eviction (aty_inventory only) |
autopay |
boolean | true |
Tenants may turn on automatic rent payment |
autopayAccount |
string | 'bank' |
'bank' or 'cash' |
autopayLeadMinutes |
number | 60 |
Autopay is charged while the tenant is online, this long before the due date |
checkMinutes |
number | 5 |
How often due dates, evictions and expiries are checked |
maxUnitsPerCharacter |
number | 3 |
Units one character may hold, evicted ones count (0 = no limit) |
allowRent / allowBuy |
boolean | true / true |
Offer renting / buying at all |
sellBackRatio |
number | 0.6 |
Share of the purchase price paid back on a sale (0.0 to 1.0); also used for refunds when a unit shrinks |
downgrade |
string | 'verify' |
'verify' = a unit shrinks only when the inventory can show its contents fit (aty_inventory, ox_inventory), 'off' = never |
share |
table | { max = 4 } |
People a unit may be shared with (expiry choices: Config.KeyExpiryOptions) |
transfer |
table | { enabled = true, offerSeconds = 120, maxPrice = 10000000 } |
Owners may pass a bought unit to a player next to them; the offer is valid for offerSeconds, the price is 0 to maxPrice |
police |
table | { raid = true } |
On-duty police (Config.PoliceJobs) may open any unit at the entrance with a case number |
logMax |
number | 60 |
History rows kept per unit |
blips |
boolean | true |
Facility blips (a facility can also set "blip": false) |
World access: doorbell, police and robbery
Doorbell (Config.Doorbell)
A visitor rings at the entrance (card button, or the second key on the entrance prompt, G by default). The owner, tenant and key holders with the enter permission who are inside get a card; "Let in" gives the visitor a one-time pass to walk in, bound to that character and property. Owners switch the doorbell off in the tablet.
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | true |
Doorbell on or off |
answerSeconds |
number | 30 |
A ring waits this long for an answer |
tokenSeconds |
number | 20 |
After "Let in" the visitor must enter within this time (MLO: the door stays open this long) |
cooldownSeconds |
number | 15 |
One visitor rings one property at most this often |
perMinute |
number | 4 |
Rings one visitor may make per minute, all properties together |
maxActive |
number | 3 |
Rings waiting at one property at the same time |
notifyOutside |
boolean | false |
Also ring authorised players who are not inside |
remoteLetIn |
boolean | false |
Those outside may let the visitor in (door camera) |
showVisitorName |
boolean | true |
false = the card says "A visitor" |
mloRadius |
number | 25.0 |
MLO: players this close to its stash point or entrance count as inside |
logMax |
number | 50 |
Doorbell history rows kept per property |
keys |
table | { accept = 'Y', ignore = 'X', camera = 'H' } |
Default keys to answer a ring (camera = watch the door camera, see Home security). Players can rebind them in the game settings (Key Bindings > FiveM) |
Police (Config.PoliceJobs, Config.Police)
| Option | Type | Default | Description |
|---|---|---|---|
Config.PoliceJobs |
table | { 'police' } |
Jobs that see the Police tab (on duty only) |
enabled |
boolean | true |
Police seals and raids on or off |
grades |
table | { seal = 1, unseal = 2, raid = 2, warrant = 3, enter = 0, search = 1 } |
Lowest job grade for each action. seal: seal a property (tablet or at the door). unseal: lift a seal with its case number (housing admins need neither); also the grade that may seal "until lifted". raid: force entry at a door (an unlocked one: walk in, logged as a raid). warrant: claim a warrant on a raid, which skips the lock game; scripts can check it with the canRaid hook. enter: go into a sealed or raided property, or one that is being robbed. search: open the stash of a property as evidence while inside as police |
sealHours |
table | { 24, 72, 168 } |
Seal lengths offered in the tablet, in hours |
allowIndefinite |
boolean | true |
Also offer "until lifted" (officers of grades.unseal) |
sealLimit |
table | { max = 5, minutes = 60 } |
Seals one officer may place: max per minutes (max = 0: no limit) |
sealRequiresPresence |
boolean | false |
true = seals only at the door, not from the tablet |
raid.requireCase |
boolean | true |
A case number is required |
raid.allowWithoutWarrant |
boolean | true |
false = raids only with a warrant |
raid.warrantSkipsGame |
boolean | true |
With a warrant the door opens at once; without one the officer plays the lock game |
raid.breachTier |
number | 1 |
Lock game difficulty without a warrant (1 to 3) |
raid.unlockDoor |
boolean | true |
The forced door stays unlocked afterwards |
raid.window |
number | 600 |
Seconds other officers may follow inside |
raid.item |
string or false | false |
Item the officer must carry (not used up), for example 'police_stormram'; false = none |
sealProp |
string or false | 'prop_barrier_work06a' |
Prop placed at a sealed entrance (false = none) |
showOfficerToOwner |
boolean | false |
The owner's police log shows officer names (false = only the job label) |
enterLogMinutes |
number | 5 |
One officer entering the same property is logged at most once per this many minutes |
logRetentionDays |
number | 90 |
Police log rows are deleted after this many days (0 = keep) |
Robbery (Config.Robbery)
A lockpick opens the lock game at the locked door of an owned IPL or shell property (MLO properties cannot be robbed: they have no private instance). Winning lets the robber in for duration seconds in a dark interior with search points; noise builds up and at noise.limit the alarm goes off (police dispatch, owner notified).
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | true |
Robbery on or off |
item / advancedItem |
string | 'lockpick' / 'advancedlockpick' |
Lockpick items (qb-core names). The advanced one gives advancedBonus extra misses |
advancedBonus |
number | 2 |
Extra allowed misses with the advanced item |
breakChance |
table | { fail = 60, success = 15 } |
Percent chance the pick breaks (is used up) on a failed and on a successful attempt. Giving up with ESC counts as failed |
minPolice |
number | 2 |
Police on duty needed (0 = none) |
targets |
string | 'offline' |
'offline' = owner and key holders are offline, 'empty' = nobody is inside, 'any' = no check |
onlyOwned |
boolean | true |
false = unowned properties can be robbed too |
hours |
table | { enabled = false, from = 22, to = 6 } |
Only between these hours of the server clock |
cooldown |
table | { property = 21600, robber = 1800, attempt = 120 } |
Seconds: per property (after a robbery), per robber (after their robbery), per attempt (after a failed lock game) |
duration |
number | 480 |
Seconds a robbery lasts inside |
lock |
table | see below | Lock game per interior tier (catalog low, mid, high = 1, 2, 3) |
noise |
table | { limit = 100, pickMiss = 4, search = 7, stash = 25, perMinute = 6 } |
Noise that triggers the alarm at limit; the other values are what a missed pick, a search, opening the stash and each minute add |
alarm |
table | { owner = true, keyHolders = true } |
Who is told when the alarm goes off (online) |
dark |
boolean | true |
Switch the lights off inside for the robber |
search |
table | { seconds = 5, maxPoints = 8, categories = { storage, beds, tables, office, electronics, kitchen } } |
Seconds per search point, how many points, and the Decor Studio furniture categories that become search points |
points.byInterior |
table | {} |
Extra search points per catalog interior id, for example { ['gtao_house_hi_1'] = { { x = 0.0, y = 0.0, z = 0.0, label = 'Desk' } } }. IPL: world coordinates; shell: offsets from the shell |
loot |
table | see below | Per tier: rolls { min, max }, nothing (weight of an empty roll), cash { chance, min, max }, items (item, label, weight, min, max). Item names must exist in your inventory |
cashAccount |
string | 'cash' |
Where found cash goes ('cash' or 'bank') |
stash |
table | { enabled = false, minTier = 2, maxOpens = 1 } |
Let robbers open the property stash (limited times) |
dispatch |
string | 'builtin' |
'builtin', 'none', 'ps-dispatch', 'cd_dispatch', 'qs-dispatch', 'core_dispatch', 'aty_dispatchv2', 'qb-policejob' or 'custom'. All run on the server. A named resource that is not started falls back to 'builtin' |
dispatchChance |
table | { failedPick = 35, entry = 25, alarm = 100 } |
Percent chance of a police alert on a failed lock game, on entry and on the alarm |
dispatchCode |
string | '10-31' |
Code shown by the dispatch resources |
dispatchBlip |
table | { sprite = 40, color = 1, seconds = 180 } |
Built-in alert blip |
psDispatchJobs |
table | { 'leo' } |
ps-dispatch job types that receive the alert |
customDispatch |
function | empty function | function(data); data = { level = 'attempt' | 'entry' | 'alarm', propertyId, label, coords = { x, y, z }, code, title, message, jobs, robber } (robber is the server id) |
logRetentionDays |
number | 90 |
Robbery rows are deleted after this many days (0 = keep; at least 8, the cooldowns are read back from them) |
Default lock game (lock): tier 1 { pins = 3, window = 16, misses = 10, seconds = 60 }, tier 2 { pins = 4, window = 13, misses = 11, seconds = 75 }, tier 3 { pins = 5, window = 10, misses = 12, seconds = 90, hints = 'coarse' }. pins is the number of pins, window the degrees each pin accepts, misses the allowed misses in total, seconds the time limit, hints 'full' (very close / close / far off) or 'coarse' (very close / far off).
Default loot (loot):
| Tier | Rolls | Nothing | Cash | Items (weight) |
|---|---|---|---|---|
| 1 | 1 to 2 | 30 | 25 % for 40 to 220 | sandwich 25, water_bottle 20, bandage 15, painkillers 12, screwdriverset 8, samsungphone 6 |
| 2 | 1 to 3 | 25 | 30 % for 120 to 600 | whiskey 18, wine 16, samsungphone 12, iphone 10, tablet 9, goldchain 8, rolex 6, laptop 4 |
| 3 | 2 to 3 | 20 | 40 % for 400 to 1800 | vodka 12, iphone 12, laptop 10, rolex 12, goldchain 12, tenkgoldchain 8, diamond_ring 8, cryptostick 5, diamond 3, goldbar 2 |
Realtors and auctions
Realtor jobs and grades (Config.RealtorJobs)
Keys are job names, grades are the job grade numbers. The old list form { 'realestate' } still works: every listed job then gets Config.Realtor.defaultGrade. The default entry is the job realestate (label Dynasty 8).
| Grade field | Meaning | Default for grades 0 / 1 / 2 / 3 |
|---|---|---|
commission |
Percent of every deal paid to the listing realtor (0 to 25) | 2 / 3 / 4 / 5 |
create |
Create new properties in the creator (they start as drafts) | no / yes / yes / yes |
edit |
Edit unowned properties in the creator: own listings and unclaimed ones | no / yes / yes / yes |
editAny |
Edit every unowned property | no / no / yes / yes |
price |
Change the price of a listing within the bounds below | no / yes / yes / yes |
publish |
Publish a listing or take it offline (draft) | no / yes / yes / yes |
viewings |
Book timed viewings for clients and use the master key (enter any unowned listing; no stash or decor rights) | yes / yes / yes / yes |
offers |
Accept or decline offers and close enquiries | no / yes / yes / yes |
auctions |
Start and cancel auctions of their listings | no / no / yes / yes |
manageAll |
Act on every listing and auction of the agency, take over listings of other realtors, cancel auctions that have bids | no / no / no / yes |
pool |
Withdraw the agency pool (Config.Realtor.pool) |
no / no / no / yes |
claimAdmin |
Take a house listing (listed by an admin, never by a realtor) or start its auction. Missing = the grades with manageAll. Experimental rule, see Config.Realtor.minPriceRatio |
unset / unset / unset / yes |
maxListings |
Most listings a realtor may hold at once | 3 / 10 / 25 / 100 |
priceMin / priceMax |
Price bounds for a sale (also the lowest minimum bid of an auction) | 25000-1000000 / 25000-2500000 / 10000-10000000 / 1000-100000000 |
rentMin / rentMax |
Price bounds for rent | 250-10000 / 250-25000 / 100-100000 / 100-1000000 |
stashMax |
Largest stash a realtor may give a property in the creator | 50 slots, 200000 / 100, 400000 / 150, 800000 / 250, 2000000 |
A grade that is not listed uses the highest listed grade below it; a grade below the lowest listed one is no realtor (leave trainees out that way). Config.RealtorJobs is read once per start.
Realtor behaviour (Config.Realtor)
| Option | Type | Default | Description |
|---|---|---|---|
defaultGrade |
table | creator-capable grade: commission = 3, maxListings = 10, priceMin = 10000, priceMax = 5000000, rentMin = 100, rentMax = 50000, stashMax = { slots = 100, weight = 400000 }, abilities all on except editAny, manageAll, pool, claimAdmin |
Abilities of a job given in the old list form |
requireDuty |
boolean | false |
Realtors must be on duty to use the tab |
draftOnCreate |
boolean | true |
A property a realtor creates starts offline (draft) |
leads |
boolean | true |
Players may send enquiries and offers from Explore |
offerMinPct |
number | 50 |
Lowest offer, in percent of the asking price |
offerExpiryHours |
number | 72 |
An unanswered offer expires after this long |
offerHoldHours |
number | 24 |
An accepted offer reserves the property this long (the buyer pays from the tablet meanwhile) |
offerRequiresFunds |
boolean | true |
The buyer must hold the offered amount when offering |
leadCooldownMinutes |
number | 30 |
Wait after a declined or withdrawn enquiry or offer |
maxOpenLeads |
number | 5 |
Open enquiries and offers per character |
messageMax |
number | 140 |
Longest enquiry message (characters) |
viewingMinutes |
table | { 10, 20, 30 } |
Viewing lengths a realtor can pick |
viewingStartIn |
table | { 0, 900, 1800, 3600 } |
Viewing start choices, seconds from now (0 = now) |
maxViewings |
number | 10 |
Upcoming viewings one realtor may hold |
masterKeyMinutes |
number | 10 |
MLO listings: how long the master key opens the doors on the realtor's screen |
soldVisibleDays |
number | 7 |
Sold listings stay in the realtor's table this long |
autoClaimPayouts |
boolean | true |
Pay waiting commission automatically once the realtor is online (otherwise only from the tablet) |
pool |
table | { enabled = false, sharePct = 20 } |
Agency pool: sharePct percent of each commission goes to the job's pool; grades with pool withdraw it |
selfDealCommission |
boolean | false |
Pay commission when a realtor buys their own listing |
minPriceRatio |
number | 0.8 |
Experimental rule, may change: a house listing created by an admin never goes below max(grade priceMin, its first list price x this) when a realtor changes the price, accepts an offer or sets an auction's minimum bid (rent: rentMin and the first rent). 0 = no floor. Taking such a listing needs the grade's claimAdmin |
Auctions (Config.Auctions)
Sealed-bid auctions, started by realtors with the auctions ability or by admins, on unowned properties. Bids are secret: bidders see only their own bid and how many bids exist. Money is taken from the winner only when the auction ends; if the highest bidder cannot pay (or stays offline longer than offlineGraceMinutes) the next highest bid is charged.
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | true |
Auctions on or off |
account |
string | 'bank' |
Account the winner pays from: 'bank' or 'cash' |
durations |
table | { 1, 24, 48, 72 } |
Auction lengths offered, in hours |
startDelays |
table | { 0, 1, 6, 24 } |
Start choices, hours from now (0 = at once) |
minBidFloor / maxBid |
number | 1000 / 1000000000 |
Allowed range of the minimum bid and of any bid |
stepMin / stepMax |
number | 500 / 1000000 |
Allowed range of the minimum raise |
bidCooldownSeconds |
number | 5 |
Wait between two bids of one player on one auction |
maxActiveBids |
number | 5 |
Running auctions one character may bid on at once |
maxActivePerRealtor |
number | 3 |
Running or scheduled auctions per realtor |
offlineGraceMinutes |
number | 30 |
How long an offline winner has to come online |
sealedWaitHours |
number | 72 |
A police seal holds the settlement at most this long, then the auction is cancelled |
tickSeconds |
number | 15 |
How often auctions are checked |
realtorCommission |
boolean | true |
The realtor who started it gets their commission |
keepClosedDays |
number | 14 |
Finished auctions stay in the realtor tab this long |
Admin tab (Config.AdminPanel)
| Option | Type | Default | Description |
|---|---|---|---|
pageSize |
number | 25 |
Property table rows per page |
bulkMax |
number | 50 |
Most properties one bulk action may touch |
logRetentionDays |
number | 90 |
Audit log rows older than this are deleted |
logShown |
number | 100 |
Newest audit rows the tab shows (older ones: "Load more") |
Notifications
Every event a feature tells a player about (rent, bills, keys, doorbell, storage units, offers, auctions ...) still shows the usual notification when they are online, and is also kept per character: offline players get a summary when they log in and read everything behind the bell of the tablet.
Every option below lives under Config.Notifications.
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | true |
false = only the usual notifications, nothing is kept |
retentionDays |
number | 14 |
Entries older than this are deleted (checked hourly) |
maxPerCharacter |
number | 100 |
Newest entries kept per character |
coalesceSeconds |
number | 300 |
The same event again within this time updates the existing entry ("x 3") instead of adding one |
perMinute |
number | 20 |
More than this per character per minute: merged per category and shown without a popup (critical ones always pop up) |
loginDelaySeconds |
number | 12 |
Summary this long after a character loads |
loginSummary |
boolean | true |
Default of the player setting "summary when I log in" |
pageSize |
number | 40 |
Entries per page in the tablet |
reminders |
table | { enabled = true, hours = 24, checkMinutes = 5 } |
Rent, installment and bill reminders this many hours before the due date (checked every checkMinutes) |
keyExpiryWarnHours |
number | 24 |
Timed key holders are warned this long before the key runs out (0 = off) |
auctionEndingMinutes |
number | 60 |
Bidders are told this long before an auction ends (0 = off; sealed bids: nobody is told they were outbid) |
doorbell |
boolean | true |
Entries for doorbell rings and let-ins (the ring card itself always works) |
externalKeys |
table | {} |
aty_housing locale keys other resources may send with exports.aty_housing:PushNotification. Anything else they send is shown as plain text, so they cannot fake housing events such as a repossession |
externalResources |
table | {} |
Resources that may pick the category and send critical notifications. Every other resource posts under System, at most as a warning |
externalPerMinute |
number | 10 |
Notifications per resource per character per minute (the rest merge into one entry without a popup; housing's own limit is separate) |
Tablet
| Option | Type | Default | Description |
|---|---|---|---|
Config.AllowPreview |
boolean | true |
Lets players look inside a property that is for sale or rent and has no owner yet |
Config.PreviewSeconds |
number | 120 |
How long a preview lasts (0 = until the player leaves) |
Config.PreviewCooldownSeconds |
number | 300 |
Seconds a character must wait after a preview ends before previewing the same property again (0 = no wait) |
Config.ShareCooldownSeconds |
number | 30 |
Seconds between two listings one player can receive through "Share" in the tablet (a sender can share once every 10 seconds) |
Config.Tablet.item |
string or false | 'housing_tablet' |
Inventory item that opens the tablet. false = no item, /housing only (see Items) |
Config.Tablet.animation |
boolean | true |
The player holds a tablet prop with an animation while the tablet is open (removed in vehicles; on death the tablet closes) |
Config.Tablet.anim |
table | { dict = 'amb@code_human_in_bus_passenger_idles@female@tablet@idle_a', clip = 'idle_a', flag = 49 } |
Animation used for it |
Config.Tablet.prop |
table | model = 'prop_cs_tablet', bone = 28422 (right hand), offset = { x = 0.03, y = 0.02, z = -0.02 }, rotation = { x = 10.0, y = 0.0, z = 0.0 } |
Prop used for it |
Config.Tablet.pageSize |
number | 24 |
Listings per Explore page when the server filters (10 to 60) |
Config.Tablet.clientFilterMax |
number | 150 |
Up to this many listings the whole market is sent and the tablet filters it itself; above it the server filters and pages |
Config.Tablet.maxMarket |
number | 2000 |
Most listings the server looks at (newest first; 50 to 5000) |
Config.Tablet.priceHistoryKeep |
number | 20 |
Price changes kept per property |
Config.Tablet.priceHistoryShow |
number | 8 |
Price changes shown on a listing |
Config.Tablet.viewCooldownMinutes |
number | 60 |
One counted view per character and listing in this time |
Config.Tablet.viewsPerMinute |
number | 10 |
Most counted views per player per minute |
Config.Tablet.geoMaxDistance |
number | 300.0 |
Metres: the street and district of a property are read only by a player this close to its entrance |
Config.Tablet.geoStaffAbility |
string or false | 'editAny' |
Realtor ability (from Config.RealtorJobs grades) whose holders count as staff for addresses: their reading is stored at once and replaces a player's. Admins always count. A player's reading needs a second, matching one from another character. false = admins only |
Config.Tablet.storageCacheSeconds |
number | 60 |
How long one stash fill reading is reused |
Built shells (Config.BuiltShells)
Every shell published in aty_shellcreator becomes the shell interior sc_<id>. The property creator lists it under Built shells; entering spawns it through aty_shellcreator at Config.ShellSpawn, and its anchors give the spawn, exit, stash, wardrobe, bed and kitchen points. Without aty_shellcreator (or while it is stopped) such properties show "interior unavailable" and cannot be entered; nothing else breaks.
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
'auto', boolean |
'auto' |
'auto' = use aty_shellcreator when it runs, quietly off otherwise; true = the same, but a missing resource is reported in the console and the admin health check; false = never |
resource |
string | 'aty_shellcreator' |
Resource name of the Shell Creator |
planImages |
boolean | true |
Floor plans (and the photo) show in the listing gallery |
typeTag |
table | { apartment = 'apartment', house = 'house', trailer = 'trailer' } |
Shell tag to listing type (the first tag that matches) |
fixtures |
table or false | { wardrobe = 'wardrobe', bed = 'bed', kitchen = 'stove' } |
Anchor type to living point type. false = anchors give no living points |
containsMargin |
number | 0.5 |
Metres around the shell's floor cells that still count as inside (captured points, furniture) |
radiusPad |
number | 2.0 |
Metres added to the shell's bounding radius (coarse check) |
spawnTimeoutMs |
number | 15000 |
How long a client waits for the shell to build (1000 to 60000) |
blockDelete |
boolean | true |
Refuse archiving or deleting a shell that properties use (a Shell Creator admin can still force it) |
blockEditorInside |
boolean | true |
Refuse opening the Shell Creator while the player is inside a property or on a creator interior visit |
notifyUpdate |
boolean | true |
Players inside hear once that a new version was published; it applies when the property is empty again |
notifyOwners |
boolean | true |
Owners and tenants get a notification when their interior is archived, deleted or broken |
thumbCacheSeconds |
number | 300 |
Photo and plan images are kept this long on the server |
Several stashes (Config.Stashes)
Stash 1 is the property stash (its size is set in the creator). Built shells get one stash per stash anchor; catalog interiors may list extra points in data/interiors.json (stashes). Stash 2 and up get their own size in the creator and their own name and access rule in the tablet.
| Option | Type | Default | Description |
|---|---|---|---|
max |
number | 4 |
Stash points per property (1 to 8; 1 = only the property stash) |
extra |
table | { slots = 30, weight = 100000 } |
Default size of stash 2 and up (weight in grams) |
labelMax |
number | 24 |
Characters of a stash name |
defaultAccess |
string | 'all' |
Who may open a stash until its owner changes it: 'all' = everyone with the stash permission, 'managers' = owner, tenant and keys with "manage keys", 'owner' = owner and tenant only |
World prompts (Config.Prompts)
| Option | Type | Default | Description |
|---|---|---|---|
furnitureMode |
string | 'focus' |
Prompts of furniture and living points: 'focus' = one compact prompt for the piece the camera looks at (else the nearest within Config.Living.promptDistance), 'all' = every piece in range shows its own prompt, 'minimal' = like focus with the key only. Entrance, exit and stash prompts are not affected |
Utilities: power and water (Config.Utilities)
Each property has a power and a water meter. The meter counts standby use, placed appliances (fridges), lights and TVs that are on (while somebody is inside, or up to awayMinutes after the last player left) and the water and power of every living action. At the end of a bill period (Config.Finance.bills) the power and water lines are: standing charge (Config.Finance.bills.utilities[tier] x baseRatio) + usage x rate. Overdue power or water bills cut the supply after cutoff.graceHours; paying brings it back at once. Admins can inspect or override a meter with /housingutil (see Commands).
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | true |
false = the flat bills of Config.Finance.bills.utilities instead of meters |
tickSeconds |
number | 60 |
How often the meters count |
flushMinutes |
number | 5 |
How often meters are saved (a crash loses at most this much) |
awayMinutes |
number | 30 |
Lights and TVs keep counting this long after everybody left (TVs then switch off) |
baseRatio |
number | 0.4 |
Share of the tier's flat amount billed as the standing charge |
power |
table | rate = 3.0, standbyWatts = { 40, 70, 120 } (tier 1 to 3), lightWatts = 60, tvWatts = 140, applianceWatts = { fridge = 110 } |
Price per kWh and the watts of each consumer |
water |
table | { rate = 0.08 } |
Price per litre |
highUsage |
table | { power = 60, water = 1200 } |
One warning per bill period above this many kWh / litres (0 = off) |
historyMax |
number | 12 |
Meter readings kept per property (tablet chart) |
cutoff |
table | { enabled = true, graceHours = 48, warnHours = 24, power = true, water = true, darkMlo = true } |
Supply cut-off after an overdue bill: hours after the due date, warning hours before, which supplies, and whether MLO homes go dark too |
adminCommand |
string | 'housingutil' |
Name of the admin command |
externalPerMinute |
number | 60 |
exports.aty_housing:AddUtilityUsage calls allowed per resource per minute |
Integrations (Config.Integrations)
Which other resources may call the two exports that write data: AddUtilityUsage (adds to a property's meter, so to its bills) and PushNotification (puts a message in a player's tablet).
| Option | Type | Default | Description |
|---|---|---|---|
allow.utilities |
table | {} |
Resource names allowed to call AddUtilityUsage. Empty = any resource |
allow.notifications |
table | {} |
Resource names allowed to call PushNotification. Empty = any resource |
logSeconds |
number | 300 |
A refused call answers false, 'not_allowed' and prints one console line per resource and export at most this often |
aty_housing itself is always allowed. Example: Config.Integrations.allow.utilities = { 'my_washer', 'my_aircon' }.
Data files
Three JSON files in data/ are meant to be edited by the server owner. Restart the resource after a change (data/storage_facilities.json can also be reloaded with /housingunits reload). A broken entry is skipped with a line in the server console; the rest still loads.
Interior catalog (data/interiors.json)
The catalog lists the IPL and shell interiors the creator offers. MLO interiors are not catalog entries. The file ships with 17 bob74_ipl interiors (see Interiors).
| Field | Meaning |
|---|---|
id |
Unique, letters, digits, _ and -. Never rename it once a property uses it |
kind |
'ipl' or 'shell' |
label |
Name shown in the creator |
tier |
'low', 'mid' or 'high'. Drives bills, robbery difficulty and loot, and the decor tier rule |
verified |
false until you have checked the coordinates in game (the creator shows an "unverified" badge) |
spawn |
{ x, y, z, w }: where a player stands inside. exit and stash are optional: the exit defaults to the spawn, the stash point to one captured per property in the creator, else a point 1.5 m in front of the spawn |
ipl |
IPL only: { export = '<bob74_ipl export name>', interiorId = <number> }, as in the shipped entries |
shell |
Shell only: { model = '<model name>', offset = { x, y, z } }. Shell coordinates are offsets from Config.ShellSpawn |
type, area, rooms, approx, features, photos |
Optional listing facts for Explore: apartment, house or trailer (an apartment never gets an automatic yard); floor area in m2; bedrooms; true when the numbers are estimates; feature tag ids; photo file names |
Furniture catalog (data/props.json)
The Decor Studio catalog: 796 items in 14 categories. The server reads only the fields below; everything the client shows, every price and every limit comes from this file and never from the player.
| Field | Type | Meaning |
|---|---|---|
model |
string | Required. The game model name (letters, digits and _, at most 64). Must exist in your game build; duplicates are skipped |
label / labelTr |
string | English and Turkish display name (at most 64 characters). labelTr is shown when Config.Language = 'tr' |
category |
string | One of seating, tables, beds, storage, lighting, decor, kitchen, bathroom, electronics, plants, rugs, office, outdoor, misc. An unknown category becomes misc |
price |
number | Required, 0 to 10000000. The base price before the multipliers |
max |
number | Required, 0 to 500. Most pieces of this model per property; 0 = no per-model limit |
light |
boolean | The item is a light that can be wired to a light switch |
switch |
boolean | The item is a light switch (the file ships one) |
stash |
boolean or table | true = storage furniture with the Config.Decor.stash size; { "slots": 20, "weight": 50000 } = a specific size (slots 1 to 500, weight in grams). Absent or false = not storage |
tintable |
boolean | The item has colour variants in the Decor Studio inspector (18 shipped items do). Needs tints |
tints |
number | Number of colour variants of a tintable item, 2 to 16 (default 16) |
tintColors |
table | Optional swatch colours of the variants, "#rrggbb" strings, one per variant (up to 16), shown in the inspector |
exterior |
boolean | The item may stand in a yard (112 shipped items). Never honoured for storage furniture, light switches or cameras |
thumb |
string | Path of the item's thumbnail inside the resource, for example data/thumbs/apa_mp_h_stn_sofacorn_01.webp. Letters, digits, _, -, / and . only. Absent, or a file that cannot be loaded, shows a category glyph instead |
tags |
table | Search words (up to 24, each up to 32 characters) |
Other fields in the shipped file (sub, style, tier, size, verified) are informational and not read by the server.
Example entry:
{
"model": "apa_mp_h_stn_sofacorn_01",
"label": "Modern Corner Sofa",
"labelTr": "Modern Köşe Koltuk",
"category": "seating",
"price": 4500,
"max": 2,
"tintable": false,
"light": false,
"switch": false,
"stash": false,
"tags": ["sofa", "couch", "modern"]
}
Price multipliers. What a player sees and pays is price x Config.Decor.priceMultiplier x Config.Decor.categoryMultipliers[category], rounded to a whole number. With priceMultiplier = 1.5 and categoryMultipliers = { lighting = 2.0 } a lamp listed at 480 costs 1440. Use the multipliers to rebalance the whole catalog without touching the file. A price change only affects new purchases: a removed piece is refunded from the price the player actually paid, at Config.Decor.refundRatio.
Limits. A property holds at most Config.Decor.maxObjects pieces in total, at most max of one model, at most Config.Decor.maxStashFurniture storage pieces and at most Config.Decor.maxStashSlots storage slots. A limit that is lowered later never removes furniture that is already placed; it only blocks new pieces.
Thumbnails. 786 of the 796 shipped items come with a thumbnail (a 256 px transparent WebP in data/thumbs/<model>.webp, about 6.6 MB in total) and a matching thumb entry. The other 10 show a category glyph because their model could not be rendered by the capture. They stay in the catalog and work normally. The capture tool is a developer-side tool and is not part of this package. For a prop you add yourself:
- Save its picture as
data/thumbs/<model>.webp, preferably square, 256 x 256 px, transparent background, a few KB. Any image you render yourself works. - Add
"thumb": "data/thumbs/<model>.webp"to the item's entry indata/props.json. - Restart the resource. Files in
data/thumbs/ending in.webpare already listed infxmanifest.lua(data/thumbs/*.webp) and reach the players' game automatically. A file kept in another folder or with another extension must also be added to thefileslist offxmanifest.lua.
Checking your models. Admin tab > Diagnostics tests every model of the catalog (and shell and MLO door models) against your game build and lists the missing ones.
Storage facilities (data/storage_facilities.json)
Read by the server only. Reload with /housingunits reload.
| Part | Meaning |
|---|---|
tiers |
Unit sizes: id, label, slots, weight (grams), rent (per Config.StorageUnits.periodDays; 0 = cannot be rented), price (to buy; 0 = cannot be bought), area (m2). List them from small to large |
facilities[].id, label |
Facility id (letters, digits, _, -, 1 to 24) and name |
facilities[].entrances |
One or more { x, y, z, w } points where the facility opens. /housingunits here prints your current position as a ready-made snippet |
facilities[].blip |
{ sprite, color } or false (default sprite 351, color 15) |
facilities[].tiers |
Which tiers the facility offers: an id, or { id, weightMultiplier, priceMultiplier } to scale one tier there |
facilities[].weightMultiplier, priceMultiplier |
Scale every tier of the facility |
facilities[].floors[].rows[] |
Rows of units: { id, tier, units = <count> }, or units as a list of { n, tier?, door? } where door is a point in front of that unit |
facilities[].doorOnly |
true = units with a door open only there |
facilities[].verified |
false until you checked the coordinates in game |
The two example facilities in the shipped file (Davis Self Storage and Senora Storage) use coordinates that were not checked in game. Replace them with your own locations.
Ready-made properties (data/seed/vinewood_hills_lux.json)
The resource ships 24 luxury houses in Vinewood Hills on the gtao_house_hi_1 to gtao_house_hi_8 IPL interiors, with entrance and garage points (23 of them have a garage) and sale prices from $850,000 to $1,500,000 (rent: 2 % of the sale price per rent period). They are created automatically on the first start (Config.SeedProperties, on by default) with no owner, listed for sale and rent:
- Every house goes through the same checks as the property creator, as the server console.
- A house whose spot is already used is skipped, the others are still created. "Used" means another property's entrance closer than 5 m to the house's entrance, or any entrance or garage point closer than 3 m to the house's garage, for example an MLO property you created there yourself. The console prints one line per skipped house with the reason, for example
seed: entry 3 "Vinewood Hills Residence #3" skipped: entrance 2.5 m from the entrance of #12 (min 5.0). - A property with the same label already at that entrance (you ran the file with
housingbulkcreatebefore) is adopted: nothing is written for it. - The interiors need
bob74_iplon the server. Without it the houses are still created and the console prints one warning; nobody can enter them untilbob74_iplruns. An interior id that is not indata/interiors.jsonis skipped like the creator would refuse it. - When the run is done the file is marked in the
aty_housing_metatable (keyseed:data/seed/vinewood_hills_lux.json:v1), so later starts do nothing. A house you delete does not come back. If the database fails while a house is being created, the file is not marked and the next start finishes it (without duplicates). - To seed the file again (for example after you deleted the houses by mistake), raise its
"version"or delete that key fromaty_housing_meta, then restartaty_housing.
The points were captured on a plain QBCore map. Check them on yours: a map or MLO without a property can still block an entrance in the world, which the server cannot see. Remove houses you do not want from the tablet's Admin tab (bulk delete).
The same file works with the console command, which checks everything first and creates all or nothing:
housingbulkcreate data/seed/vinewood_hills_lux.json dry
housingbulkcreate data/seed/vinewood_hills_lux.json
Your own seed files use the housingbulkcreate format plus an optional "version" number; add them to Config.SeedProperties.files.