Documentation
How to use qs-housing: create shell, IPL and MLO houses in game, buy, rent and mortgage, bills, keys, F3 management, furniture decoration, upgrades, pets, cleaning, agencies and robberies.
Housing Creator has three interfaces. Knowing which is which saves a lot of searching.
Window | Opened with | What it is for |
|---|---|---|
The creator | F7 or | Admins and real estate jobs. Building, editing and deleting houses, furniture shops and agencies. |
The management panel | or at the house |
/houseMenuOwners, tenants and key holders. Decorating, keys, bills, upgrades, selling, renting out and every home setting. |
The property hub | [E] Property Details at a door | Everyone. Photos, price and details of a house on the market, with Visit, Buy, Rent and Mortgage. |
Both keybinds are FiveM key mappings, so each player can rebind them in Settings → Key Bindings → FiveM. The defaults come from Config.OpenJobMenu and Config.OpenHouseMenu.
Creator → Houses → Create House. The form opens with two choices that cannot be changed later:
Choice | Options |
|---|---|
Sell type | Purchasable — players buy it. Rentable — the real estate company owns it and it goes straight onto the rental market. |
House type | Shell — a streamed interior placed in the sky. IPL — a GTA interior such as an executive apartment, with paid colour themes. MLO — a real building on the map you walk into, with its own doors. |
Every point has a Select button. The tablet closes, you get a free camera and a ghost of what you are placing, and the tablet comes back when you confirm. Place the zone first: every other point is checked against it.
Point | What it is |
|---|---|
Zone points | Required. The outline of the property: click at least 4 corners, Z/X for its height. It cannot overlap another house. Pets, garbage and decorating are limited to it. |
Entry | Required. The front door, where players enter and come back out. |
Shell + Exit | Shell houses. Pick the shell with the arrows (it spawns 30 m above you), then click inside it where players appear. |
IPL | IPL houses. A camera tours each interior in |
MLO test coords + doors | MLO houses. Where visitors are sent on a viewing, and every door of the building: click each door (it turns green), right click undoes. Doors start locked. |
Garage | Optional. A ghost car where vehicles are stored. With qs-advancedgarages you also pick a garage interior. |
Garbage dump | Optional. The bin where residents empty their garbage bags. |
Delivery | Optional. Where the furniture delivery worker waits. |
Board | Only with |
Key | Does |
|---|---|
W A S D · Q / E · mouse | Fly the camera, down / up, look around. |
Left click / Right click | Place a point / undo the last one. |
Z / X | Rotate the ghost, or change the zone's height. |
← / → | Previous / next shell, IPL or model. |
Mouse wheel | Raise or lower a shell or model. |
Enter / Backspace | Confirm / cancel. |
Basic information — a unique name, the price, the payment method (cash or bank), a description, whether plants are allowed inside or outside, and whether it is hidden from the house browser.
Apartment count — 0 is a normal house. Any number up to Config.MaxApartmentCount (50) turns it into a building with that many units sharing one door. Apartments cannot have a garage, and MLO houses cannot be apartments.
Blip — name, sprite, colour and scale.
House model and island — place an exterior house prop or a private island under an empty plot. With Config.Construction = true, a building site with workers stands there until the build time runs out.
Photos — Take Photo, Enter to shoot, F to step into the interior. Needs your FiveManage token in config/fivemanage.lua.
The address is the street you are standing on when you press Create house, so save from in front of the property. Click any house in the list to edit it, use the red Delete button to remove it with its furniture and garage, or Remove Owner to put it back on the market.
Walk to the door of a house on the market and press [E] Property Details (an apartment building shows [E] Show Apartments). The property hub shows the photos, price, interior type and garage, with four buttons:
Button | What happens |
|---|---|
Visit | A timed viewing inside ( |
Buy | Opens the contract for the full price. |
Mortgage | Opens the contract with credit switched on. Shown when |
Rent | Opens a rental contract, for houses listed for rent. |
The contract adds three fees to the price, each a function of it in config/main.lua: the broker fee (5%), the bank fee (10%) and taxes (5%). With the defaults a buyer pays 120% of the listed price, taken from the house's payment method.
A player can own up to Config.MaxOwnedHouses (15) houses.
The first sale of a house built in the creator pays Config.SocietyCommision (30%) of the price to the society of the job of whoever created it, through Config.Society.
Buying a player's listing pays the seller the price without fees, even while they are offline.
With credit, the buyer pays Config.CreditEq (30%) of the total up front. The same amount is then taken from their bank every Config.CreditTime minutes until the debt is paid — online or offline. While a mortgage is open the house cannot be sold, listed or transferred.
Any owner can rent their house out: F3 → Rent sets the price, a description, photos, whether it comes furnished and whether it shows in the browser. Houses created as Rentable are owned by the real estate company and are always on the rental market.
Signing a rental only checks that the tenant can pay. The tenant becomes the occupant and takes over the keys; the owner keeps the house but not the door while it is rented. Rent is then charged on a schedule:
Config.RentScheduler.Mode | Charges |
|---|---|
| Default. Once a real month, on the day the rental started. |
| Every |
Rent goes to the owner — or to the creator's job society for company rentals, or to the agency for agency houses. A failed charge becomes an unpaid rent the tenant can pay in F3 → Rentals. An owner can evict only a tenant who owes rent; an admin can always evict with /hireRenter. A tenant leaves with F3 → Leave.
Every Config.Bills.IntervalHours (1 hour) each owned house gets a bill:
Utility | Charged |
|---|---|
Electricity | Hours the lights were on × |
Water · Internet | A random amount within |
Bills are paid one by one or all at once in F3 → Bills. With more than one unpaid bill the house is cut off: the lights go out, decorating is blocked, and it cannot be sold or left.
Option (F3) | What it does |
|---|---|
Sell to Bank | Instant. Pays half of the original price into the bank and puts the house back on the market. |
Sell to Player | Lists it on the market at your price, furnished or not. The buyer pays the price plus fees; you receive the price. Cancel Sale takes it off. |
Transfer House | Gives it for free to a player standing within 10 m. Key holders are reset. |
Transfer to Agency | Offers it to a real estate agency at an asking price (see below). |
None of these is possible while the house is rented, mortgaged or cut off. An unfurnished sale removes the furniture; a furnished one leaves it for the buyer.
The owner gives and takes keys in F3 → Key Management to anyone within 10 m. A key holder can enter, lock and unlock, and open F3 for the bills. What else they may do is set per house in F3 → Settings → Permissions (defaults in Config.DefaultKeyPermissions): furniture access, buying upgrades and paying bills.
With Config.EnableMetaKey, F3 → Keys cuts a housekey item for Config.MetaKeyCreatePrice ($500). Whoever carries it can open the door, and the key can be traded like any item. Using it at the door enters the house; using it elsewhere names the house and sets a waypoint. Deleting a key from the list makes it useless.
Shell and IPL houses lock from F3 or the Door Menu ([E] at the inside exit). An unlocked house lets anyone in. Every house starts locked after a restart.
MLO doors lock one by one with [E], or all together from F3.
A visitor presses [G] Ring Doorbell. Players inside hear it and invite them in from the Door Menu, which also turns the lights on and off and opens the door camera.
What F3 shows depends on who opens it: the owner sees everything, a tenant sees bills and rent, a key holder sees bills. Each button can be hidden in Config.ManagementButtons.
Section | What it holds |
|---|---|
Fast actions | Place the wardrobe, storage, phone charger and delivery point (walk there, press G); play music; open Decorate. |
Property | Rent out, sell, transfer, leave. |
Security | Lock or unlock, repair a forced door, change the IPL colour theme. |
Keys · Key Management | Physical keys and key holders. |
Bills · Rentals | Pay utility bills and rent. |
Lights · Cameras | Name, colour, dim and switch each placed light; watch the security cameras. |
Deliveries · Dancers | Order food from |
Garbage | Your garbage bag, and placing the dump spot. |
Upgrades | Buy the house upgrades, paid from the bank. |
Settings | Key permissions, the doorbell sound and the assistant's greetings. |
Upgrade | Price | Unlocks |
|---|---|---|
Security Alarm | $10,000 | A siren and a police alert when the house is broken into. |
Security Cameras | $35,000 | Placeable cameras, a wall tablet, and a modern door camera. |
Motion Sensor | $45,000 | Alerts dispatch when someone without a key or invite walks in. |
Vault Lock | $50,000 | A 4-digit code on any stash ([G] at the stash, up to |
Furniture Upgrade | $60,000 | Raises the furniture limit from 50 to 150 pieces ( |
Custom Doorbell | $15,000 | A choice of doorbell sounds. |
Aura Voice | $30,000 | Voice commands for the house. Not an AI. |
Wall Art · Custom Rug | $25,000 · $20,000 | Frames and rugs that show any image from a link. |
Restful Beds | $25,000 | Lying in a bed slowly heals. |
Companion Animal | $30,000 | A pet bed in the garden and a pet (not in apartments). |
Prices, titles and descriptions are edited in Config.Upgrades. Keep each name as it is: the script looks them up.
F3 → Decorate. The HUD hides, a free camera starts where you stand, and the furniture catalogue opens in three tabs: Dynamic (click a room — kitchen, bathroom, bedroom, living room, garden — then a category), Objects (search) and Stash (the furniture you already own). By default only the owner decorates (Config.DecorateOnlyAccessForOwner), and a house with unpaid bills cannot be decorated.
Key | Does |
|---|---|
W A S D · Q / E · mouse | Fly the camera. |
F3 | Free camera on or off. |
F5 | Show or hide the cursor. |
F6 | Hide the interface for a clear view. |
G | Drop the piece onto the floor. |
K | Switch the gizmo between moving and rotating. |
Q | World or local axes. |
M | Switch between the 3D gizmo and mouse mode (hold left click to drag along surfaces, Z / X to rotate). |
F | Orbit the camera around the selected piece. |
Enter | Buy the piece being previewed. |
Esc | Leave decorate mode. |
The browser-side keys are set in Config.DecorateKeybinds. Furniture is paid in Config.MoneyType and sells back for Config.SellObjectCommision (30%). Owned pieces can be put away into the Stash tab and brought back later. Moving a piece you own is only kept when you press Save.
Furniture | Interaction |
|---|---|
Cabinets, fridges, dressers (about 100) | [E] Open stash — each with its own storage. |
Wardrobes | [E] Open wardrobe. |
Beds | [E] Lie down, Space to get up. Heals with Restful Beds. |
Cookers | [E] Cooking — recipes from |
Sinks, toilets, bathtubs, showers | Animations and water effects. |
Lights | Real light, coloured and dimmed from F3, while the house lights are on. |
Wall art · Rugs | Paste an image link to change the picture. Up to 6 frames and 3 rugs per house. |
Air conditioner · Fireplaces | [E] Turn on/off — they change the indoor temperature. |
Telescope | [E] Look through it, scroll to zoom, Backspace to leave. |
Cleaning robot · Litter tray | See Cleaning and Pets below. |
Doors | Working doors. Need |
Append an item to any category of Config.Furniture in config/furniture.lua, with a model your server streams:
[25] = {
['object'] = 'my_custom_sofa',
['label'] = 'Velvet Sofa',
['price'] = 1500,
['description'] = 'Soft and very green.',
['img'] = 'https://example.com/velvet-sofa.webp',
['colorlabel'] = 'Green',
['colors'] = {},
-- optional: type = 'stash', offset = { x = 0.0, y = 0.0, z = 0.0 }, stash = { maxweight = 50000, slots = 10 },
},Admins can do the same in game with /housingfurniture: the furniture creator adds, edits and photographs catalogue items (it needs your FiveManage token), and saves them to the database. Use an existing category. Other resources can add items with the server export AddFurniture.
Creator → Furniture Shops places a store on the map with the categories it sells. A player who owns a house walks in with [E], picks the furniture and the house, and pays. After Config.IkeaDeliveryDelayMinutes the doorbell rings and a delivery worker waits at the house's delivery point: [E] Collect delivery puts the furniture in the Decorate stash. Set Config.EnableF3Shop = false to make the shops the only way to buy furniture.
Place them from F3 (walk to the spot, press G). The stash opens your inventory's storage: its size comes from the furniture, the IPL, the shell, or Config.DefaultStashData, in that order. Config.StashNeedsKey = true limits it to key holders. The wardrobe opens your clothing script's outfits. With the Vault upgrade, the owner presses G at any stash to put a code on it.
Lights switch from the Door Menu, Aura Voice or the phone app. Every hour they are on is billed as electricity. In shells and IPLs, lights off or bills unpaid means a dark house.
F3 → Music plays the tracks in Config.HouseMusicTracks (mp3 or ogg files in qs-housing/music/, not links) for everyone inside a shell or IPL. It needs mx-surround, qs-3dsound or xsound.
With the Aura Voice upgrade, hold N inside the house and say a command: lights on or off, order food, order a dancer, start or stop the robot, lock the door, open decorate, set the wardrobe or storage spot. Speech is recognised in the game itself — the player only needs a microphone. The key, name and language are in config/assistant.lua; change N if it clashes with your voice chat.
From F3 or the Door Menu, order from the restaurants in Config.Deliveries and collect the items when ready, or hire a private dancer from Config.Dancers. Each has its own switch: Config.DeliveriesEnabled and Config.DancersEnabled.
With qs-smartphone, F3 → Charge places a spot where the phone charges.
While someone is inside, dust and garbage appear every Config.JunkObjectTime (10 minutes), up to Config.MaxJunkPerHouse (10). [E] Clean sweeps a piece into your garbage bag, which holds Config.MaxGarbageCarry (10). Take the bag from F3 → Garbage, carry it to the house's bin and press [E] Dump garbage. A house without a bin places one from the same section.
The cleaning robot (Living → Cleaning) does it for you: [E] Start Robot at its dock, and it roams, picks up junk and returns on its own. Decorate cannot open while it is out. Everything is switched off with Config.Cleaning = false.
Inside a house a thermometer shows the temperature: baseTemp (21 °C), minus 7 for each running air conditioner, plus 7 for each lit fireplace. Below 14 °C or above 28 °C the player is warned, and below 8 °C or above 34 °C they start to stagger. Every value is in Config.Climate. Turn on fireplaceFuel to make fireplaces burn wood items for a set number of minutes.
Buy the Companion Animal upgrade and place the pet bed in the garden, inside the property. [E] Pet menu at the bed buys, renames, feeds and removes the pet. Seven dog breeds, a cat, a rabbit and a pig are in config/pets.lua.
Action | How |
|---|---|
Pet it | [E] while it faces you. Happiness and XP. |
Feed it | Use |
Play fetch | Dogs, outside: [G], right click to aim, left click to throw. |
Clean up | [E] on its mess. Cats and rabbits use a placed litter tray. |
Hunger, thirst and happiness drop every 5 minutes, even while the owner is offline. A pet levels up to 10 as it earns XP. If hunger or thirst stays at zero for an hour, it dies, and must be buried ([E]) before another can be adopted.
An agency is a player-run business, separate from framework jobs. Creator → Agencies creates one: a name, a colour, an owner (who becomes boss), its zone, and the boss menu, stash and wardrobe points.
Boss menu tab | What it is |
|---|---|
Dashboard | The agency at a glance. |
Members · Ranks | Hire nearby players, set ranks, and build ranks from permissions (stash, wardrobe, members, listings, properties, finance, withdraw...). |
Listings | Houses offered to the agency: accept, price, describe, photograph, then sell or rent remotely. |
Finance | Balance, revenue, expenses, deposits and withdrawals. |
F3 → Transfer to Agency, with an asking price of at least Config.Agency.minListPrice.
A member with the right permissions accepts the listing. The agency balance pays the owner and the agency now owns the house.
From Listings, open the property remotely and list it for sale or rent. It shows in the browser under the agency's name, and the money goes to the agency.
Members open the boss menu at its point or with /agencymenu. Everything is in config/agency.lua; enabled = false turns agencies off.
Robbery | Police raid | |
|---|---|---|
Item |
|
|
Switch |
|
|
Rule | The owner must be online ( | Police can also remove illegal furniture ( |
Both use a skill check at the door. Once open, anyone can walk in, [H] Steal Furniture picks up a piece, and [H] at the exit carries it out. Stolen furniture sells at the fence (Config.Robbery) for 10% of its price. The Alarm upgrade sounds a siren and alerts the police. The owner repairs the door from F3 → Fix Door.
House browser — every house for sale or rent with photos and filters, and Set Waypoint. Opened at the Real Estate office NPC (Config.RealeStateNPC) or with /housebrowser.
Blips — coloured by state in Config.Blip: for sale, for rent, yours, rented. Config.ShowClosestBlips keeps only the nearest ones, and Config.DisableAllHouseBlips hides them.
Phone app — with qs-smartphone, players browse, buy, rent, pay bills, switch lights and order deliveries from the phone, within Config.PhoneHousing.purchaseMaxDistance (48 m) for purchases.