arma3-be-scheduler
v1.0.2
Published
Schedule messages or commands to be sent to your arma 3 server.
Downloads
7
Maintainers
Readme
arma3-be-scheduler
Schedule messages or commands to be sent to your arma 3 server.
Requirements
Installation
- Run the command
npm 1 --save arma3-be-scheduler
- Done! Now to configure.
Configuration
Package
This will load the package to be used in your code. Add this to the top of your file.
const arma3_be_scheduler = require("arma3-be-scheduler")
Config
The config sets your timezone and the commands you want to be sent to your server. Add this to your file and change the values.
arma3_be_scheduler.Config({
"Debug": true,
"Timezone": "America/New_York",
"Commands": [
{
"Command": "say -1 Hello World!", //This will global messages everyone on the server with Hello World!
"Amount": 1, //This will send the command one time
"Time": "* * * * *" //To run the command every minute (1:01am, 1:02am, 1:03am, etc..)
}
],
})
Functions
arma3_be_scheduler.Config(Config)
This function configures your scheduler setup. The function's parameter must be an object.
Parameter Object
- "Debug" (true or false) - True will console log every time a command is run
- "Timezone" (string) - This is the timezone you want to use. (Useful map to find your timezome map)
- "Commands" (array of objects) - This array is for each command you want to send to your server.
Each object must have the following values.
- "Command" (string) - The battleye server command you want to send
- Useful website to find commands
- "Amount" (number) - How many times you want the command to be run
- "Time" (string) - The cron time to run the command
- There must be 5 inputs for minutes, hours, days, months, weeks
- Useful website to figure out the time
- "Command" (string) - The battleye server command you want to send