README.md

   1 Peach CGT
   2 =========
   3
   4 Peach CGT simulates a card game table. It was designed for play-testing and
   5 developing rules for [WTactics](http://wtactics.org/). It makes very few
   6 assumptions about how the game works, so it may be useful/fun for other
   7 projects as well.
   8
   9 Peach CGT runs as a web server, and can host many two-player games at once.
  10
  11 Note that this is a very early development version, and many things are not
  12 supported, such as tokens, counters, dice, re-shuffling, looking through your
  13 piles, etc.. Also it might not be very reliable.
  14
  15
  16 Playing
  17 -------
  18
  19 Just open a browser and go to a web address where a Peach CGT server is
  20 running. This will create a new game for you and give you a web address to give
  21 to the other player.
  22
  23 Follow the instructions on the screen, and enjoy!
  24
  25 Note: if you suspect that you are seeing something different than the other
  26 player, you both should probably hit refresh. This early version does not
  27 always detect network errors.
  28
  29
  30 Installing/Running the Server
  31 -----------------------------
  32
  33 You usually won't need to do this to play. This section is for making it so you
  34 can host games, try modifications to the code, etc..
  35
  36 First, install these prerequisites: nodejs node-less jquery jquery-ui coffeescript
  37
  38 On debian unstable this should work:
  39
  40         # apt-get install nodejs libnode-less coffeescript libjs-jquery libjs-jquery-ui
  41
  42 To run the server (from the source directory):
  43
  44         $ coffee server.coffee
  45
  46 Which should immediately print out a web address where people can go to start a
  47 new game. If it doesn't read on...
  48
  49
  50 Troubleshooting the Server
  51 --------------------------
  52
  53 First, make sure you've got all the prerequisites as described in the section above.
  54
  55 A common problem is that the server cannot find jquery, or the parts of
  56 jquery-ui that it is looking for. Future versions of Peach CGT should be better
  57 at finding these javascript files, and may even come with some of them. For
  58 now, try fiddling with the `<script>` tags in `index.html` or hacking
  59 `javascript_handler` in server.coffee.
  60
  61
  62 License
  63 -------
  64
  65 This project is AGPLv3+. The files from the `external/` directory aren't really
  66 part of this project, they come from other projects. Please see
  67 `external/README` for details.