> For the complete documentation index, see [llms.txt](https://cylexdev.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://cylexdev.gitbook.io/docs/apex-series/cylex-apex-housing/introduction.md). # Introduction Cylex Apex Housing is a housing system for FiveM. Shell, MLO, IPL and apartment properties with buying, renting, decorating, keys, bills, upgrades and police raids for QBCore, Qbox and ESX.
Cylex Apex Housing
Cylex Apex Housing is the housing system for your FiveM server.\ Realtors and admins make properties in the game with the property creator. Players buy or rent them, furnish them, give keys to friends, pay the bills and add security upgrades.\ It runs on QBCore, Qbox or ESX, finds your framework, inventory and other scripts by itself, and leaves every settings, catalog and language file open to edit. ### Key Features * Four property types: Shell (an interior box that appears when someone goes in), MLO (a map interior you walk into), IPL (a built-in GTA interior) and Apartment (one building with many units). * A property creator in the game. Pick the type and the interior, place the door, the property zone, the garage and the for-sale sign, and save. No coordinates to copy. * A real estate board, for-sale signs that show the photo and price, and an inspect panel at every door. * Buying, renting for 7 to 28 days, lease extensions, and selling or renting out your own property to other players. * Decorating inside and in the garden with a move, rotate and scale tool. More than 1,000 GTA props are ready to use. Furniture packs are added by dropping in a file. * Keys with 12 separate permissions, handed to a player who stands next to you. * Utility bills for water, power and internet. Overdue bills cut the services off. * Upgrades: security cameras with a live view, a motion sensor, a doorbell, a robot vacuum, your own lights, extra storage and wardrobe points, and interior styles for IPL properties. * A garage, storage and wardrobe in every property, police raids, agent commissions and Discord logs. * Islands and buildings placed on the map from the game. * A player who quits or crashes inside a property comes back at its door. * English and Turkish. ### Installation Steps {% content-ref url="/pages/NwFRDCod1JtXhap8KqY5" %} [Installation & Configuration](/docs/apex-series/cylex-apex-housing/installation-and-configuration.md) {% endcontent-ref %} {% content-ref url="/pages/QgtOGpULj1IBFFAN6NA3" %} [Configuration](/docs/apex-series/cylex-apex-housing/installation-and-configuration/configuration.md) {% endcontent-ref %} {% content-ref url="/pages/kUZb7nLeal3Ims8gpunj" %} [Shells, Furniture and World Props](/docs/apex-series/cylex-apex-housing/installation-and-configuration/shells-furniture-and-world-props.md) {% endcontent-ref %} {% content-ref url="/pages/B4bB4sqCdWbn6we4lWhi" %} [Creating Properties](/docs/apex-series/cylex-apex-housing/features/creating-properties.md) {% endcontent-ref %} ### Dependencies | Dependency | Required | Notes | | ------------------------------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ox\_lib | **Yes** | Callbacks, key bindings and language files. | | QBCore, Qbox **or** ESX | **Yes** | `qb-core`, `qbx_core` or `es_extended`. Found by itself. Qbox runs through its QBCore compatibility. | | oxmysql | **Yes** | Database connector. mysql-async and ghmattimysql also work. | | MariaDB database | **Yes** | When the script starts, it adds new columns with a command that MySQL does not have. Most FiveM hosts and XAMPP use MariaDB. | | Inventory | For storage | ox\_inventory, qb-inventory, qs-inventory, ps-inventory or origen\_inventory. Found by itself. | | Clothing script | For wardrobes | Cylex Apex Clothing, illenium-appearance, fivem-appearance, qb-clothing, esx\_skin, bl\_appearance, ped-appearance or np-appearance. Found by itself. | | ox\_target or qb-target | Optional | Only if players should use the target eye instead of markers. | | bob74\_ipl | Optional | Needed by 7 IPL interiors: the three Eclipse Towers penthouses and the four office floors. | | Shell packs | For Shell properties | Shells come from shell packs you stream yourself. Ready lists for several packs are included. See [Shells, Furniture and World Props](/docs/apex-series/cylex-apex-housing/installation-and-configuration/shells-furniture-and-world-props.md). | | cylex\_houseprops | Optional | Comes with the script. Houses, a garage, apartment blocks and islands to place on the map. | | Weather, fuel and vehicle key scripts | Optional | Found by itself when they run. See [Configuration](/docs/apex-series/cylex-apex-housing/installation-and-configuration/configuration.md). | {% hint style="warning" %} Your server's license key (the `sv_licenseKey` line in server.cfg) must belong to the same Cfx.re account that bought the script. Otherwise the script does not start. {% endhint %} ### What You Can Edit All settings, catalogs and texts are open. The escrow protection only covers the internal client and server logic. | File / Folder | Editable? | | ------------------------------------------------------------ | -------------------------------------------------------------- | | `config/config.lua` | Yes — the main settings | | `config/interaction.lua` | Yes — markers, text prompts and target scripts | | `config/upgrades.lua`, `config/raid.lua`, `config/doors.lua` | Yes — upgrades, police raids, MLO door models | | `config/interiors.lua` | Yes — IPL interiors and their styles | | `config/shells.lua`, `config/shells/*.lua` | Yes — shell lists | | `config/furniture.lua`, `config/furniture/*.lua` | Yes — furniture catalog | | `config/exterior.lua`, `config/exterior/*.lua` | Yes — islands and buildings | | `config/sv_config.lua` | Yes — Discord webhooks. Stays on the server. | | `locales/*.json` | Yes — every text players see | | `ui/sign.html`, `ui/sign_dark.html` | Yes — the page drawn on the for-sale sign | | `client/`, `server/`, `core/`, `shared/` | No — escrow-protected | | `html/` | No — the built menu screens. Changes are lost on every update. | ### Support Store: \ Discord: