A set of tools for interacting with Source Dedicated Server in node.js.
Current version: v0.2.0
For issuing commands to SRCDS via the Source RCON Protocol, srcds-tools provides the RConClient type. Typical usage is as follows:
var RConClient = require("srcds-tools").RConClient;
var rcon = new RConClient();
rcon.connect("127.0.0.1", 27015);
rcon.sendPassword("password123");
rcon.sendCommand("sv_cheats 1", function (response) {
// Code to be executed when the server responds
});A boolean which, if set to true, causes the RConClient to output debug information to console.log().
Establishes a TCP connection to the game server. The port can be passed as a second parameter, or as part of the address string. Once connect() is called, it is safe to call sendPassword() immediately.
rcon.connect("127.0.0.1", 27015);
// or
rcon.connect("127.0.0.1:27015");Sends an authentication request to the server using the given password. If RConClient is able to authenticate successfully, callback is invoked. If the server rejects the password, an RConBadPasswordError is passed to the callback as the first parameter. The callback is optional, but highly advised since sending commands after a failed auth attempt can result in an RCON ban from the server.
rcon.sendPassword("dingbats", function (error) {
if (error) throw error;
console.log("Authenticated successfully!");
});Instructs the server to execute the specified command. The server's response will be passed to callback if it is specified. If the RCON password changes, sendPassword() will need to be called again or a RConBadPasswordError may be thrown.
rcon.sendCommand("_restart", function (response) {
console.log("Server says: " + response);
});Changes the maximum duration (in milliseconds) that RConClient will wait for a response before throwing an RConTimeoutError. Default is 1000 (1 second). Calling this method is usually unneccessary unless you want quicker/slower timeouts.
// Future requests will time out in 1/2 second
rcon.setTimeout(500);The srcds-tools module also provides a few utilites that can be used for debugging or independently of the module itself. They are located in the util directory.
RConCLI.js is a simple command-line implementation of RConClient. To use it, simply run the file with node.
node ./util/RConCLI.js