Installation

Script Download

Before starting, you must log in to the CFX portal to download the asset. You will be able to download it as many times as you want on the official CFX page. Just as you download it the first time, you will also download it multiple times in the future to get updates.

1

Logging in to the CFX Portal

First, log in to the official CFX portal by clicking here.

2

Finding Your Assets

Once logged in, navigate to the Granted Assets section to access your purchased assets. You can download them by clicking the "Download" button.

Remember, if you encounter any issues or errors when starting the asset, you can check here to see if the problem is related.

Understanding CFX Auth

---

Downloading Dependencies

The dependencies for this asset are mandatory, so please follow the dependency guide completely and use all required files.

When downloading a dependency, ensure the file is properly unzipped and does not include "-main" at the end of its name. If it does, please remove it.

1

ox_lib

Releases · overextended/ox_libGitHub

2

In case of using QBX

If you are a QBX user, please remove qbx_property.

---

Update artifacts and gamebuild

Updating to the latest artifacts and gamebuild is essential to avoid common server issues. Here's how to do it properly:

1

Update Artifacts

Completely replace your current artifacts with the latest version. Download the appropriate artifacts for your operating system from the official links:

• Windows: Windows Artifacts.

• Linux: Linux Artifacts.

2

Update Gamebuild

Using the latest gamebuild is critical to take advantage of the newest features and avoid compatibility errors.

Edit the server.cfg file and add the following line:

sv_enforceGameBuild 3258

You can see the complete guide to update your server here:

How to update my server

---

Server.cfg Positioning

This asset must always be started after your framework and inventory. Failure to do so may result in functionality issues or critical errors. To ensure smooth operation and proper initialization, it is recommended to start the entire download folder using "ensure [apartments]" in your server.cfg. If you are using a multicharacter system, it must be started after [apartments] to prevent potential conflicts.

---

Database Installation

For this step, we highly recommend using HeidiSQL to avoid issues, as it provides an updated version of MariaDB. We have a guide that explains step-by-step how to use HeidiSQL. If you choose to use phpMyAdmin, we will not be responsible for any errors that may occur in your database.

How to install HeidiSQL

Select the framework you are using and then execute the SQL in your HeidiSQL. If you encounter errors, ensure you are using the most current version of MariaDB. You can refer to our guide above or search online.

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
;

DROP TABLE IF EXISTS `apartment_decorations`;

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
;

---

Automatic Compatibility with Quasar Multicharacter

Quasar Apartments is fully compatible with qs-multicharacter without requiring any manual configuration. Just start the script, and it will automatically integrate with Quasar Multicharacter.

1

When the script is active, players will spawn in one of the available apartments.

2

Each player is automatically assigned an apartment for free upon first spawn.

3

No additional setup is required—it works out of the box!

This seamless integration ensures a smooth experience, making Quasar Apartments a plug-and-play housing solution for FiveM.