cyberarm/rewrite-gameoverseer

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![Code Climate](https://codeclimate.com/github/cyberarm/rewrite-gameoverseer/badges/gpa.svg)](https://codeclimate.com/github/cyberarm/rewrite-gameoverseer)
[![Inline docs](http://inch-ci.org/github/cyberarm/rewrite-gameoverseer.svg?branch=master)](http://inch-ci.org/github/cyberarm/rewrite-gameoverseer)
[![Join the chat at https://gitter.im/gameoverseer/Lobby](https://badges.gitter.im/gameoverseer/Lobby.svg)](https://gitter.im/gameoverseer/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

# GameOverseer

A game server, designed to be able to play host to up to 4 players in Planet Wars.

This repo is a complete rewrite of  [GameOverseer](https://github.com/cyberarm/gameoverseer).

# Status
In development.
Any examples given are subject to be outdated at anytime.

# Install
### Using bundler
Add this to your Gemfile
``` ruby
gem "gameoverseer"
```
and run to install.
```
bundle install
```

### Or using RubyGems
```
gem install gameoverseer
```

# Usage
``` ruby
require 'gameoverseer'

# Write a service for your game
class GameWorld < GameOverseer::Service
  def setup
    channel_manager.register_channel('game_world', self)
  end

  def process(data)
    # Do stuff with the data hash.
  end

  def version
    "1.3.75"
  end
end

host = "localhost"
port = 56789
GameOverseer.activate(host, port)
```