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.
npm install modern-rcon --save
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.
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();
});
npm install
npm run setup-minecraft
To run the tests you need to start the Minecraft Server with npm run start-minecraft
in another Terminal.