Installation guide

Welcome to the Brutal Paintball 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_paintball)

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

Click here if you haven't installed any script ever

---

Download the Paintball MLOs

• Put the resource folder to your server.

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

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

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.

In your localhost or heidisql database you must execute this sql, with this we will automatically eliminate the existing tables and columns and replace them with the current ones from Quasar Inventory. If you want to edit something in these events, you can do so but at your own risk, do not forget to fully read the notices above this message.

ESX

ALTER TABLE `users` ADD COLUMN `paintball_inventory` longtext NULL DEFAULT NULL;

QBCORE

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

[How-To] How to import an .sql into your databaseCfx Forum

---

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 / Progressbar / Inventory / Paintball have to be above our asset
ensure [notify]
ensure [textui]
ensure [inventory]

-- Start the Brutal Paintball at the end
ensure brutal_paintball

---

Setting up the Steam API key (Opcional)

If you want to use the steam profile pictures in the paintball menu then you will have to do this guide for it.

FiveM: Steam Web API Key setup | ZAP-Hosting Docszap-hosting.com

---

Create a new WEAPON on your server.

if you do not want to create a new weapon on your server then you can also edit the type of weapon on each maps in the config.lua if you search for it: "WEAPON_PAINTBALL". -- Download the weapon model resource. --

24MB

paintball_gun.zip

archive

Open

-- Weapon icon --

52KB

WEAPON_PAINTBALL.zip

archive

Open

-- Create a custom WEAPON_PAINTBALL weapon on your server as your inventory system needs.--

If your inventory system is not here then just create the custom weapon as your server needes to create a new weapon on it.

Weapon for ox_inventory

ox_inventory/data/weapons.lua:

['WEAPON_PAINTBALL'] = {
			label = 'Paintball Weapon',
			weight = 1500,
			durability = 0.075,
			ammoname = 'ammo-9',
		},

Weapon for qb-inventory

qb-core\shared\items.lua

weapon_paintball = { name = 'weapon_paintball', label = 'Paintball', weight = 1000, type = 'weapon', ammotype = 'AMMO_PISTOL', image = 'weapon_paintball.png', unique = true, useable = false, description = '' },

If you use the Brutal Ambulance Job

Open the brutal_ambulance/config.lua file and set the BrutalPaintball to true in the file:

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

---

Editing framework

We do not recommend editing frameworks unnecessarily, since almost all assets depend exclusively on your framework and exports on the name of your framework. Otherwise and if you edited your framework, read these steps carefully. If you have to edit functions related to your framework you can do it in the server-core.lua or in the client-core.lua.

---

If you got any error

If you followed the installation 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.