arma3-rcon-i v1.0.11

arma3-rcon-i

Connects to your arma 3 server's battleye.

Requirements

• Node.JS
• NPM - This is installed by default when you install Node.JS

Installation

1. Install the package using NPM with command npm i --save arma3-rcon-i
2. Done! Now time to configure.

Configuration

Package

Add this to the top of your file

const arma3 = require("arma3-rcon-i")
OR
import arma3 from 'arma3-rcon-i'

RCon

Add this function to your file and change the key values.

arma3.Config({
    IP: "127.0.0.1",
    Port: "2306",
    Password: "testpassword",
    Debug: false,
    RetryOnFailedAttempt: true
})

Functions

arma3.getONLINE()

This function is to get the rcon status if is connected (true is connected).

arma3.Config(Config)

This function is to attempt to setup a connection to your battleye service on your arma 3 server. The config must be an object.

Object Keys

• "IP" (string) - The IPv4 address to your arma 3 server's RCon.
• "Port" (string) - The port to your arma 3 server's RCon.
• "Password" (string) - The password to your arma 3 server's RCon.
• "Debug" (true or false) - To log connection attempts to the console.
• "RetryOnFailedAttempt" (true or false) - To attempt to reconnect to RCon on failed attempts.

arma3.SendCommand(Command)

This function is to send a battleye command to your server. The command must be a string. See Battleye Documentation for a list of commands.

//This command will globaly message players with "Hello world!"
arma3.SendCommand("say -1 Hello world!").then(() => {
    console.log("Successfully sent message!") //Note - The "say" command has no response
})

//This command logs all connected players to console
arma3.SendCommand("players").then((response) => {
    console.log(response)
})

arma3.onMessageCallback(Function)

This function will listen for server messages and output them to your callback. Note the parameter function will run for every message sent.

//This command will log out each message to the console
arma3.onMessageCallback((msg) => {
    console.log(msg)
})