X-Git-Url: http://git.tremily.us/?p=pyrisk.git;a=blobdiff_plain;f=README;fp=README;h=0b1f69e7480c6a14e25a80da8a173b8b16989988;hp=0000000000000000000000000000000000000000;hb=675cecc409f97e0ddf84ae730839d3183793b0e2;hpb=3b82ee3e390f9682e6180158970422ca93457e4c diff --git a/README b/README new file mode 100644 index 0000000..0b1f69e --- /dev/null +++ b/README @@ -0,0 +1,53 @@ +PyRisk +====== + +This is a Python engine and interface for building games similar to +Albert Lamorisse's 1957 La Conquête du Monde. The game is perhaps +better known as Risk, and is produced by Parker Brothers (now a +division of Hasbro). + +Benefits over other open source implementations: + + * simple, extensible implementation + * play-by-email + + +Getting PyRisk +============== + +PyRisk is available as a Git repository:: + + $ git clone http://www.physics.drexel.edu/~wking/code/git/pyrisk.git + +The most recent commit is also available as a gzipped tarball at:: + + http://www.physics.drexel.edu/~wking/code/tar/pyrisk.tgz + +Once you get the source, installation is via Docutils:: + + pyrisk$ python setup.py build + pyrisk$ python setup.py install + + +Getting started +=============== + +To setup play-by-email, you'll have to have some method to redirect +appropriate messages into a named pipe. With procmail, that will +look something like:: + + :0 + * ^Subject: *Re:* [PyRisk* + | >> /path/to/named/pipe + +Then just add your EmailPlayers to your game and go:: + + import pyrisk.base as b; + import pyrisk.player.email as e; + world = generate_earth() + players = [EmailPlayer('Alice', 'alice@example.com', 'server@example.com'), + EmailPlayer('Bob', 'bob@big.edu', 'server@example.com'), + Player('Charlie')] + e = Engine(world, players) + e.run() +