skip to navigation
skip to content

Not Logged In

rgkit 0.3.4

Robot Game Testing Kit

Latest Version: 0.3.7

rgkit -- Testing kit for [Robot Game](

[![Build Status](]

Please see this [link]( for the
instructions to the game.

Here are some excellent tools made by fellow players!
* [Open Source Bots](
* [Simulate Situations](
* [Compare Bots](
* [Browser IDE](
* [Fetch Stats](

Robot Game's original creator is
[Brandon Hsiao](

## Package Installation


The easiest way to install the kit is with
[pip]( From the terminal, run:

    pip install rgkit

Or if you want the development version:

    pip install git+

__Note:__ *This will install rgkit system-wide. It is recommended to use
[virtualenv]( to manage development


Installing with `virtualenv` requires the following steps:

    mkdir my_robot
    cd my_robot
    virtualenv env
    source env/bin/activate
    pip install rgkit


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 install

__Note:__ *This will install rgkit system-wide. It is recommended to use
[virtualenv]( to manage development

__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] [-c COUNT] [-A] [-q] [-H | -T | -C]
                 [--game-seed GAME_SEED]
                 [--match-seeds [MATCH_SEEDS [MATCH_SEEDS ...]]] [-s]
                 player1 player2

    Robot game execution script.

    positional arguments:
      player1               File containing first robot class definition.
      player2               File containing second robot class definition.

    optional arguments:
      -h, --help            show this help message and exit
      -m MAP, --map MAP     User-specified map file.
      -c COUNT, --count COUNT
                            Game count, default: 1, multithreading if >1
      -A, --animate         Enable animations in rendering.
      -q, --quiet           Quiet execution.
                            -q : suppresses bot stdout
                            -qq: suppresses bot stdout and stderr
                            -qqq: supresses all rgkit and bot output
      -H, --headless        Disable rendering game output.
      -T, --play-in-thread  Separate GUI thread from robot move calculations.
      -C, --curses          Display game in command line using curses.
      --game-seed GAME_SEED
                            Appended with game countfor per-match seeds.
      --match-seeds [MATCH_SEEDS [MATCH_SEEDS ...]]
                            Used for random seed of the first matches in order.
      -s, --symmetric       Bots spawn symmetrically

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

    rgrun -H

## Developing in the source directory:

`rgkit` is packaged as a module, so you *can* just checkout the module directory
and import/run as usual.

    |--- rgkit
    |    |---
    |    |---
    |    |---
    |    |--- ...
    |    |---

__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 ``):

    python /path/

## 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.3.4.tar.gz (md5) Source 2014-01-02 22KB
  • Downloads (All Versions):
  • 26 downloads in the last day
  • 340 downloads in the last week
  • 1413 downloads in the last month