@thomas-smyth/rcon

1.0.5 • Public • Published

RCON library for NodeJS

According to Valve's RCON specification

Forked from RCON-SRCDS and improved for better error handling

Install

npm install rcon-srcds --save

Usage

const server = new Rcon(options);

Options

{
    host: '127.0.0.1',          // Host
    port: 27015,                // Port

    maximumPacketSize: 0,       // Maximum packet bytes (0 = no limit)
    encoding: 'ascii',          // Packet encoding (ascii, utf8)
    timeout: 1000               // ms
}

Remember you can't send a packet larger then 4096 bytes: https://developer.valvesoftware.com/wiki/Source_RCON_Protocol#Packet_Size

Example

const rcon = require('rcon-srcds');
const server = new Rcon({ port: 1337 });

server.authenticate('yourawesomepassword')
    .then(() => {
        console.log('Authenticated');
        return server.execute('status');
    })
    .then(console.log)
    .catch(console.error);

Package Sidebar

Install

npm i @thomas-smyth/rcon

Weekly Downloads

0

Version

1.0.5

License

MIT

Unpacked Size

10.8 kB

Total Files

7

Last publish

Collaborators

  • thomas-smyth