https://github.com/bmiddha/ts-rcon

RCON client for Node.js written in TypeScript
https://github.com/bmiddha/ts-rcon

csgo es6 games minecraft node-rcon nodejs protocol rcon rcon-servers source tcp tf2 typescript udp

Last synced: 8 days ago
JSON representation

RCON client for Node.js written in TypeScript

• Host: GitHub
• URL: https://github.com/bmiddha/ts-rcon
• Owner: bmiddha
• License: mit
• Created: 2019-08-05T23:26:24.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-08T00:31:08.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T10:27:16.186Z (22 days ago)
• Topics: csgo, es6, games, minecraft, node-rcon, nodejs, protocol, rcon, rcon-servers, source, tcp, tf2, typescript, udp
• Language: TypeScript
• Homepage: https://bmiddha.github.io/ts-rcon
• Size: 696 KB
• Stars: 8
• Watchers: 0
• Forks: 2
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ts-rcon

[![npm](https://img.shields.io/npm/v/ts-rcon)](https://www.npmjs.com/package/ts-rcon) [![CI](https://github.com/bmiddha/ts-rcon/actions/workflows/main.yml/badge.svg)](https://github.com/bmiddha/ts-rcon/actions/workflows/main.yml)

ts-rcon is a simple library for connecting to RCON servers in node.js implemented in TypeScript.

Based on [pushrax/node-rcon](https://github.com/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](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol)

## Installation

```shell

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:

```javascript

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:

| Game             | Protocol | Challenge |

| :--------------- | :------- | :-------- |

| Any Source game  | TCP      | N/A       |

| Minecraft        | TCP      | N/A       |

| Any GoldSrc game | UDP      | Yes       |

| Call of Duty     | UDP      | No        |

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!