Page cover image

Installation guide

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


Asset download

  • Put the script folder to your server.

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

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


Upload the items

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
('tool_box', 'Tool Box', 1, 0, 1),
('vehicle_door', 'Vehicle Door', 1, 0, 1),
('vehicle_window', 'Vehicle Window', 1, 0, 1),
('suspension', 'Suspension', 1, 0, 1),
('vehicle_tyre', 'Vehicle Tyre', 1, 0, 1);
Items for qb-inventory
['tool_box'] 			 		= {['name'] = 'tool_box', 					['label'] = 'Tool Box', 				['weight'] = 10, 		['type'] = 'item', 		['image'] = 'tool_box.png', 			['unique'] = false, 		['useable'] = true, 	['shouldClose'] = true,	   ['combinable'] = nil,   ['description'] = 'Not have'},
['vehicle_door'] 			 	= {['name'] = 'vehicle_door', 					['label'] = 'Vehicle Door', 				['weight'] = 10, 		['type'] = 'item', 		['image'] = 'vehicle_door.png', 		['unique'] = false, 		['useable'] = true, 	['shouldClose'] = true,	   ['combinable'] = nil,   ['description'] = 'Not have'},
['vehicle_window'] 				= {['name'] = 'vehicle_window', 				['label'] = 'Vehicle Window', 				['weight'] = 10, 		['type'] = 'item', 		['image'] = 'vehicle_window.png', 		['unique'] = false, 		['useable'] = true, 	['shouldClose'] = true,	   ['combinable'] = nil,   ['description'] = 'Not have'},
['vehicle_tyre'] 			 	= {['name'] = 'vehicle_tyre', 					['label'] = 'Vehicle Tyre', 				['weight'] = 10, 		['type'] = 'item', 		['image'] = 'vehicle_tyre.png', 		['unique'] = false, 		['useable'] = true, 	['shouldClose'] = true,	   ['combinable'] = nil,   ['description'] = 'Not have'},
['suspension'] 			                = {['name'] = 'suspension', 				        ['label'] = 'Suspension', 		                ['weight'] = 10, 		['type'] = 'item', 		['image'] = 'suspension.png',   	        ['unique'] = false, 		['useable'] = true, 	['shouldClose'] = true,	   ['combinable'] = nil,   ['description'] = 'Not have'},
Items for qs-inventory
["tool_box"] = {
    ["name"] = "tool_box",
    ["label"] = "Tool Box",
    ["weight"] = 10,
    ["type"] = "item",
    ["image"] = "tool_box.png",
    ["unique"] = false,
    ["useable"] = true,
    ["shouldClose"] = true,
    ["combinable"] = nil,
    ["description"] = "Must be important, who knows?"
},

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

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

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

["suspension"] = {
    ["name"] = "suspension",
    ["label"] = "Suspension",
    ["weight"] = 10,
    ["type"] = "item",
    ["image"] = "suspension.png",
    ["unique"] = false,
    ["useable"] = true,
    ["shouldClose"] = true,
    ["combinable"] = nil,
    ["description"] = "What the heck is this?"
},
Items for ox_inventory
["tool_box"] = {
    label = "Tool Box",
    weight = 1,
    stack = true,
    close = false,
},

["vehicle_door"] = {
    label = "Vehicle Door",
    weight = 1,
    stack = true,
    close = false,
},

["vehicle_window"] = {
    label = "Vehicle Window",
    weight = 1,
    stack = true,
    close = false,
},

["vehicle_tyre"] = {
    label = "Vehicle Tyre",
    weight = 1,
    stack = true,
    close = false,
},

["suspension"] = {
    label = "Suspension",
    weight = 1,
    stack = true,
    close = false,
},

Here you can find the images which we used for the items

Item images

Asset positioning

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

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

-- Start the Brutal Crafting at the end
ensure brutal_mechanicjob

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

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

Editing framework

ESX

Navigate to esx_society/server/main.lua and replace this function:

function isPlayerBoss(playerId, job)
	local xPlayer = ESX.GetPlayerFromId(playerId)

	if xPlayer.job.name == job then
		return true
	else
		print(('esx_society: %s attempted open a society boss menu!'):format(xPlayer.identifier))
		return false
	end
end

If you want the players only get paycheck if they are on duty then replace this file: es_extended/server /paycheck.lua

QBCORE

Navigate to qb-core/shared/job.lua and set the defaultDuty to false:

qb-core/shared/job.lua

Installing the props

Download the attached file and then you have to start this assets just like any other script 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

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

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.


Remove the basic Mechanic Job from your server

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.

Last updated

Was this helpful?