Getting Started
This page will walk you through getting and installing the ATM Robbery script.
Acquire the Script
After purchasing the script through the sonoran store you may download the script through the keymaster account that purchased the script. Upon downloading extract the file to a safe place.
Install the Script
Inside the script package you just extracted will be two folders. Copy both to a folder in your server's resources folder called
[sonoranscripts]
note the[]
in the name, without them it will not work.In the
sonoran-atmrobbery/config
folder there will be a file calledconfig.CHANGEME.lua
you should rename that to beconfig.lua
and configure the settings inside as you would like them to be configured based on the configuration documentation below. In that same folder will also be a file calledatms.CHANGEME.json
which is a storage file for all ATMs placed using the placement gun. Change the name toatms.json
. You can also edit thediscord.CHANGEME.lua
file to add discord webhook updates for when the state of the ATM changes. Change the name todiscord.lua
.
Only ever change the name of the atms.json
ON INSTALL, not on subsequent updates!
QBCore Specific - Please follow Step 3
to ensure inventory items have correct photos!
Drag the
jackhammer.png
andrope.png
from\sonoran-atmrobbery\config
into the following folder:\resources\[qb]\qb-inventory\html\images
ESX Specific Specific - Please follow Step 4
to ensure inventory items work!
a.) Import the
ESX Installme.sql
file into your ESX databaseIf NOT using
ox_inventory
continue to step 5b.) Add the following code to the
/ox_inventory/data/items.lua
fileFinally, in your
server.cfg
add the following:
NEVER add ensure sonoran-atmrobbery_helper
or ensure [sonoranscripts]
to your server.cfg as this will lead to crashing under specific conditions.
Configuring the Script
This script utilizes two separate Lua configs. This is for security reasons. Having a separate config for your Discord Configuration keeps them server side only and safer from malicious clients.
Setting Up Permissions (Ace Permissions Only)
To use this script you must assign the permissions object to the groups which you would like to have permissions. You can find the objects needed in the config under Config.ace_perms
section in the config. To assign these perms you must add the lines to your server.cfg
or where ever you setup permissions on your server. You can learn more about Ace Permissions here.
Example:
ATM Location Config
You have two options for placing new ATMs:
You can use the command
/spawnnewatm [model] [label]
to initiate spawning a new ATM and generate the relevant config dataAfter running this command you must pull out, aim, and shoot with a gun to confirm placement.
You may need to modify some of the rotation values manually to get that perfect placement you are looking for.
You can manually copy and paste an existing config and then modify the values to meet your needs for the new ATM
atms.json
Property Explanation
atms.json
Property ExplanationProperty Name | Example | Notes |
---|---|---|
| 2 |
|
|
| Valid values are |
| This is a table that contains the x, y, and z coords of the ATM | |
| This is a table that contains the x, y, and z rotation of the ATM | |
|
| This is a human readable label for the ATM, can have spaces |
These are the default names of commands, they may have been modified by the server owner.
Commands
Command Name | Command Description | Required Permission |
---|---|---|
| This command will allow an admin to spawn a new ATM using a gun placement system where the name argument is the label for the new ATM and the prop argument is the text name of the model to use | Admin or as configured |
| This command is used to attach the rope between the ATM and your vehicle | Everyone or as configured |
| This command will initiate the final drilling into the ATM | Everyone or as configured |
Last updated