skip to navigation
skip to content

Not Logged In

rgkit 0.1

Robot Game Testing Kit

Latest Version: 0.5.0

rgkit -- Testing kit for [Robot Game]http://robotgame.net/
========================

[![Build Status]https://travis-ci.org/WhiteHalmos/rgkit.png?branch=master]
https://travis-ci.org/WhiteHalmos/rgkit

Please see this [link]http://robotgame.whitehalmos.org/kit for the
instructions to the game.

Here are some excellent tools made by fellow players!
* [Open Source Bots]https://github.com/mpeterv/robotgame-bots
* [Simulate Situations]https://github.com/mpeterv/rgsimulator
* [Compare Bots]https://github.com/mueslo/rgcompare
* [Browser IDE]https://github.com/bsuh/rgfiddle
* [Fetch Stats]https://github.com/afffsdd/Get-Robot

Robot Game's original creator is
[Brandon Hisao]https://github.com/brandonhsiao)

## Package Installation

__pip__

The easiest way to install the kit is with
`[pip]http://www.pip-installer.org/en/latest/`. From the terminal, run:

pip install git+https://travis-ci.org/WhiteHalmos/rgkit

__Note:__ *This will install rgkit system-wide. It is recommended to use
[virtualenv]http://www.virtualenv.org/en/latest/ to manage development
environments.*

__virtualenv__

Installing with `virtualenv` requires the following steps:

mkdir my_robot
cd my_robot
virtualenv env
source env/bin/activate pip
install git+https://travis-ci.org/WhiteHalmos/rgkit

__setup.py__

You can also manually install directly from the source folder. Make a local
copy of the git repository or download the source files. Then, using the
terminal, run the following from the root directory of the source code:

python setup.py install

__Note:__ *This will install rgkit system-wide. It is recommended to use
[virtualenv]http://www.virtualenv.org/en/latest/ to manage development
environments.*

__Running the game__

After installing the package, the script is executable from the command line
(if you're using virtualenv, remember to activate the environment). There are
two entry points provided: `rgrun` and `rgmap`. The general usage of run is:

usage: rgrun [-h] [-m MAP] [-H] usercode1 usercode2

Robot game execution script.

positional arguments:
usercode1 File containing first robot class definition.
usercode2 File containing second robot class definition.

optional arguments:
-h, --help show this help message and exit
-m MAP, --map MAP User-specified map file.
-H, --headless Disable rendering game output.

So, from a directory containing your_robot.py, you can run a game against the
default robot and suppress GUI output with the following command:

rgrun -H your_robot.py defaultrobots.py

## Developing in the source directory:

`rgkit` is packaged as a module, so you *can* co-locate the module directory
with your own source code and import/run as usual.

rgkit
|--- rgkit
| |--- __init__.py
| |--- game.py
| |--- run.py
| |--- ...
| |--- your_robot.py
|--- setup.py
...

__Running the game__

To run the game with the source configured this way, use the terminal and
execute the following from the inner `rgkit` folder (i.e., in the same
directory as `run.py`):

python run.py your_robot.py defaultrobots.py

## Importing:

Once installed, you should only need the `rg` module (which is itself optional)
to develop your own robots. The package can be imported like any other module:

import rg

class Robot:
def act(self):
return ['guard']  
File Type Py Version Uploaded on Size
rgkit-0.1.tar.gz (md5) Source 2013-12-14 13KB
  • Downloads (All Versions):
  • 0 downloads in the last day
  • 242 downloads in the last week
  • 386 downloads in the last month