Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

ts-rcon

Package Overview
Dependencies
0
Maintainers
1
Versions
8
Issues
File Explorer

Advanced tools

ts-rcon

Rcon client implemented in Node.js with TypeScript

    1.2.1latest

Version published
Maintainers
1
Yearly downloads
1,562
increased by228.15%

Weekly downloads

Changelog

Source

v1.2.1

  • :bug: fix bug where built files where not included in package

Readme

Source

ts-rcon

npm CI

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.

RCON Protocol Docs

Installation

npm install ts-rcon yarn add ts-rcon

Usage

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!

Keywords

Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc