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:
Starter Pack
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 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.
-- qs-starterpack — schema. Idempotent, safe to re-run.
CREATE TABLE IF NOT EXISTS `qs_starterpack_admin_config` (
`id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
`server_key` VARCHAR(190) NOT NULL DEFAULT 'main',
`config_json` LONGTEXT NOT NULL,
`updated_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
ON UPDATE CURRENT_TIMESTAMP,
UNIQUE KEY `uniq_qsstarterpack_cfg_server` (`server_key`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
CREATE TABLE IF NOT EXISTS `qs_starterpack_claims` (
`id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
`server_key` VARCHAR(190) NOT NULL DEFAULT 'main',
`license` VARCHAR(128) NOT NULL,
`gender` VARCHAR(16) NOT NULL,
`pack_id` VARCHAR(64) NOT NULL,
`claimed_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
`claim_period` VARCHAR(32) NULL,
UNIQUE INDEX `uniq_qsstarterpack_claim_period` (`server_key`, `license`, `claim_period`),
INDEX `idx_qsstarterpack_claims_license` (`server_key`, `license`),
INDEX `idx_qsstarterpack_claims_pack` (`pack_id`),
INDEX `idx_qsstarterpack_claims_at` (`claimed_at`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
-- qs-starterpack — optional preset packs.
-- Run AFTER install.sql to seed three packs per gender (LEGAL / CIVILIAN / ILLEGAL).
-- Item names, descriptions, and icons are resolved at runtime from your
-- active inventory framework — same preset works on QB, QBX, ESX, ox.
-- WARNING: this overwrites any admin-saved config. Skip if you've already customised.
UPDATE `qs_starterpack_admin_config`
SET `config_json` = '{
"female": {
"featuredId": "illegal",
"packs": [
{
"id": "legal",
"enabled": true,
"name": "LEGAL",
"accent": "#10b981",
"accentSoft": "rgba(16,185,129,0.30)",
"bg": "",
"bgUrl": "./assets/presets/female_legal.jpg",
"items": [
{ "tag": "MONEY", "name": "Cash", "desc": "Working capital — uniform, fuel, supplies.", "qty": 3000, "tier": "common" },
{ "id": "id_card", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "phone", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "driver_license", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "repairkit", "tag": "MISC", "qty": 2, "tier": "standard" },
{ "id": "water_bottle", "tag": "MISC", "qty": 3, "tier": "common" }
]
},
{
"id": "civilian",
"enabled": true,
"name": "CIVILIAN",
"accent": "#3b82f6",
"accentSoft": "rgba(59,130,246,0.30)",
"bg": "",
"bgUrl": "./assets/presets/female_civ.jpg",
"items": [
{ "tag": "MONEY", "name": "Cash", "desc": "Pocket money to get you started.", "qty": 1500, "tier": "common" },
{ "id": "id_card", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "phone", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "water_bottle", "tag": "MISC", "qty": 5, "tier": "common" },
{ "id": "sandwich", "tag": "MISC", "qty": 5, "tier": "common" }
]
},
{
"id": "illegal",
"enabled": true,
"name": "ILLEGAL",
"accent": "#ef4444",
"accentSoft": "rgba(239,68,68,0.30)",
"bg": "",
"bgUrl": "./assets/presets/female_illegal.jpg",
"items": [
{ "tag": "DIRTY_MONEY", "name": "Dirty Cash", "desc": "Bigger seed — risk pays.", "qty": 5000, "tier": "rare" },
{ "id": "id_card", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "phone", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "lockpick", "tag": "MISC", "qty": 2, "tier": "standard" },
{ "id": "weapon_bat", "tag": "MISC", "qty": 1, "tier": "rare" },
{ "id": "water_bottle", "tag": "MISC", "qty": 3, "tier": "common" }
]
}
]
},
"male": {
"featuredId": "illegal",
"packs": [
{
"id": "legal",
"enabled": true,
"name": "LEGAL",
"accent": "#10b981",
"accentSoft": "rgba(16,185,129,0.30)",
"bg": "",
"bgUrl": "./assets/presets/male_legal.jpg",
"items": [
{ "tag": "MONEY", "name": "Cash", "desc": "Working capital — uniform, fuel, supplies.", "qty": 3000, "tier": "common" },
{ "id": "id_card", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "phone", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "driver_license", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "repairkit", "tag": "MISC", "qty": 2, "tier": "standard" },
{ "id": "water_bottle", "tag": "MISC", "qty": 3, "tier": "common" }
]
},
{
"id": "civilian",
"enabled": true,
"name": "CIVILIAN",
"accent": "#3b82f6",
"accentSoft": "rgba(59,130,246,0.30)",
"bg": "",
"bgUrl": "./assets/presets/male_civ.jpg",
"items": [
{ "tag": "MONEY", "name": "Cash", "desc": "Pocket money to get you started.", "qty": 1500, "tier": "common" },
{ "id": "id_card", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "phone", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "water_bottle", "tag": "MISC", "qty": 5, "tier": "common" },
{ "id": "sandwich", "tag": "MISC", "qty": 5, "tier": "common" }
]
},
{
"id": "illegal",
"enabled": true,
"name": "ILLEGAL",
"accent": "#ef4444",
"accentSoft": "rgba(239,68,68,0.30)",
"bg": "",
"bgUrl": "./assets/presets/male_illegal.jpg",
"items": [
{ "tag": "DIRTY_MONEY", "name": "Dirty Cash", "desc": "Bigger seed — risk pays.", "qty": 5000, "tier": "rare" },
{ "id": "id_card", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "phone", "tag": "MISC", "qty": 1, "tier": "common" },
{ "id": "lockpick", "tag": "MISC", "qty": 2, "tier": "standard" },
{ "id": "weapon_bat", "tag": "MISC", "qty": 1, "tier": "rare" },
{ "id": "water_bottle", "tag": "MISC", "qty": 3, "tier": "common" }
]
}
]
},
"settings": {
"logoUrl": "",
"sfxEnabled": true,
"themeColor": "#00a3ff",
"localeCode": "en",
"peds": []
}
}';