rcon-console

A Node.js library for controlling an Rcon via the command line

Usage no npm install needed!

<script type="module">
  import rconConsole from 'https://cdn.skypack.dev/rcon-console';
</script>

README

terminal-icon

version downloads license

node-rcon is a simple library for connecting to RCON servers in node.js. 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: Make sure that you are running node.js 12.20.0 or newer (node -v)

npm install -g rcon-console

Usage

See examples/basic.js for a simple example, or examples/stdio.js for a complete command line client.

Commands And Options

| Command | Description | | :-|- | | help | Display the help menu| |

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!

Note that some servers may close the connection if it is idle for a long period of time.