Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including ts-rcon with all npm packages installed. Try it out:

var tsRcon = require("ts-rcon")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

ts-rcon v1.1.3

Rcon client implemented in Node.js with TypeScript

ts-rcon

npm Build Status

ts-rcon is a simple library for connecting to RCON servers in node.js implemented in TypeScript. Based on pushrax/node-rcon. It implements the protocol used by Valve's Source and GoldSrc engines, as well as many other game servers.

It was originally created to connect to Minecraft's RCON server.

Installation

npm:

$ npm install ts-rcon

Usage

See examples/stdio.js for a simple example.

Some games use TCP and some use UDP for their RCON implementation. To tell node-rcon which protocol to use, pass it an options object like so:

var options = {
  tcp: false,       // false for UDP, true for TCP (default true)
  challenge: false  // true to use the challenge protocol (default true)
};
client = new Rcon(host, port, password, options);

Here's a non-exhaustive list of which games use which options:

GameProtocolChallenge
Any Source gameTCPN/A
MinecraftTCPN/A
Any GoldSrc gameUDPYes
Call of DutyUDPNo

Source games include CS:S, CS:GO, TF2, etc. GoldSrc games include CS 1.6, TFC, Ricochet (lol), etc.

If there's a game you know uses a certain protocol, feel free to submit a pull request.

Please submit a bug report for any game you try that doesn't work!

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free