Skip to content

Latest commit

 

History

History
69 lines (52 loc) · 2.13 KB

README.md

File metadata and controls

69 lines (52 loc) · 2.13 KB
Raw
                                        _
                                       ( )
      ___    _     ___ ___   _ _      _| |
    /'___) /'_`\ /' _ ` _ `\( '_`\  /'_` |
   ( (___ ( (_) )| ( ) ( ) || (_) )( (_| |
   `\____)`\___/'(_) (_) (_)| ,__/'`\__,_)
                            | |
                            (_)

A competition daemon for Student Robotics.

Many Scarzies died to bring us this implementation.

History

This will be the fourth implementation of compd in as many years. Hopefully this one, being simpler than the others, will actually stick.

Getting Started

To install:

  1. Install redis, version 2.6 or later
  2. Install python development tooling (via, eg, sudo apt-get install python-dev)
  3. Install virtualenv (via, eg, sudo easy_install virtualenv)
  4. Run ./install

All other dependencies, through the magic of virtualenv, are installed locally - in the dep directory as a matter of fact.

To run, use ./run.

To develop, enter the virtualenv using ./shell.

Interfaces

There are two main interfaces, both of which accept the same commands (and respond in the same way). The first (and primary interface) of these is a direct socket connection, the other is an IRC bot.

The socket connection is available on port 18333 (by default, set by control_port in config.yaml) on the host machine. Into this connection, commands can be pumped with a newline as the terminating character. For instance:

echo list-teams | nc localhost 18333

Because it sucks to have to pipe things through netcat, there's a wrapper cli that can be used instead:

./command list-teams

The IRC bot is optionally enabled via the irc.enable configuration option, and expects that commands will be prefixed by an exclamation mark (!). The channel the bot sits in (etc.) are also controlled by configuration options in the same place. It can be used as follows:

!list-teams

Credit

This implementation done through effective slave labour by Alistair Lynn.

With thanks to Rob Spanton, Scarzy, Sam Phippen, Edd Seabrook and Ben Clive for ideas and work on the previous iterations.