@thelarinel/rcon/README.md

A modern NodeJS library for the Source RCON Protocol

# RCON library for NodeJS
[According to Valve's RCON specification](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol)

Forked from [RCON-SRCDS](https://github.com/EnriqCG/rcon-srcds) and improved for better error handling

## Install
```console
npm install rcon-srcds --save
```

## Usage
```javascript
const server = new Rcon(options);
```

### Options
```javascript
{
    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
```javascript
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);
```