Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
CLI for managing Source dedicated game servers. HLSW for the console, so to say.
Ruby

README.md

About

Rubycon is a CLI for managing Source dedicated game servers (TF2, CS:S...). Think of it as a HSLW clone, but terminal-based.

Screenshot

Features:

  • RCON session with auto completion :exclamation:
  • Overview of all your servers
  • Bulk execution of rcon commands :boom:
  • Start game client and join servers from the command line

Follow this gem on Twitter.

Installation

Make sure you're on Ruby 2.0 or later (ruby --version).

You'll also need readline:

  • RHEL based: yum install readline-devel
  • Debian based: apt-get install libreadline-dev

Install rubycon with the following command:

$ gem install rubycon

Usage

First of all, add a game server to rubycon:

$ rubycon add my_server \
    --address=192.168.0.1 \
    --rcon=foobar

Time to check out how your server is doing:

$ rubycon list
Server                   Map     Players      Ping
my_server          ctf_2fort        4/25        42

Hop into a rcon session:

$ rubycon console my_server
Use CTRL+D to exit.
> sta
star_memory  startdemos   startmovie   startupmenu  stats        status
> status
hostname: MyServer
version : 1797820/24 5331 secure
udp/ip  : 192.168.0.1:27015  (public ip: 192.168.0.1)
account : not logged in  (No account specified)
map     : ctf_2fort at: 0 x, 0 y, 0 z
sourcetv:  port 27020, delay 90.0s
players : 0 (25 max)

# userid name                uniqueid            connected ping loss state  adr
>

Need stats from all your servers? Yes sir:

$ rubycon execute --command=stats --all
my_server:
CPU    In (KB/s)  Out (KB/s)  Uptime  Map changes  FPS      Players  Connects
0.00   0.00       0.00        5093    7            62.44    0        1
---------------------------------

Need further help? $ rubycon help $ rubycon help execute $ rubycon help rm ...

Contributing

  • Fork it
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create new Pull Request

Code Status

  • Gem Version
  • Build Status
  • Dependency Status
  • Code Climate

License

rubycon is released under the MIT License.

Something went wrong with that request. Please try again.