Renju

A Renju game engine.

Live demo

Installation

npm i renju

Usage

Quick Start

const Renju = require('./renju');
 
const game = new Renju();
 
game.play(7, 7);
game.play(7, 8);
game.play(6, 7);
game.play(8, 8);
game.play(5, 6);
game.play(9, 8);
game.play(5, 8);
game.play(10, 8);
 
game.print();
 
/*
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . B 3 B . . . . . .
. . . . . . . B . . . . . . .
. . . . . . . B W . . . . . .
. . . . . . . . W . . . . . .
. . . . . . . . W . . . . . .
. . . . . . . . W . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
. . . . . . . . . . . . . . .
*/

API

Kind: global class

• Renju
  • new Renju([board])
  • .play(i, j) ⇒ number
  • .print()
  • .getBoard() ⇒ Array.<string>
  • .getWinner() ⇒ string
  • .getDraw() ⇒ boolean

new Renju([board])

Param	Type	Default	Description
[board]	Object
[board.size]	number	15	Board size, min 6, max 100
[board.rows]	Array.<string>		Rows, i.e.: 6x6 board [ '..W.B.', '......', '..WB..', '..B.W.', '......', '......' ]

renju.play(i, j) ⇒ number

Receives a move.
If the move is not valid then returns -1.
If the move is valid and the game ends then modifies de board state and returns 1.
If the move is valid but the game must continue then modifies de board state and returns 0.

Kind: instance method of Renju
Returns: number ⇒ -1 Forbidden, 0 Accepted, 1 Game is over

Param	Type	Description
i	number	Row, >= 0, <= Board Size - 1
j	number	Colum, >= 0, <= Board Size - 1

renju.print()

Prints in console the board state.

Kind: instance method of Renju

renju.getBoard() ⇒ Array.<string>

Returns the board state.

Kind: instance method of Renju

renju.getWinner() ⇒ string

Returns 'B' if blacks player won.
Returns 'W' if whites player won.
Return null if no one won yet.

Kind: instance method of Renju

renju.getDraw() ⇒ boolean

Returns 'true' if the game ended in a tie.

Kind: instance method of Renju

License

MIT