octothorpe-xo v1.0.0

Octothorpe X/O

A game of tic-tac-toe.

The game will alternate between whose turn it is after each mark is placed. It evaluates if the game has been won or came to a draw.

Example

let Game = require('octothorpe-xo'),
  game = new Game();

game.turn;
// 1

game.mark(1, 1);
// marks top left with X

game.markAt(1, 1);
// X

game.nextMark;
// O

game.mark(2, 1);
// marks top center with O

game.mark(1, 2);
game.mark(3, 1);
game.mark(1, 3);

game.hasEnded;
// true

game.winner;
// X

game.toString();
/*
 X | O | O
-----------
 X |   |
-----------
 X |   |
*/

game.reset();
// board is reset

Installation

$ npm install octothorpe-xo

API

var Game = require('octothorpe-xo');

.canMark(x, y)

Evaluates if the specified cell is empty.

.hasEnded

Evaluates if the game has a winner, or the board is full.

.mark(x, y)

Places a mark at the specified coordinates.

.markAt(x, y)

Returns the mark that is occupying the specified cell.

.nextMark

The next mark that will be placed on the board.

.reset()

Wipes the board and starts a new game.

.toString()

Returns a text version of the game drawn out.

 X | O | O
-----------
 X |   |
-----------
 X |   |

.turn

The turn that the player is taking, starting with 1 on a new game.

.winner

The mark that won the game.