Installation guide

Welcome to the Brutal Housing installation guide, here you can learn how to completely install our asset.

If you don't have any experience in development we are highly recommend to follow each step in this documentation, and if you have a developer ask them to install the script for you as they have more experience.

---

Asset download

Once the purchase is made on our official website, you will receive your asset directly in your Keymaster, in the Granted Assets panel you will see the asset, download it and do the following steps to install it correctly.

• Put the script folder to your server.

• Start the script in the server.cfg. (ensure brutal_housing)

• Restart your server! (And you get permission to use the script)

Click here if you haven't installed any script ever

---

Upload the SQL

Do not rename your previous SQL or columns to adapt them to this system, use the complete database without making use of edits in your old databases.

ESX

CREATE TABLE IF NOT EXISTS `brutal_housing` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `type` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `model` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `theme` int(11) NOT NULL DEFAULT 0,
  `previousOwner` text DEFAULT NULL,
  `owner` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `keyid` text DEFAULT NULL,
  `phone` text DEFAULT '',
  `isRented` int(11) DEFAULT 0,
  `forSale` int(11) DEFAULT 1,
  `rentable` int(11) DEFAULT 1,
  `defaultPrice` int(11) DEFAULT NULL,
  `purchasePrice` int(11) DEFAULT NULL,
  `salePrice` int(11) DEFAULT NULL,
  `label` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `address` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `url` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `coords` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `lastPaid` longtext DEFAULT NULL,
  `messages` longtext CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `furnitures` longtext DEFAULT NULL,
  `securityData` longtext DEFAULT NULL,
  `garage` int(11) DEFAULT 0,
  `lastUpdated` text DEFAULT NULL,
  UNIQUE KEY `Index 2` (`id`),
  KEY `Index 1` (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=armscii8 COLLATE=armscii8_bin;


CREATE TABLE IF NOT EXISTS `brutal_housing_estates` (
  `job` text NOT NULL,
  `balance` int(11) DEFAULT NULL,
  `soldProperties` longtext DEFAULT '[]',
  UNIQUE KEY `UNIQUE` (`job`(100)) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;


CREATE TABLE IF NOT EXISTS `brutal_housing_garages` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `type` text NOT NULL,
  `model` text DEFAULT NULL,
  `theme` int(11) NOT NULL DEFAULT 0,
  `previousOwner` text DEFAULT NULL,
  `owner` text DEFAULT NULL,
  `keyid` text DEFAULT NULL,
  `phone` text DEFAULT '',
  `isRented` int(11) DEFAULT 0,
  `forSale` int(11) DEFAULT 1,
  `rentable` int(11) DEFAULT 1,
  `defaultPrice` int(11) DEFAULT NULL,
  `purchasePrice` int(11) DEFAULT NULL,
  `salePrice` int(11) DEFAULT NULL,
  `label` text DEFAULT NULL,
  `address` text DEFAULT NULL,
  `url` text DEFAULT NULL,
  `coords` text DEFAULT NULL,
  `lastPaid` longtext DEFAULT NULL,
  `messages` longtext DEFAULT NULL,
  `vehicles` longtext DEFAULT NULL,
  `house` int(11) DEFAULT NULL,
  `lastUpdated` text DEFAULT NULL,
  UNIQUE KEY `Index 2` (`id`),
  KEY `Index 1` (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;

QBCORE

CREATE TABLE IF NOT EXISTS `brutal_housing` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `type` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `model` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `theme` int(11) NOT NULL DEFAULT 0,
  `previousOwner` text DEFAULT NULL,
  `owner` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `keyid` text DEFAULT NULL,
  `phone` text DEFAULT '',
  `isRented` int(11) DEFAULT 0,
  `forSale` int(11) DEFAULT 1,
  `rentable` int(11) DEFAULT 1,
  `defaultPrice` int(11) DEFAULT NULL,
  `purchasePrice` int(11) DEFAULT NULL,
  `salePrice` int(11) DEFAULT NULL,
  `label` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `address` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `url` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `coords` text CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `lastPaid` longtext DEFAULT NULL,
  `messages` longtext CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `furnitures` longtext DEFAULT NULL,
  `securityData` longtext DEFAULT NULL,
  `garage` int(11) DEFAULT 0,
  `lastUpdated` text DEFAULT NULL,
  UNIQUE KEY `Index 2` (`id`),
  KEY `Index 1` (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=armscii8 COLLATE=armscii8_bin;


CREATE TABLE IF NOT EXISTS `brutal_housing_estates` (
  `job` text NOT NULL,
  `balance` int(11) DEFAULT NULL,
  `soldProperties` longtext DEFAULT '[]',
  UNIQUE KEY `UNIQUE` (`job`(100)) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;


CREATE TABLE IF NOT EXISTS `brutal_housing_garages` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `type` text NOT NULL,
  `model` text DEFAULT NULL,
  `theme` int(11) NOT NULL DEFAULT 0,
  `previousOwner` text DEFAULT NULL,
  `owner` text DEFAULT NULL,
  `keyid` text DEFAULT NULL,
  `phone` text DEFAULT '',
  `isRented` int(11) DEFAULT 0,
  `forSale` int(11) DEFAULT 1,
  `rentable` int(11) DEFAULT 1,
  `defaultPrice` int(11) DEFAULT NULL,
  `purchasePrice` int(11) DEFAULT NULL,
  `salePrice` int(11) DEFAULT NULL,
  `label` text DEFAULT NULL,
  `address` text DEFAULT NULL,
  `url` text DEFAULT NULL,
  `coords` text DEFAULT NULL,
  `lastPaid` longtext DEFAULT NULL,
  `messages` longtext DEFAULT NULL,
  `vehicles` longtext DEFAULT NULL,
  `house` int(11) DEFAULT NULL,
  `lastUpdated` text DEFAULT NULL,
  UNIQUE KEY `Index 2` (`id`),
  KEY `Index 1` (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;

Click here if you don't know how to upload the sql, here is a quick guide

---

Upload the items

If you don't have the items integrated correctly, you will receive random errors.

Check that you don't have duplicate items in your inventory or database before integrating them, otherwise you might have some errors.

This asset depends on certain items for its operation, so don't forget to integrate all items correctly into your database or inventory system, depending on how you use your server.

If your inventory is not among the following, you can create the file yourself using the examples of each item by displaying any of the following tabs.

Items for esx_inventory

INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES
('lockpick', 'Lockpick', 1, 0, 1),
('laptop', 'Laptop', 1, 0, 1),

Items for qb-inventory

['lockpick'] 			 		 = {['name'] = 'lockpick', 						['label'] = 'Lockpick', 						['weight'] = 1, 		['type'] = 'item', 		['image'] = 'lockpick.png', 				['unique'] = false, 	['useable'] = false, 	['shouldClose'] = true,	   ['combinable'] = nil,   ['description'] = ''},
['laptop'] 			 			 = {['name'] = 'laptop', 							['label'] = 'Laptop', 						['weight'] = 1, 		['type'] = 'item', 		['image'] = 'laptop.png', 				['unique'] = false, 	['useable'] = false, 	['shouldClose'] = true,	   ['combinable'] = nil,   ['description'] = ''},

Items for qs-inventory

["lockpick"] = {
    ["name"] = "lockpick",
    ["label"] = "Lockpick",
    ["weight"] = 10,
    ["type"] = "item",
    ["image"] = "lockpick.png",
    ["unique"] = false,
    ["useable"] = false,
    ["shouldClose"] = true,
    ["combinable"] = nil,
    ["description"] = "Not have"
},

["laptop"] = {
    ["name"] = "laptop",
    ["label"] = "Laptop",
    ["weight"] = 10,
    ["type"] = "item",
    ["image"] = "laptop.png",
    ["unique"] = false,
    ["useable"] = false,
    ["shouldClose"] = true,
    ["combinable"] = nil,
    ["description"] = "Not have"
},

Items for ox-inventory

["lockpick"] = {
    label = "Lockpick",
    weight = 1,
    stack = true,
    close = false,
},

["laptop"] = {
    label = "Laptop",
    weight = 1,
    stack = true,
    close = false,
},

Click here if you don't know how to upload the sql, here is a quick guide

---

Asset positioning

Correctly position the assets in the server.cfg by following this step, if something goes wrong you will probably get errors about exports not found, do not skip this step!

-- First we will start the cores, never below
ensure es_extended or qb-core

-- The Notify / TextUI or target system / Progressbar / Inventory / Billing have to be above our asset
ensure [notify]
ensure [inventory]
ensure [billing]
ensure [textui] -- or target system 

-- Start the Brutal Housing at the end
ensure brutal_housing

---

Setting up the Webhook

If you want to use the opportunnities which can be given by a webhook then you will have to set it up in our assets. You can do it by changeing a value to your discord webhook in the sv-utils.lua file.

sv-utils.lua

Discord Webhook

---

Setting the loaded event

If you are using a multicharacter system then this step is really important to make our script working propetly! If you don't use any or the loaded event is the same as the basic core one then you are done with this step.

In the client-core.lua file go to the LoadedEvent variable and if you are using a different event then paste there your event which is used on your server.

client-core.lua

---

Checking the Config file

Please make sure that you go through the whole file during the installation and check everything. It is one of the most important things as if you miss this step the script might won't work propetly.

Most important steps

The most important things always at the top of the config so pay the most attencion to these elements.

Setting the Core

Set your server's core wether it's using es_extended or qb-core, other cores aren't supported .

Setting the Notify

If you are using the Brutal Notify then it is good news, you don't have to do anything. If you aren't then set the BrutalNotify value to false in the config and set up your own notify in the cl-utils.lua

Setting the TextUI or Target

Set the TextUI from the options which are commented out. If your server using an other TextUI it is not a problem, you can set it up in the cl-utils.lua. If you want to use a target system then set the TextUI to false and set your target.

---

Lockpicking Minigame

Download this script to use the lockpicking minigame.

6KB

lockpick.zip

archive

Break-in/Raid Minigame

Download this script to have minigames when you break into a house or raid one

2MB

ps-ui-main.zip

archive

Doorlock

Download this script to be able to create locks for the mlo type houses

451KB

ox_doorlock.zip

archive

Setting up the interiors

If you want to add your own interiors/apartments/furnitures you have to navigate to the configs folder.

Download the preconfigured shells

Here are two links to the preconfigured shells, which are basically in the interiors.lua file

K4MB1 MAPS

GitHub - Lynxist/lynx_shells: 3 Apartment/housing shells, furnished and unfurnishedGitHub

---

Setting up the core

To use this script you will have to make some changes in your core. These steps have to be done to make our asset work 100%.

Paste this line to the server.cfg file. Otherwise you can't place door objects.

setr game_enableDynamicDoorCreation "true"

QBOX

If you are using the QBOX core then set your core to "qbcore" in the config.lua file. Then follow our guide on discord how to make the script compatible with the QBOX core. Discord Room

If you got any error

If you followed the installational guide and the script still don't work or you get any errors the please check the common errors, here in the docs and in our discord server, for more informations.