KCA/alarm-system
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update README

Browse source 
- Add some basic instructions for setup
- Add config list
This commit is contained in:
Christopher Cookman 2024-08-07 01:22:12 -06:00
parent f77a533226
commit 74fab4221b
Signed by: ChrisChrome
GPG key ID: A023A26E42C33A42
1 changed files with 26 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,11 +1,35 @@
# KCA Security XP-99 Intelligent Security System
## TODO
- [ ] Make installation instructions
- [ ] Alarm reporting Roblox-Side script
- [X] Make installation instructions
- [X] Alarm reporting Roblox-Side script
- [ ] More detailed Readme
- [X] Use datastores for code storage
## Installation
1. Download the zip file [here](https://git.chrischro.me/KCA/alarm-system/archive/main.zip)
2. Insert the SystemTemplate into your game
3. Insert a keypad into the `Keypads` folder
3. Insert a ZoneTemplate into the `Zones` folder, set up the zone as you like
a. Add sensors to the zones `Sensors` folder
b. Change the name of the zone folder to the zone number you'd like
4. Insert Sirens into the `Sirens` folder
## Configuration
### System
The system is configured through some values in the structure of the system. Here are the values you can change:
- `dataStoreKey` - The key used to store the system's data in the datastore. Set to blank to use hard-coded codes in the `SecuritySystem` script
- `entryDelay` and `exitDelay` - The time in seconds for the entry and exit delays
- `systemName` - The name of the system, used in reporting.
### Zone
The zone is configured through some values in the structure of the zone. Here are the values you can change:
- `zoneName` - The name of the zone, used in reporting.
- `chime` - Whether to play a chime when zone is tripped and chime is enabled (`<code>` + `9`)
- `alwaysOn` - Whether the zone is always on, and does not need to be armed to trip
- `instant` - Whether the zone is instant, and will trip immediately when armed. If false, entry delay will be used.
- `interior` - Whether the zone is an interior zone, and will not trip when the system is armed in `Stay` mode
- `isFire` - Whether the zone is a fire zone, and will trip the system's fire alarm
## Having multiple separate systems
To put it simply, you just need to set the `dataStoreKey` string to *anything you want*