quake3-rcon

quake3-rcon

A tiny library for using Quake 3's RCON server feature, including an command-line interface. Dependency-free.

quake3-rcon lets you send rcon commands to your Quake 3 server. You can use it as a library for your project or as an interface to access your server from your command-line.

Install

Install this package globally with NPM to use the command-line interface. Most OS need you to be root (e.g. using sudo) to install a global npm package:

$ [sudo] npm -g install quake3-rcon

or install quake3-rcon as a dependency for your package:

$ npm install --save quake3-rcon

quake3-rcon depends on Node.js. Tested with node v12.16.

Usage: command-line interface

run:

$ quake3-rcon <server-address> <rcon-password> [<server-port>]

and then type in your commands for the server, e.g. say Hi or addbot Sarge.

API

var Q3RCon = require('quake3-rcon');

Initialize the quake3-rcon object:

var rcon = new Q3RCon({
    address: '127.0.0.1',
    port: 27960, // optional
    password: 'my_super_secret_password',
    debug: true // optional
});

Send a command to the server:

rcon.send('rcon_command param1 param2 ...', (response) => {
    // this callback is optional
});

Example

var Q3RCon = require('quake3-rcon');

var rcon = new Q3RCon({
    address: '127.0.0.1',
    password: 'my_super_secret_password'
});

rcon.send('say Hello, World!', (response) => {
    console.log(response);
});

That's it. Have fun.

Support

Found a bug? Open an issue here on Github.

Wanna help? Submit a pull request or contact me.

Wanna tip me a beer? Use Bitcoin: 14pSD9AmuNhLDbGRXehxbhwzRSRrkpiAKg

License

Copyright (c) 2016 Thomas Baumbach [e-mail]

Licensed under the MIT License