Skip to content
ATY ScriptsDocsHousingFeatures and commands

Features and commands

aty_housing: Features and commands

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

Features

The whole system is one tablet (/housing or the tablet item) that adapts to the player's role. A tab a player has no right to is never shown.

Everyone: buyers and visitors

  • Explore tab with list, grid and map views. Filter by sale, rent and auction, type, tier, price, size and district; sort by price, newest or popularity.
  • Listing details: size and rooms, feature tags, stash and garage capacity, whether decorating is allowed, address and district, recent price changes with a price-drop badge, views and favourites, bank-owned badge.
  • Loan calculator with a live installment plan, rent and deposit details, and a rent-to-own note where the listing allows it.
  • Preview: a timed tour inside an unowned IPL or shell listing (length Config.PreviewSeconds, cooldown Config.PreviewCooldownSeconds).
  • Favourites, compare up to three listings, share a listing with a nearby player (sets a waypoint for them).
  • Contact a realtor with an enquiry or a price offer; take part in sealed-bid auctions.
  • Map blips for properties you own, rent or hold a key to, and (optionally) for properties on the market.
  • Doorbell at every owned property, storage units in self-storage facilities.
  • Apartment buildings and motels: a directory of every unit at the building entrance, an elevator, free starter apartments for new characters and motel rooms rented by the night (see Apartments, buildings and motels).

Owners and tenants

  • Buy or rent a property (Config.MoneyAccount). Buy with cash or with a loan (down payment, term, installments); rent for several periods with a deposit, or rent and later buy the property with part of the rent credited.
  • My properties with sub-tabs: General (address, lock, doorbell history, directions), Access (keys), Finance (plans, bills, payment history with receipts, autopay account), Storage (stash and storage furniture fill level), Garage (vehicles stored there), Settings (short name, doorbell on or off, "wake up here"), Sell / transfer.
  • Keys and roles. Give keys to nearby players with a role preset (co-owner, roommate, guest) and an individual permission set: enter, lock, stash, decor, manageKeys, garage, payBills, security, upgrades, exterior. A guest cannot lock or unlock the door unless you tick Lock for them. Keys can be timed (see Config.KeyExpiryOptions), revoked at any time, and changed all at once with "change the lock". A key log shows who did what. A key holder who manages keys can only hand out permissions they have themselves.
  • Stash of configurable size; every ownership change gives the next owner an empty one.
  • Sell back to the market (Config.SellBackRatio), or transfer to a nearby player for a price through a transfer offer; a resale lock (Config.ResaleLockDays) stops price flipping.
  • Finance: amortized loans with late fees, warnings and repossession; bills (power, water, service) and property tax by tier; autopay while online; everything owed while offline is collected at the next login. A bank-owned listing appears at a discount after a repossession.
  • Decor Studio (see below) and the doorbell: visitors ring, people inside let them in or ignore them.
  • Light and colours (see Lighting and colours): light scenes for the whole home, a switch or a single lamp (white temperature, colour, brightness, party cycle), a switch key that cycles scenes, interior details of IPL homes and colour variants of furniture.
  • Garden decor (see Garden and exterior decor): decorate the yard outside with plants, benches, loungers, barbecues and lanterns that everybody sees, controlled by the exterior key permission.
  • Home security (see Home security): CCTV cameras, an alarm with a keypad and PIN, and a door camera, controlled by the security key permission.
  • Player marketplace and contracts (see Player marketplace and contracts): owners list a property for sale or lease, buyers make offers and counters, both sign a digital contract with the money held in escrow, and an optional realtor brokers the deal.
  • Home insurance, property upgrades and My furniture (see Home insurance, Property upgrades, Furniture store); the tablet also shows your ownership limits (Config.Limits).

Decor Studio

Open it inside your property with /housingdecor.

  • A free camera, a searchable catalog of 796 furniture items in 14 categories (English and Turkish names, search by name, model, category and tags), favourites and recently placed items.
  • "Try in place": a ghost preview with a validity check (collision, property bounds, limits) before anything is bought; a cart with balance and total; one confirmation to buy.
  • Move and rotate with gizmo handles (or mouse dragging), snapping and grid steps, align to surface, multi-select, duplicate, copy and paste a transform, numeric position and rotation, 30 undo steps.
  • Storage furniture (wardrobes, cabinets, safes, fridges ...) with its own stash, a custom name and an "owners only" lock; light switches that turn linked lights on and off (a local light is drawn for lit lamps).
  • One editor at a time per property; everyone else sees a read-only view. Removed pieces go back to My furniture (see Furniture store); with Config.FurnitureStore.removeTo = 'refund', or without any furniture store, they are refunded at Config.Decor.refundRatio of the price paid.
  • Style tab: light scenes and, in IPL homes, interior details; colour variants for the 18 catalog items that have them (see Lighting and colours).
  • Yard mode: standing in a yard, the same Studio edits the yard with the outdoor catalog items (see Garden and exterior decor).
  • Catalog thumbnails are included for 786 of the 796 items; the other 10 show a category glyph.

Key holders

A key holder sees the property in My properties with only the tabs their permissions allow: Storage needs stash, Garage needs garage, Finance needs payBills. The lock button needs lock. The server checks the permission on every action, never the tablet.

Realtors

Job and grade come from Config.RealtorJobs. Depending on grade a realtor can:

  • Create listings in the same creator as admins (they start as drafts), edit unowned listings, set prices within grade bounds, publish or take listings offline, claim and release listings.
  • Read the inbox of enquiries and offers; an accepted offer reserves the property for offerHoldHours while the buyer pays from the tablet.
  • Book timed viewings for a nearby client and use the master key to enter unowned listings (no stash or decor rights).
  • Earn commission on every sale or rental (paid at once when online, waiting and auto-claimed when offline) and share it with an agency pool; withdraw the pool with the pool ability.
  • Start and cancel sealed-bid auctions; see a dashboard, a commission ledger and an activity log.

Police

On-duty officers of Config.PoliceJobs get the Police tab:

  • Seal a property with a case number and a duration (or until lifted, for higher grades). A seal evicts everyone except police, closes stash, decor and garage access for everyone (owner included), blocks selling and buying, and pauses evictions and repossessions while it lasts. Lift it with the case number or let it expire.
  • Raid: force entry with a case number. With a warrant (grade-gated, checked by the canRaid hook for your MDT) the door opens at once; without one the officer plays the lock game. Other officers may follow for a time window.
  • Enter sealed, raided or robbed properties and search the stash as evidence.
  • See active robbery alerts with directions, and a searchable police log. Owners can read the police record of their own properties.
  • Storage units can be opened by police at the facility entrance with a case number.

Robbers

A player with a lockpick can try the lock of a locked, owned IPL or shell property. A lock-pick mini game (a full-screen panel) decides the outcome; on success the robber is inside for duration seconds in a dark interior with search points and a noise meter; at the noise limit the alarm goes off and police and the owner are told. Loot is rolled per interior tier. Eligibility (police on duty, owner offline, time window, cooldowns, item) is checked on the server; see Robbery.

Admins

  • The creator (/housingadmin): a seven-step wizard (kind, interior, points, price, storage and garage, tier and tags, summary) with camera-based point capture, interior preview, drafts, duplicate, and typed-confirmation delete.
  • The Admin tab: server-side search, filter, sort and paging of every property; transfer, evict, reset, delete and bulk actions; a diagnostics panel (integrations, catalog, missing models, database); an audit log.
  • Storage-unit administration with /housingunits.
  • The yard editor (/housingyard): draw a yard corner by corner or go back to the automatic one.
  • The building manager (/housingbuilding): create apartment buildings and motels, generate their units, set elevator stops, edit prices in bulk, attach existing properties and mark a starter building.

Notification center

A bell in the tablet header collects every housing event (rent, loans, bills, keys, doorbell, storage units, offers, auctions, transfers ...) per character, with categories, filters, deep links to the right tab and notification preferences. Offline players get a summary at login. Rent, installment and bill reminders, key expiry warnings and auction-ending notices are sent ahead of time.

Interiors

aty_housing never ships interior assets. It stores interior names and coordinates only; IPL, shell and MLO files come from your own licensed packs.

Kind Where it lives Privacy How it is added
IPL bob74_ipl interiors in the catalog data/interiors.json Private: each property gets its own routing bucket Pick the interior in the creator
Shell A shell resource you install (never bundled) Private: spawned locally for the entering player at Config.ShellSpawn, own routing bucket Add an entry to data/interiors.json, then pick it in the creator
MLO A map resource you install, at fixed world positions Not private: players walk in through real doors Not a catalog entry: defined per property in the creator

IPL catalog (17 interiors). All of them are bob74_ipl GTA Online interiors. Their coordinates are default values that were not checked in game (verified: false); the creator flags them with an "unverified" badge. Capture your own inside points in the creator for each property to override the defaults, and set verified to true in the catalog once you checked one.

Id Label Tier Type
gtao_apa_hi_1 4 Integrity Way, Apt 30 high apartment
gtao_apa_hi_2 Dell Perro Heights, Apt 7 high apartment
gtao_house_hi_1 3655 Wild Oats Drive high house
gtao_house_hi_2 2044 North Conker Ave high house
gtao_house_hi_3 2045 North Conker Ave high house
gtao_house_hi_4 2862 Hillcrest Ave high house
gtao_house_hi_5 2868 Hillcrest Ave high house
gtao_house_hi_6 2874 Hillcrest Ave high house
gtao_house_hi_7 2677 Whispymound Drive high house
gtao_house_hi_8 2133 Mad Wayne Thunder Drive high house
gtao_house_mid_1 Mid-range apartment mid apartment
gtao_house_low_1 Low-end studio low apartment
hl_apa_1 Dell Perro Heights, Apt 4 high apartment
hl_apa_2 Richard Majestic, Apt 2 high apartment
hl_apa_3 Tinsel Towers, Apt 42 high apartment
hl_apa_4 Eclipse Towers, Apt 3 high apartment
hl_apa_5 4 Integrity Way, Apt 28 high apartment

Floor areas and room counts in the catalog are estimates (approx: true). Two properties that use the same interior id show the same room. The interior details (clothes, bottles, smoke) are chosen per property and shown to the people inside it (see Lighting and colours).

Adding a shell. The shell path is implemented but no shell ships in the catalog, so it has not been exercised yet.

  1. Install your shell resource (separately licensed; never put its files into aty_housing).
  2. Add an entry to data/interiors.json with kind = 'shell', shell = { model, offset } (the model name exactly as your pack streams it) and verified = false. The shell's spawn, exit and optional stash are offsets from Config.ShellSpawn.
  3. Restart aty_housing. In /housingadmin pick the interior: Preview shows it, and the points step takes you inside in a private bucket to capture spawn, exit and stash.
  4. Test entering, leaving, and reconnecting while inside; then set verified to true.

MLO properties. In the creator choose kind MLO, then capture the entrance, an optional garage point, the stash point and up to eight doors (aim at each door; its model and position are stored). Captured doors join the game's door system and follow the lock state of the property: they are locked while the property is locked, and anyone with the enter permission can unlock them from the property card. At least one door and a stash point are required.

Extra tools for server owners

  • Every text is in locales/; add a language by creating locales/<lang>.lua (and the feature files in the subfolders) and listing them in fxmanifest.lua.
  • Move over from another script with housingimport, and get Discord posts for housing events (Migrating from qb-houses / ps-housing, Discord webhooks).
  • The open API (server/api.lua): exports, events and hooks for MDT, garage, phone and spawn scripts.
  • Garage, spawn and inventory integrations work through that API and aty_lib; no other script has to be edited.

Commands

The names below are the defaults; each comes from the config option shown.

Command Side Who Description
/housing (Config.Command) Client Everyone Opens the housing tablet
/housingadmin [id] (Config.AdminCommand) Server + client Housing admin (Admin permission) Opens the property creator: without an id a new property, with an id that property
/housingdecor (Config.Decor.command) Client Players with the decor permission, inside a property Opens the Decor Studio
/housingdecor gizmo off / on Client Same Switches between the move and rotate handles and plain mouse dragging
/housingdecor yard (or exterior) / interior Client Players with the exterior permission, in a yard Opens the yard Studio, or the interior Studio, when both would fit. See Garden and exterior decor
/housingyard [property id] (Config.Exterior.adminCommand) Client (checked on the server) Housing admin Draws or resets the yard of a property: without an id the nearest entrance within 60 m. Keys E add a corner, X remove the last, H automatic yard, G save, Backspace cancel
/housingbuilding (Config.Buildings.adminCommand) Server + client Housing admin, or the console Opens the building manager in game; in the server console it prints every building. See Apartments, buildings and motels
/housingunits reload (Config.StorageUnits.command) Server Admin or console Reloads data/storage_facilities.json and applies a changed enabled
/housingunits here Server + client Admin, in game Prints your position as a snippet for the facilities file
/housingunits list Server Admin or console Prints every facility with its free units and every orphan unit to the server console
/housingunits free <unit key> Server Admin or console Frees a unit by force (works on unreadable rows too)
/housingutil <id> status (Config.Utilities.adminCommand) Server Admin or console Prints the power / water state and meter readings of a property
/housingutil <id> restore [hours] Server Admin or console Turns a cut-off supply back on for hours (no value: until cleared)
/housingutil <id> clear / reset Server Admin or console Removes a restore override / closes the current meter period and starts a new one
housingfurnish <list | show <interior> | status <id> | apply <id> [replace|add] | capture <id> | reset <interior>> (Config.FurnishPresets.command) Server Admin or console Furniture sets: list them, show one as JSON, show what was placed in a property, place a property's set now (replace, the default, swaps the earlier set pieces and keeps what the owner bought; add places another copy within the limits), save a property's saved furniture as its interior's set, or drop a set saved in game so the shipped file applies again
housingbulkcreate <file.json> [dry] Server Admin or console Creates many properties from a JSON file inside the resource (for example the shipped data/seed/vinewood_hills_lux.json, see Ready-made properties). Each entry is checked like the creator form; one invalid entry and nothing is created; entries already created (same label at the same entrance) are skipped, so a batch can run again. dry only checks. Format: { "defaults": { creator form keys }, "properties": [ { "label", "interior", "entrance": {x,y,z,w}, "garage"?: {x,y,z,w}, "salePrice", "rentPrice", ... } ], "spacing"?: { "entrance": 5.0, "garage": 3.0 }, "version"?: 1 }
housingimport [<source> [dry]] (Config.Importers.command) Server Admin or console Imports from qb-houses or ps-housing: no argument lists the sources, <source> dry checks and writes nothing, <source> imports. See Migrating from qb-houses / ps-housing
/housingupgrade <property id> [<upgrade> <level> | reset] (Config.Upgrades.adminCommand) Server Admin or console Prints the upgrade levels of a property, sets one without paying, or resets them all. See Property upgrades
/housingfstore here [id] [label] | add <id> [label] | list | orders [charId] | give <charId> <model> [n] [paid] | take <charId> <model> [n] | deliver <orderId> (Config.FurnitureStore.adminCommand) Server (here and add: in game) Admin or console Furniture stores: print the config line for a new store at your position, add it for this session, list stores and open orders, show open orders, give or take pieces of My furniture, deliver an order now. See Furniture store
/furniture (Config.FurnitureStore.online.command) Client Everyone, when the online catalog is on Opens the online furniture catalog
/housinghygiene <0-100> [player id] Server Admin or console Test tool: sets a player's hygiene (yourself without an id)
/housingcookxp <xp> [player id] Server Admin or console Test tool: sets a character's cooking XP
/housingnotifytest [text] Server Admin, in game Sends you a test notification (toast, bell badge and a stored entry) to check the notification center
/housingseatdebug [all | model <name> | world | sweep | anim] Client Admin (checked on the server first) Diagnostic dump of sitting / lying places on furniture to the F8 and server console, for tuning Config.Living poses. Not needed in normal play
/housingexit (Config.ExitCommand) Client Everyone Emergency exit from the property you are in (the server still checks that you are inside)
/housingfocus (Config.FocusCommand) Client Everyone Releases mouse and keyboard focus if the panel gets stuck

Key bindings

Except for E, these are FiveM key mappings: players can rebind them under Settings > Key Bindings > FiveM.

Default key Action
E Use a property point marker (entrance, exit, stash) or a building prompt (the directory), when Config.InteractMode allows it (the game's pickup control, not a FiveM key mapping)
G Second action at an entrance prompt, for example ring the doorbell; inside a property with an alarm, open the alarm keypad at the exit prompt; at a light switch, cycle the light scene of its lamps (Scene: ...)
Y / X Doorbell card: let in / ignore (Config.Doorbell.keys)
H Doorbell: watch the door camera of the newest ring (Config.Doorbell.keys.camera)
Mouse left / right Decor Studio: select or place / look around
R, Z, G, F Decor Studio gizmo: switch move and rotate, switch world and local space, toggle snapping, drop onto a surface
Enter / Backspace Decor Studio gizmo: confirm / cancel placement
E, X, H, G, Backspace Admin yard editor (/housingyard): add a corner, remove the last, back to the automatic yard, save, cancel. Fixed keys, not FiveM key mappings

Languages

Language Config.Language File
English (default, fallback) 'en' locales/en.lua
Turkish 'tr' locales/tr.lua
German 'de' locales/de.lua
French 'fr' locales/fr.lua
Spanish 'es' locales/es.lua
Brazilian Portuguese 'pt-br' locales/pt-br.lua

To switch, set Config.Language in shared/config.lua to the code in the second column and restart the resource. Every text of the tablet, the creator, Decor Studio and the in-world prompts follows that setting. A key that is missing in the chosen language is shown in English. The translations are in locales/<code>.lua and in the feature subfolders (locales/<feature>/<code>.lua); all of them are listed in fxmanifest.lua.