Installation guide

Welcome to the Brutal Keys 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 , you will receive your asset directly in your , 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_keys)
Restart your server! (And you get permission to use the script)

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.

CREATE TABLE IF NOT EXISTS `brutal_keys` (
  `player` text DEFAULT NULL,
  `keys_data` longtext DEFAULT NULL,
  UNIQUE KEY `Index 1` (`player`(100))
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;

CREATE TABLE IF NOT EXISTS `brutal_keys` (
  `player` text DEFAULT NULL,
  `keys_data` longtext DEFAULT NULL,
  UNIQUE KEY `Index 1` (`player`(100))
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;

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),
('screwdriver', 'Screwdriver', 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'] = ''},
['screwdriver'] 			 			 = {['name'] = 'Screwdriver', 							['label'] = 'Screwdriver', 						['weight'] = 1, 		['type'] = 'item', 		['image'] = 'screwdriver.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"
},

["screwdriver"] = {
    ["name"] = "screwdriver",
    ["label"] = "Screwdriver",
    ["weight"] = 10,
    ["type"] = "item",
    ["image"] = "screwdriver.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,
},

["screwdriver"] = {
    label = "Screwdriver",
    weight = 1,
    stack = true,
    close = false,
},

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 Keys at the end
ensure brutal_keys

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.

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

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 while stealing a vehicle.

Wiring Minigame

Download this script to have minigames when you try to wire a vehicle.

If you got any error

PreviousAccessible files Nextexports / triggers

Last updated 17 days ago

Was this helpful?