Getting Started
This page will walk you through getting and installing the 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-shotspotter/config
folder there will be a file calledconfig.CHANGEME.lua
you should rename that to be config.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 calledspotters.CHANGEME.json
which you should rename tospotters.json
and use to manually place cameras based on the existing template, note you can also use the gun placement system in game. You will also find a file calleddiscord.CHANGEME.lua
, this should be named todiscord.lua
Finally, in your
server.cfg
add the following:
NEVER add ensure sonoran-shotspotter_helper
or ensure [sonoranscripts]
to your server.cfg as this will lead to crashing under specific conditions.
Congrats! You have successfully installed Sonoran Shot Spotter. See below for configuration.
Configuration
Sonoran Shot Spotter contains highly configurable permissions that have a fit for any server. In this section you will see options for standalone, QB-Core and ESX. Below will detail every option in this section, it's meaning and options.
Config Option | Option Description | Possible Values |
---|---|---|
| Would you like to restrict the |
|
| Would you like to utilize FiveM Ace Permissions? |
|
| The ace name that will be used to assign permissions. More can be read about Ace Permissions Here |
|
| Would you like to utilize ESX framework jobs for permissions? |
|
| What is the name of your ESX jobs that should have access to the shotspotter? |
|
| Admin name for ESX |
|
| Would you like to utilize QB-Core framework jobs for permissions? |
|
| What is the name of your QB-Core jobs that should have access to the shotspotter? |
|
| Admin name for QBCore |
|
| Ace permission name for admin perms |
|
Lang
The language section was created to make the script as universal as possible. Please simply edit the strings to your preferred text.
Note: Available place holders are {{street}}, {{spotter}} and {{player}}
Congrats! You have successfully configured Sonoran Shot Spotter. See below for spotter locations.
Spotter Locations
For shot spotters mounted to a pole (such as traffic lights), if the pole is broken, the shot spotter will be disabled.
These locations can be found and set in the spotters.json
found within the config
folder. To configure spotters follow this chart:
Config Option | Option Description | Possible Values | Notes |
---|---|---|---|
| The shot spotter ID (used internally) |
| This cannot be duplicated |
| The in game coordinates |
| N/A |
| Rotation values |
| N/A |
Commands
Command Name | Command Description | Required Permission |
---|---|---|
| This command will toggle the user's shot spotter status, either enabling or disabling shot spotter alerts and blips | LEO or as configured |
| Show the ID above the shot spotters | Admin |
| Show the position of the shot spotters | Admin |
| Change the position data of the shot spotter | Admin |
| Reload all spotters and positions | Admin |
| Activate the placement gun | Admin |
Last updated