Project

zrcon

0.0
No commit activity in last 3 years
No release in over 3 years
A lightweight rcon client to talk to minecraft remote console service
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 0.11
~> 12.3
~> 3.7
~> 0.52

Runtime

~> 2.2
 Project Readme

A small minecraft focused RCON client.

NOTE: Does not yet handle large/ multi packet responses.

Installation

gem install zrcon

Command Line Usage

To talk to your RCON server, you'll need three pieces of information. The RCON_HOST, RCON_PORT, and RCON_PASSWORD. If not provided to the command line or API explicitly, they will be retrieved from environment variables having these names.

$ zrcon --help
Usage: zrcon rcon-command
-H, --host=HOSTNAME              hostname of rcon server
-p, --port=PORT                  tcp port
-P, --password=PASS              rcon password
-h, --help


$ zrcon list
There are 0/20 players online:

The API

require 'zrcon'
rcon = Zrcon.new host: 'hostname', port: 25565, password: 'somethingsupersecret'
rcon.auth
rcon.command 'list'

Semaphore Build Status:

Build Status