JSPM

webrconjs

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 22
  • Score
    100M100P100Q64226F
  • License Apache-2.0

RCON over WebSocket client library and command line interface.

Package Exports

  • webrconjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (webrconjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

WebRcon

RCON over WebSocket client library and command line interface.

  • Supported games: Rust
  • Supported platforms: node.js and any modern browser (CommonJS, AMD, shim)

Usage

var WebRcon = require('webrconjs') // node.js only

// Create a new client:
var rcon = new WebRcon('127.0.0.1', 28025)

// Handle events:
rcon.on('connect', function() {
    console.log('CONNECTED')
    
    // Run a command once connected:
    rcon.run('echo hello world!', 0)
})
rcon.on('disconnect', function() {
    console.log('DISCONNECTED')
})
rcon.on('message', function(msg) {
    console.log('MESSAGE:', msg)
})
rcon.on('error', function(err) {
    console.log('ERROR:', err)
})

// Connect by providing the server's rcon.password:
rcon.connect('1234')

Browser usage

<script src="webrcon.js"></script>
<script>
var WebRcon = dcodeIO.WebRcon;

... actually the same as above ....
</script>

Also works as an AMD module.

Command line usage

npm -g install webrconjs

Usage: webrcon <ip> [port] [password]

Examples:
  webrcon 127.0.0.1 27015 p4ssw0rd  Connects to the local machine

License: Apache License, Version 2.0