A modern RCON client implementation written in ES2015
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
tests
.gitignore
.npmignore
LICENSE
README.md Fixed grammar in README Dec 24, 2016
package.json
rcon.js

README.md

node-modern-rcon npm package

A modern RCON client implementation written in ES2015

NOTE: This has only been tested with Minecraft. So be aware of possible bugs with other server implementations. Feel free to submit a PR if you have any problems.

Installation

npm install modern-rcon --save

API

new Rcon(host, port = 25575, password, timeout = 5000)

Creates a new Rcon object.

rcon.connect() -> Promise

Connects with the credentials provided in the constructor.

rcon.send(data) -> Promise<string>

Executes the provided command on the open connection and returns the response.

rcon.disconnect() -> Promise

Disconnects gracefully.

Example

const Rcon = require('modern-rcon');

const rcon = new Rcon('localhost', 'some password');

rcon.connect().then(() => {
  return rcon.send('help'); // That's a command for Minecraft
}).then(res => {
  console.log(res);
}).then(() => {
  return rcon.disconnect();
});

Contribute

  1. Install the dependencies with npm install
  2. Setup a Minecraft Server for the tests by using npm run setup-minecraft
    Important: This script will automatically accept the Minecraft EULA

To run the tests you need to start the Minecraft Server with npm run start-minecraft in another Terminal.

License

MIT