https://github.com/csprance/node-misrcon

RCON utilities for sending message to Miscreated servers
https://github.com/csprance/node-misrcon

miscreated miscreated-game-servers node-misrcon rcon rcon-commands

Last synced: 10 days ago
JSON representation

RCON utilities for sending message to Miscreated servers

• Host: GitHub
• URL: https://github.com/csprance/node-misrcon
• Owner: csprance
• License: mit
• Created: 2017-04-26T18:40:14.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T21:44:31.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T23:05:09.766Z (8 months ago)
• Topics: miscreated, miscreated-game-servers, node-misrcon, rcon, rcon-commands
• Language: TypeScript
• Size: 954 KB
• Stars: 2
• Watchers: 1
• Forks: 5
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# node-misrcon [![npm node-misrcon](https://img.shields.io/npm/v/node-misrcon.svg)](https://www.npmjs.com/package/node-misrcon)

> package that contains functions to send rcon commands to miscreated game servers

## Features

* send RCON commands to miscreated game servers via nodejs

* Parse responses from servers into js objects

* Makes you pizza in the morning (Feature is WIP)

* Won't kick your dog.

## Getting Started

* `npm i -S node-misrcon`

* import the module

* Instantiate the api object

* Call the methods you want

  * `getBanList` 

  * `getStatus`

  * `getWhitelist`

  * `getPQM` 

  * `getStats`

  * `send`

## Examples

```ts

import * as misrcon from '../src/node-misrcon';

// Create ApiObject

const server = new misrcon.NodeMisrcon({ip: '', port: '', password: ''});

// Run Commands

const banlist = await server.getBanList();

const status = await server.getStatus();

const whitelist = await server.getWhitelist();

const pqm = await server.getPQM();

const stats = await server.getStats();

const commandResponse = await server.send('status');

```

## Changes from v1 -> 2

* `port` in `ICredentials` now takes a number instead of a string

* Many values now return numbers instead of strings if it makes sense

## Changes from v0 > 1.0

* New NodeMisrcon api object added to make requests a lot easier and only require a single authentication object and make parsing and sending requests easier

## Contributing

Feel free to help in any way you'd like! PR's are always welcome!