> For the complete documentation index, see [llms.txt](https://tk-scripts.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tk-scripts.gitbook.io/docs/tk_housing.md).

# tk\_housing

A housing, furnishing and shell-building system for FiveM servers running ESX, QBCore or Qbox.

Players buy, rent or finance houses and apartments or check into a motel, then furnish the house, garage and yard. Real-estate agencies run sales and commission, and admins or agents add properties in game with no restart. Building walls and floors works in custom shells, not MLOs.

[Housing System V3 & Shell Creator product page](https://tkscripts.com/scripts/housing) | [Watch the showcase on YouTube](https://www.youtube.com/watch?v=QDd5UN36cxs) | [Install Housing](/docs/tk_housing/setup.md)

{% embed url="<https://www.youtube.com/watch?v=QDd5UN36cxs>" %}
Housing showcase (20 min 48 s).
{% endembed %}

## Features

### Property discovery and ownership

* Grid, list and map browsing with filters and GPS
* Preview a property's interior before buying
* Purchase, rental and mortgages
* Contracts, resale and transfers
* Motels and apartments, plus starter homes when enabled
* Player, job or business ownership

### Access and security

* Codes and doorbells, plus key items when keys are enabled
* Per-player and per-job permissions
* Lock changes invalidate keys
* Reinforced locks and alarms
* Remote door camera
* Lockpicking, police breach and lockdown
* Three lock tiers and four alarm coverage tiers
* Dispatch alerts through tk\_dispatch, cd\_dispatch or your own

### Furnishing and construction

* 3D furniture previews
* Gizmo and crosshair placement with snapping
* Colour variants; furniture storage and resale
* House, garage and yard furnishing
* Structural construction in custom shells only
* Styles and tints for supported MLOs
* More than 3800 furniture items in 25 categories

### Home activities

* Adjustable lights and switches
* Spatial music from radio, YouTube, SoundCloud and Spotify links, and TV everyone sees in sync
* Picture frames with a crop editor and in-game photos
* Cooking, bathing, seating and exercise
* Stashes, wardrobes and mirrors
* Assistant tablet with 3 personas and voice lines (game build 3717 or newer)
* Mirrors open your clothing, barber or tattoo menu

### Running the home

* Saved garage vehicle condition
* Service bills and payment history
* Configurable lockout and repossession
* Flat power bill, or per-appliance watts with grid, local or off-grid supply
* Generators and wiring, plus batteries in the per-appliance power mode
* Weather-linked heating and cooling, off by default

### Agency and creator tools

* Agency funds, employees and commissions
* In-game property and admin editing
* Shell building with undo, redo and alignment
* Shell walkthroughs and import and export
* MLO and IPL access-point editor
* English, Finnish and French included, translatable
* Upgrading from V2 keeps every player's property

## Requirements

| Item      | Supported                                                                   |
| --------- | --------------------------------------------------------------------------- |
| Framework | ESX, QBCore, Qbox                                                           |
| Database  | oxmysql or mysql-async                                                      |
| Inventory | ox\_inventory, qb-inventory, qs-inventory, or the ESX default inventory     |
| Target    | ox\_target, qb-target (optional)                                            |
| Shells    | K4MB1 Starter Shells by default, plus `tk_housing_props` from your purchase |
| Languages | English, Finnish, French                                                    |

Property photos need a [Fivemanage token](/docs/tk_housing/setup.md#set-up-property-photos), and shell creator doors need one `setr` line in `server.cfg`. Every dependency and its start order: [Housing installation](/docs/tk_housing/setup.md#requirements).

## Start here

* [Install Housing](/docs/tk_housing/setup.md)
* [Update without losing your config](/docs/tk_housing/setup.md#update-without-losing-your-config)
* [Upgrade from Housing V2](/docs/tk_housing/setup.md#upgrade-from-housing-v2)
* [Set up properties, furnishing and agencies](/docs/tk_housing/config.md)
* [Connect other resources with the server exports](/docs/tk_housing/exports/server.md)
* [Fix common problems](/docs/tk_housing/common-questions-and-problems.md)

Support: open a ticket in the [TK Scripts Discord](https://discord.gg/YndnF9tkqu).