Updated readme
authorJustin Worthe <justin.worthe@gmail.com>
Sun, 21 Sep 2014 07:34:57 +0000 (09:34 +0200)
committerJustin Worthe <justin.worthe@gmail.com>
Sun, 21 Sep 2014 07:34:57 +0000 (09:34 +0200)
Gruntfile.js
README.md
config.json [deleted file]
game/main.js
package.json
todo.md

index 1dfd9b1..d4ea066 100644 (file)
@@ -1,6 +1,5 @@
 // Generated on 2014-03-28 using generator-phaser-official 0.0.8-rc-2
 'use strict';
-var config = require('./config.json');
 var _ = require('underscore');
 _.str = require('underscore.string');
 
index ffaccc8..53c3d7f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,14 @@ Interactive Pacbot
 ==================
 
 HTML5 game implementation of the Entelect 100k challenge for 2014 (http://challenge.entelect.co.za/).
+This game is written in JavaScript using the Phaser game engine. It can be played here: http://jworthe.github.io/InteractivePacbot
 
-Players take turns giving commands to their Pac-Bots. At the end of the game, the player who has managed to eat the most pills is the winner.
+The Rules
+---------
 
-This is currently a work in progress.
+1. It's turn based. Yellow goes first.
+2. The player with the most points wins.
+3. Small pills are worth 1 point, and big pills are worth 10 points.
+4. Each player has a poison pill that they can drop behind them. If a player eats a poison pill, they are teleported to the respawn zone in the middle of the map.
+5. If a player moves to eat their opponent, the opponent is teleported to the respawn zone in the middle of the map.
+6. If you want to start a new game, pressing ESC will reset the game to its initial state.
diff --git a/config.json b/config.json
deleted file mode 100644 (file)
index 51a4efa..0000000
+++ /dev/null
@@ -1,5 +0,0 @@
-{
-  "projectName": "Interactive Pacbot",
-  "gameWidth": "1750",
-  "gameHeight": "1100"
-}
\ No newline at end of file
index 16071ff..d72ec04 100644 (file)
@@ -7,6 +7,5 @@ window.onload = function () {
   game.state.add('load', require('./states/load'));
   game.state.add('play', require('./states/play'));
   
-
   game.state.start('boot');
 };
\ No newline at end of file
index 0128a7c..ab3a636 100644 (file)
@@ -24,8 +24,8 @@
     "title": "Interactive Pacbot",
     "toolbar": false,
     "frame": true,
-    "width": 1100,
-    "height": 950,
+    "width": 1750,
+    "height": 1100,
     "position": "center"
   }
 }
\ No newline at end of file
diff --git a/todo.md b/todo.md
index 46a0ffb..3be4806 100644 (file)
--- a/todo.md
+++ b/todo.md
@@ -1,5 +1,4 @@
 TODO
 ====
 
-* Refine orientation controls
-* Read in game playback
+* Refactor