1.0.3 • Published 4 years ago

source-rcon-lib v1.0.3

Weekly downloads
7
License
ISC
Repository
github
Last release
4 years ago

Source RCON library

A simple Node.js library for the Source RCON Protocol

Installation

yarn add source-rcon-lib

Usage

This is a promise-based library.

Examples

Establishing a connection:

const {connect} = require('source-rcon-lib');

// these values are default
connect('127.0.0.1', '27020', '')
  .then(() => console.log('connected'))
  .catch(err => console.error(err));

Sending a command to list all players in server:

const {send} = require('source-rcon-lib');

send('listplayers')
  .then(res => console.log(res))
  .catch(err => console.error(err));

Disconnecting from RCON server:

const {disconnect} = require('source-rcon-lib');

disconnect()
  .then(() => console.log('disconnected'))
  .catch(err => console.error(err));

API

FunctionArgumentsReturns
connecturl (string), port (string), password (string)Promise
sendcommand (string)Promise
disconnectnonePromise

Upcoming

  • tests