Skip to content

Commit

Permalink
convert readme
Browse files Browse the repository at this point in the history
  • Loading branch information
John Lindal committed Mar 16, 2012
1 parent 3666c3b commit d9d8450
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
15 changes: 7 additions & 8 deletions README → README.md
@@ -1,3 +1,6 @@
Board War
=========

Game engine built on NodeJS that supports a diverse class of games
including TicTacToe, Monopoly, WizWar, and miniatures war gaming.

Expand All @@ -12,9 +15,8 @@ Access to IM clients makes it hopeless to restrict in-game communication,
no matter how interesting it would be for game balance, so the engine does
not try to foster any illusions.

---

Installation
------------

Install nodejs:

Expand All @@ -24,9 +26,8 @@ Install nodejs packages:

npm install yui3 socket.io express ejs optimist long-stack-traces

---

Usage
-----

Start the server:

Expand All @@ -40,9 +41,8 @@ Connect from the browser:
Type your player name and press return, and you will enter the game. The
first player is the admin who controls the player list and starts the game.

---

Code Organization
-----------------

boardwar.js Main server code
client Client modules
Expand All @@ -59,9 +59,8 @@ server Server modules
views Client web pages
boardwar.js The web page with which players interact

---

Data Structures
---------------

game_config stores all the configuration loaded from the game config
directory:
Expand Down
2 changes: 1 addition & 1 deletion games/squares/board
Expand Up @@ -3,7 +3,7 @@ square

%%

draw.floor = document.getElementById('floor_tile.jpeg');
draw.floor = Y.config.doc.getElementById('floor_tile.jpeg');

draw.square = function(obj, ctx)
{
Expand Down

0 comments on commit d9d8450

Please sign in to comment.