search
StoreDiscord

wrenchInstallation

This guide covers the complete installation process of the RTX Housing System.

RTX Housing is a standalone resource and can be used with any framework. Native integrations are available for ESX, QBCore, and compatible frameworks.

hashtag
Before You Start

  • Ensure your server artifacts are up to date

  • You have database access (phpMyAdmin or HeidiSQL)

  • You downloaded the asset from the CFX Asset Portal

hashtag
Required Database Dependency

RTX Housing requires one database resource:

  • ✅ Recommended: oxmysql

  • ⚠️ Alternative: mysql-async

We strongly recommend oxmysql for performance and long-term support.

GitHub: https://github.com/overextended/oxmysqlarrow-up-right

hashtag
Resource Setup

1

hashtag
Download

Download RTX Housing from: https://portal.cfx.re/assets/granted-assetsarrow-up-right

2

hashtag
Place resources into your server

Put the resources into your server resources folder:

3

hashtag
Optional resources

  • rtx_housing_shells – required if you want to use RTX shells

  • rtx_krapea_mlo – required if you want to use Krapea MLO

4

hashtag
Add to server.cfg

Add the following (optional resources must be started before rtx_housing):

hashtag
Database Setup

SQL files are located in:

You can either import them manually from the files, or copy them directly from below.

chevron-rightMain Tables (SQL_INSERT.sql) – REQUIREDhashtag
chevron-rightExample Properties (Example_Properties.sql) – OPTIONALhashtag

hashtag
Inventory Items

Item files are located in:

You can import them from the files or copy them directly below.

chevron-rightESX Items (ESX-ITEMS.sql)hashtag
chevron-rightQBCore Items (QBCORE-ITEMS.lua)hashtag
chevron-rightOX Inventory Items (OX-ITEMS.lua)hashtag

hashtag
Framework Selection

Open config.lua and select the framework mode:

hashtag
ESX

Select esx if your server uses ESX / es_extended.

hashtag
QBCore

Select qbcore if your server uses QBCore.

hashtag
Qbox

Qbox is fully supported. Select qbcore — QBCore and Qbox are compatible by design.

hashtag
Custom frameworks (Standalone mode)

If you are using any other framework (custom / unknown / modified core), select:

In standalone mode, RTX Housing will not assume any specific framework API. You simply need to adjust the bridge functions in:

  • client/other.lua

  • server/other.lua

Typical things you may want to adapt:

  • player identifiers / character identifiers

  • money add/remove/check (bank/cash)

  • notifications

  • inventory add/remove/check

  • jobs / permissions checks

circle-info

The ESX and QBCore implementations are already in other.lua files — you can use them as templates and replace the calls with your own framework functions.

hashtag
Configuration

After installation, we strongly recommend reviewing and configuring config.lua.

The configuration file contains:

  • housing behavior

  • economy settings

  • storage & inventory options

  • permissions

  • integrations

  • feature toggles

RTX Housing is highly configurable — adjust it to match your server’s needs.

hashtag
Final Checklist

hashtag
Support

Need help with installation or configuration? Join our Discord: https://discord.gg/rtxdev

PreviousOverviewNextCompatibility

Last updated