README

   1 PyRisk
   2 ======
   3
   4 This is a Python engine and interface for building games similar to
   5 Albert Lamorisse's 1957 La Conquête du Monde.  The game is perhaps
   6 better known as Risk, and is produced by Parker Brothers (now a
   7 division of Hasbro).
   8
   9 Benefits over other open source implementations:
  10
  11   * simple, extensible implementation
  12   * play-by-email
  13
  14
  15 Getting PyRisk
  16 ==============
  17
  18 PyRisk is available as a Git repository::
  19
  20     $ git clone http://www.physics.drexel.edu/~wking/code/git/pyrisk.git
  21
  22 The most recent commit is also available as a gzipped tarball at::
  23
  24     http://www.physics.drexel.edu/~wking/code/tar/pyrisk.tgz
  25
  26 Once you get the source, installation is via Docutils::
  27
  28     pyrisk$ python setup.py build
  29     pyrisk$ python setup.py install
  30
  31
  32 Getting started
  33 ===============
  34
  35 To setup play-by-email, you'll have to have some method to redirect
  36 appropriate messages into a named pipe.  With procmail, that will
  37 look something like::
  38
  39     :0
  40     * ^Subject: *Re:* [PyRisk*
  41     | >> /path/to/named/pipe
  42
  43 Then just add your EmailPlayers to your game and go::
  44
  45     import pyrisk.base as b;
  46     import pyrisk.player.email as e;
  47     world = generate_earth()
  48     players = [EmailPlayer('Alice', 'alice@example.com', 'server@example.com'),
  49                EmailPlayer('Bob', 'bob@big.edu', 'server@example.com'),
  50                Player('Charlie')]
  51     e = Engine(world, players)
  52     e.run()
  53