Documentation
Installation guide — please follow each step carefully and exactly as described to ensure the script works correctly on your server. Skipping or modifying steps may cause the system to not function properly, so follow it step by step.
To download the assets needed for this script, you must access the official Cfx.re portal, where all assets purchased through Tebex are managed.
Open the Cfx.re granted assets page: https://portal.cfx.re/assets/granted-assets.
This page contains all assets linked to your Cfx.re purchases.
Sign in using the same Cfx.re account you used when purchasing the asset.
If you use a different account, the assets will not appear.
In the granted assets list, locate and download:
Apartments
These two packages are required to install the full housing system.
These files include the models, materials, and visual resources required for the proper operation of the housing system.
This script requires some mandatory dependencies to function correctly. Make sure to download and extract them inside your server’s main directory, keeping their original folder structure intact.
This script may cause conflicts or errors if you use other dealership systems on your server. Common examples include qb-apartments, qbx_property or other similar dealership scripts. It’s strongly recommended to remove them completely before installation to prevent compatibility or functionality issues.
This script includes an essential database required for its operation.You must import it before starting your server, preferably using HeidiSQL or any other manager compatible with MariaDB/MySQL.
DROP TABLE IF EXISTS `player_apartments`;
CREATE TABLE `player_apartments` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`name` VARCHAR(255) NULL DEFAULT NULL COLLATE 'latin1_swedish_ci',
`type` VARCHAR(255) NULL DEFAULT NULL COLLATE 'latin1_swedish_ci',
`label` VARCHAR(255) NULL DEFAULT NULL COLLATE 'latin1_swedish_ci',
`citizenid` VARCHAR(255) NULL DEFAULT NULL COLLATE 'latin1_swedish_ci',
`stash` TEXT NULL DEFAULT NULL COLLATE 'latin1_swedish_ci',
`wardrobe` TEXT NULL DEFAULT NULL COLLATE 'latin1_swedish_ci',
`charge` TEXT NULL DEFAULT NULL COLLATE 'latin1_swedish_ci',
PRIMARY KEY (`id`) USING BTREE,
UNIQUE INDEX `name` (`name`) USING BTREE,
INDEX `citizenid` (`citizenid`) USING BTREE
)
COLLATE='latin1_swedish_ci'
ENGINE=InnoDB
AUTO_INCREMENT=4148
;
ALTER TABLE player_apartments ADD COLUMN IF NOT EXISTS `vaultCodes` LONGTEXT NULL DEFAULT NULL;
CREATE TABLE `apartment_decorations` (
`id` INT(11) UNSIGNED NOT NULL AUTO_INCREMENT,
`apartmentId` VARCHAR(50) NULL DEFAULT NULL COLLATE 'utf8mb3_general_ci',
`creator` VARCHAR(70) NOT NULL DEFAULT '0' COLLATE 'utf8mb3_general_ci',
`modelName` VARCHAR(50) NOT NULL DEFAULT '0' COLLATE 'utf8mb3_general_ci',
`coords` TEXT NULL DEFAULT NULL COLLATE 'utf8mb3_general_ci',
`rotation` TEXT NOT NULL DEFAULT '' COLLATE 'utf8mb3_general_ci',
`inStash` TINYINT(1) NOT NULL DEFAULT '0',
`created` TIMESTAMP NULL DEFAULT NULL,
PRIMARY KEY (`id`) USING BTREE,
INDEX `id` (`id`, `apartmentId`) USING BTREE
)
COLLATE='utf8mb3_general_ci'
ENGINE=InnoDB
AUTO_INCREMENT=7
;
CREATE TABLE IF NOT EXISTS `qs_apartment_furnitures` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`creator` VARCHAR(80) NULL DEFAULT NULL,
`category_key` VARCHAR(100) NOT NULL,
`object` VARCHAR(200) NOT NULL,
`label` VARCHAR(255) NOT NULL,
`description` TEXT NULL DEFAULT NULL,
`price` INT(11) NOT NULL DEFAULT '0',
`img` TEXT NULL DEFAULT NULL,
`colorlabel` VARCHAR(255) NULL DEFAULT NULL,
`type` VARCHAR(50) NULL DEFAULT NULL,
`stash` LONGTEXT NULL DEFAULT NULL,
`offset` LONGTEXT NULL DEFAULT NULL,
`colors` LONGTEXT NULL DEFAULT NULL,
PRIMARY KEY (`id`) USING BTREE,
INDEX `creator` (`creator`) USING BTREE,
INDEX `category_key` (`category_key`) USING BTREE
)COLLATE='utf8mb4_unicode_ci' ENGINE=InnoDB;
CREATE TABLE IF NOT EXISTS `qs_apartment_junk` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`house` VARCHAR(255) NOT NULL,
`model` VARCHAR(255) NOT NULL,
`coords` LONGTEXT NULL DEFAULT NULL,
`created_at` TIMESTAMP NULL DEFAULT CURRENT_TIMESTAMP(),
PRIMARY KEY (`id`) USING BTREE,
INDEX `idx_house` (`house`) USING BTREE
)
COLLATE='utf8mb4_unicode_ci'
ENGINE=InnoDB
AUTO_INCREMENT=1;Quasar Apartments can automatically assign a starter apartment to players when they join the server. This feature works through the integration with qs-multicharacter, which handles the character spawn and initial setup process.
Press T to open the in-game chat.
Type the following command: /apartment.
The apartment selection menu will open, allowing the player to choose their preferred apartment.
If you want to trigger the apartment selection automatically from a script or custom event, use the following:
ExecuteCommand("apartment")This command enables automated apartment selection and allows developers to integrate apartment spawning or selection into other systems, events, or custom gameplay flows.