> For the complete documentation index, see [llms.txt](https://atenea.gitbook.io/atenea-store-r/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://atenea.gitbook.io/atenea-store-r/helpful/housing-setup.md).

# Housing Setup

## 🏘️ Housing Compatibility:

| Resource                 | Supported                  |
| ------------------------ | -------------------------- |
| Qb-Housing               | ✅ **Supported**            |
| Nolag-Properties         | ✅ **Supported**            |
| Loaf Housing             | ✅ **Supported**            |
| Ps-Housing               | ✅ **Supported**            |
| Origen Housing           | ✅ **Supported**            |
| SN Properties v2         | ✅ **Officially Supported** |
| BCS Housing V3           | ✅ **Officially Supported** |
| VMS Housing              | ✅ **Officially Supported** |
| RX Housing               | ✅ **Officially Supported** |
| ESX Properties           | ✅ **Supported**            |
| RTX-Housing              | ✅ **Officially Supported** |
| KuzQuality Shell Creator | ✅ **Officially Supported** |
| KuzQuality Prop Placer   | ✅ **Officially Supported** |
| Rcore Housing            | ✅ **Officially Supported** |

***

## 🛠️ Installation:

{% hint style="danger" %}

#### <mark style="color:$danger;">Not sure how to configure it?</mark>

<mark style="color:$danger;">No worries - we've prepared short installation steps for each compatible housing script below. 💬</mark> <mark style="color:$danger;"></mark><mark style="color:$danger;">**Click on your script to view the tutorial.**</mark>
{% endhint %}

{% tabs %}
{% tab title="Qb-Housing" %}
Where to add furniture:

You need to register the props and furniture items inside the shared configuration of your housing script.

#### Steps:

1. Open the file **`qb-housing/shared/furniture.lua`** (or `config.lua` depending on your version).
2. Locate the main furniture categories table (e.g., `Config.Furniture`).
3. Append our new furniture items, model names (props), and prices to your preferred categories.
   {% endtab %}

{% tab title="Nolag-Properties" %}
Where to add furniture:

This configuration goes inside the premium furniture and asset management files.

#### Steps:

1. Open the file **`nolag-properties/config/furniture.lua`** (or `config_furniture.lua`).
2. Find the object list where models are registered for placement.
3. Paste our custom prop names and assign them a category and price so players can purchase them in-game.
   {% endtab %}

{% tab title="Loaf Housing" %}
Where to add furniture:

You must register the furniture assets inside the dedicated furniture sub-module.

#### Steps:

1. Navigate to **`loaf_housing/shared/furniture.lua`** or open **`loaf_housing/config.lua`**.
2. Look for the furniture objects array (`Config.FurnitureObjects`).
3. Add our custom models to the list so the script allows them to spawn and save correctly within properties.
   {% endtab %}

{% tab title="Ps-Housing" %}
Where to add furniture:

Since this script manages furniture through shared configurations, you will need to add them to the object registry.

#### Steps:

1. Go to the file **`ps-housing/shared/furniture.lua`** (or check `config.lua`).
2. Locate the categories list where players browse objects to buy.
3. Register our new props under your chosen furniture sections.
   {% endtab %}

{% tab title="Origen Housing" %}
Where to add furniture:

This must be added within the specific shop and furniture configuration structure of your script.

#### Steps:

1. Navigate to **`origen_housing/config/furniture.lua`** (or open the main furniture data file).
2. Locate the items or objects dictionary where props are listed.
3. Insert our custom prop models and prices into the decoration menu configuration.
   {% endtab %}
   {% endtabs %}

{% tabs %}
{% tab title="SN Properties v2" %}
Where to add furniture:

The furniture parameters are located inside the customization files.

#### Steps:

1. Go to **`sn-properties/config/furniture.lua`** or check the shared object settings.
2. Find the interaction prop list or the decoration shop array.
3. Append our new model hashes/names to make them available for buying.
   {% endtab %}

{% tab title="BCS Housing V3" %}
Where to add furniture:

This setup requires adding the models to the custom furniture store or object builder list.

#### Steps:

1. Open the file **`bcs_housing/shared/furniture.lua`** or look inside the configuration folder.
2. Search for the furniture item list configuration.
3. Apply the new prop models to ensure they load properly when a house instance is populated.
   {% endtab %}

{% tab title="VMS Housing" %}
Where to add furniture:

This script manages its furniture items and decoration catalog directly through the database.

#### Steps:

1. Open your database manager (such as HeidiSQL or phpMyAdmin).
2. Locate the **SQL table** dedicated to `vms_housing` furniture/items (usually `vms_housing_furniture` or similar).
3. Execute or insert our custom SQL queries containing the new prop names, categories, and pricing to display them in the shop.
   {% endtab %}

{% tab title="RX Housing" %}
Where to add furniture:

You must add this inside the customizable furniture configuration file.

#### Steps:

1. Open **`rx_housing/config/furniture.lua`** or check the editable object files.
2. Locate the section handling custom furniture layouts, props, and item items.
3. Add our prop names to the list so they can be spawned and saved permanently by players.
   {% endtab %}

{% tab title="ESX Properties" %}
Where to add furniture:

This setup is applied within the furniture or object list files of the script.

#### Steps:

1. Open **`esx_properties/config_furniture.lua`** (or the file managing interior assets).
2. Find the array that handles inside-property decoration objects.
3. Paste our new prop names into the list to enable buying and placing them.
   {% endtab %}
   {% endtabs %}

{% tabs %}
{% tab title="RTX-Housing" %}
Where to add furniture:

This configuration belongs inside the customizable furniture files of your script.

#### Steps:

1. Navigate to **`rtx-housing/config/furniture.lua`** or check the editable objects file.
2. Look for the furniture shop lists or room decoration objects.
3. Insert our specific prop names to enable full item placement within properties.
   {% endtab %}

{% tab title="KuzQuality | Shell Creator" %}
Where to add furniture:

The allowed props and settings are registered inside the script's main settings module.

#### Steps:

1. Go to the directory **`kq_shellcreator/`** and open the **`settings.lua`** file.
2. Find the section where furniture lists or placeable prop assets are defined.
3. Register our prop models inside the allowed arrays so they function perfectly inside your shells.
   {% endtab %}

{% tab title="KuzQuality | Prop Placer" %}
Where to add furniture:

All placement parameters and object filters are configured in the main settings file.

#### Steps:

1. Navigate to **`kq_propplacer/`** and open the **`settings.lua`** file.
2. Locate the custom categories or allowed objects list.
3. Add our custom props to the configuration arrays to enable placement within your active server zones.
   {% endtab %}

{% tab title="Rcore Housing" %}
Where to add furniture:

All placement parameters and object filters are configured in the main settings file.

#### Steps:

1. Use the /housing inside the server.
2. Select the All Furniture section and click +Add New
3. Copy the furniture list into the menu, and then click add.
4. The menu will appear where you can take the photo and configure the prop.
   {% endtab %}
   {% endtabs %}

## 🖼️ Housing Images Installation:

{% hint style="danger" %}

#### <mark style="color:$danger;">Missing furniture images in your housing menus?</mark>

<mark style="color:$danger;">No worries - we've prepared short steps showing exactly where to drop the furniture images for each housing script. 💬</mark> <mark style="color:$danger;"></mark><mark style="color:$danger;">**Click on your script to view the tutorial.**</mark>
{% endhint %}

{% tabs %}
{% tab title="Qb-Housing" %}
Where to add images:

You need to drop the furniture images inside the UI assets folder of the housing script.

#### Steps:

1. Navigate to **`qb-housing/html/images/`** (or `html/img/` depending on your version).
2. Paste all the furniture `.png` images provided in our package.
3. Ensure the image filenames match exactly with the model names registered in your `furniture.lua`.
   {% endtab %}

{% tab title="Nolag-Properties" %}
Where to add images:

This goes inside the NUI asset directory of your premium housing resource.

#### Steps:

1. Open your **`nolag-properties`** folder.
2. Navigate to **`html/img/furniture/`** (or the main assets folder inside `html/`).
3. Drop our custom furniture images there so the decoration menu can render them.
   {% endtab %}

{% tab title="Loaf Housing" %}
Where to add images:

You must place the assets inside the web build directory of the script.

#### Steps:

1. Go to **`loaf_housing/html/img/`** or check their dedicated UI assets path.
2. Paste the furniture images here.
3. Restart the resource to clear the NUI cache and display the new icons.
   {% endtab %}

{% tab title="Ps-Housing" %}
Where to add images:

This setup is handled inside the UI folder of the UI interface.

#### Steps:

1. Navigate to **`ps-housing/html/images/`** (or `web/build/images/`).
2. Drop all our furniture item images inside this directory.
   {% endtab %}

{% tab title="Origen Housing" %}
Where to add images:

This must be added within the custom UI design folder of the script.

#### Steps:

1. Go to **`origen_housing/html/img/`** or the specific decoration subfolder inside it.
2. Paste the image assets here so they show up in the Origen radial/decoration menu.
   {% endtab %}
   {% endtabs %}

{% tabs %}
{% tab title="SN Properties v2" %}
Where to add images:

The interface images are located inside the custom html asset path.

#### Steps:

1. Open **`sn-lib/images`**.
2. Append our new image files matching your configured prop names.
   {% endtab %}

{% tab title="BCS Housing V3" %}
Where to add images:

This requires placing the images in the build directory of the UI.

#### Steps:

1. Access **`bcs_housing/html/images/`** or their UI public assets folder.
2. Drop the custom prop images here.
   {% endtab %}

{% tab title="VMS Housing" %}
Where to add images:

Even though the config is in SQL, the NUI menu reads images from its local HTML folder.

#### Steps:

1. Navigate to **`vms_housing/html/images/`** or **`html/img/`**.
2. Place all the custom furniture `.webp` files inside this folder so the shop catalog can load them properly.
   {% endtab %}

{% tab title="RX Housing" %}
Where to add images:

You must add this inside the NUI images directory.

#### Steps:

1. Open **`rx_housing/html/img/`** or the path specified by the creator for furniture items.
2. Drop our prop images to let players preview them before placing.
   {% endtab %}

{% tab title="ESX Properties" %}
Where to add images:

This setup is applied within the UI directory of the script.

#### Steps:

1. Open **`esx_properties/html/img/`**.
2. Paste the new image files inside.
   {% endtab %}
   {% endtabs %}

{% tabs %}
{% tab title="RTX-Housing" %}
Where to add images:

This belongs inside the customizable UI folders of your script.

#### Steps:

1. Go to **`rtx-housing/html/img/`** or check their documentation for custom UI assets.
2. Place the specific images here.
   {% endtab %}

{% tab title="KuzQuality | Shell Creator" %}
Where to add images:

All interface and menu images are handled within their UI settings folder.

#### Steps:

1. Open **`kq_shellcreator/html/img/`** or check the asset paths inside **`settings.lua`**.
2. Add the furniture/prop preview images into the designated UI images folder.
   {% endtab %}

{% tab title="KuzQuality | Prop Placer" %}
Where to add images:

The menu icons and preview images are loaded from the main UI directory.

#### Steps:

1. Navigate to **`kq_propplacer/html/img/`** or check their **`settings.lua`** asset config.
2. Drop our custom images here to enable flawless previews in your active placement menus.
   {% endtab %}

{% tab title="Rcore Housing" %}

Where to add images:

The menu icons and preview images are loaded from the main UI directory.

#### Steps:

1. Once the menu with the prop appears, you can take the picture and position it as you like.
   {% endtab %}
   {% endtabs %}

## 💬 Looking for another script?

If your housing system is not listed above, join our Discord server to request custom support or integration:

[![Discord](https://img.shields.io/badge/Discord-Get_Support-5865F2?style=for-the-badge\&logo=discord\&logoColor=white)](https://discord.gg/mam8Nmg49d)