Skip to content
This repository has been archived by the owner on Dec 15, 2023. It is now read-only.

plusflabby/arma3-be-scheduler

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

arma3-be-scheduler

Schedule messages or commands to be sent to your arma 3 server.

Requirements

  1. Node.JS
  2. NPM - This is installed by defualt with Node.JS
  3. arma3-be

Installation

  1. Run the command npm 1 --save arma3-be-scheduler
  2. 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
    • "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

About

Schedule battleye commands or server messages to be run at specific times.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published