Config
1. Framework
The first step to configure the script is selecting your framework. The script is delivered with an automatic framework detection feature, but you can still change it to yours.
New ESX relies on the export to bring in the framework object, on the other hand old esx triggers the event to bring in the object.
if you have renamed your core you will most likely have to make some adjustments at the top of the open.lua
files in the client
and server
folder.
2. Interaction Method
The second step is selecting the way of interacting with the script.
You can also change the way of interacting custom to your city by modifying the InteractionLoop
function in client/open.lua.
3. General Settings
These are general settings that you see in most heist scripts. The comment next to it should explain it all.
4. Cooldown
5. Dispatch
When there is activity detected at the bank the police gets notified via a dispatch message. We have a built in standalone message or you can select an external dispatch script.
You can customize the dispatch message in client/open.lua.
6. Discord Logs
Our logging system makes use of discord webhooks to send information about certain events. For more information about discord webhooks and how to set them up, check this article.
7. Robbery Interactions
We use a similar structure in all our heists to make it easy to configure and customize to your liking. You can change the minigame, evidence chance, required items and much more for every single interaction. You can even change it per bank so every bank has different rewards, minigames, etc.
7.1 Minigames
You can choose which minigames you would like your players to get. Check out the minigames section to see all the available minigames and how to install them. You can also add them yourself in client/open.lua
or request them in a ticket.
7.2 Doors
The doors array shows which indices of cfg.doors
are opened upon completion of the interaction.
7.3 Locked Until
The locked until array shows which indices of cfg.interactables
need to be completed before the interaction becomes available.
7.4 Evidence
You can configure the chance evidence is left behind on every interaction.
By default only QBCore and QBox have an evidence system. You can add your custom evidence system in client/open.lua
7.5 Interaction/Target
7.6 Required Items
You can configure which items are required per interaction. You can require multiple items or even no items at all by changing item = nil
or removing the whole required_items
array.
7.7 Rewards
The configuration of rewards can be different per interaction type, we will go over the ones used in this script. The following items/rewards will be a bit different.
'money'
will be given as cash instead of as item
'black_money'
will be given as black money instead of as item on ESX
'markedbills'
will be given as item with the worth as metadata on QBCore, you can configure the worth in config.
if you wish to modify any of this, you can in server/open.lua
7.7.1 Trolly
A trolly can spawn as 3 different types: gold, diamond and cash. These are represented by the grab_type
, they can not be renamed or changed. You can delete the rows of types you don't want spawned. For example, if you don't want the diamond type to spawn, you can just delete that line.
The probability of spawning a particular type is based on the total chance in the array, in this case 99. You can adjust the total probability in the array. They don't have to add up to 100, you can use 1 and 2, for example, giving double the chance to a particular type. it functions as a weighted luck system.
7.7.2 Pile
A pile can spawn as 2 different types: gold and cash. These are represented by the grab_type
, they can not be renamed or changed. The rest works the same as the trolly types.
7.7.3 Lockbox
The lockbox rewards are even easier to configure. You can add as possible rewards as you wish in the array. The chance system is again a weight based luck system and doesn't need to add up to 100.
Last updated