Description
A FiveM resource used to activate a custom alarm sound in an area. This uses another resource called PlayCustomSounds, a standalone resource used to play external sounds. This resource integrates with Discord and sends notifications to a channel upon Alarm Activations or Deactivations.
The alarm included as part of the installation is a British security alarm with a length of 4 seconds. This is played on a loop upon alarm activation.
This may be changed, however must be named "alarm" in an ogg format and be at a length of 4 seconds.
Usage
In game, use /alarm to activate the alarm. The distance is not changeable and is set at 30.0. This is a good distance to cover most locations in game, including stores, nightclubs and more.
To deactivate the alarm, use /alarm.
Installation
Create a new folder in server resources named "activatealarm". Inside the folder place the "Client.net.dll", "notification.lua" and "fxmanifest.lua".
To enable Discord Integration, create a new Webhook on your server and select the channel. Open "notification.lua" and enter the Webhook ID at the top. If you do not want Discord Integration, set "enabled" to false at the top. Do not edit anything below. Recommended webhook image here.
In server.cfg, add "ensure activatealarm" or "start" if on an older server version.
Ensure you have PlayCustomSounds installed on the server. Download here.
PlayCustomSounds
In the "Sound" folder in master, you will find the "alarm.ogg" file. This needs to be placed in html/sounds/ location in the PlayCustomSounds resource.
Errors and Bugs
There are no recorded errors or bugs at this time, however create a pull request or create an Issue if you encounter any, and they will be resolved.
Suggestions are also highly appreciated.
Licence
GNU General Public License v3.0
Please see the licence file for more information.
Tags
