tictactoe-minimax-ai

What does it do?

tictactoe-minimax-ai provides an api for computing the best move for a computer to play in a game of tictactoe.

Methods:

bestMove(gameBoard /2d matrix representing the current game state of the board/, options)

Returns the position that has the highest chance of winning (See figures under ## Examples)
Note: By default, computer is x and player is o. Empty positions are represented by the character _ (underscore).

The argument options should be an object containing the following:

• computer: the character used to represent the computer
• opponent: the character used to represent to opponent / player

Example:

const tictactoe = require('tictactoe-minimax-ai');
 
let options = {
    "computer": "o",
    "opponent": "x"
};
 
console.log(tictactoe.bestMove(data, options));

This sets the character that represents the computer to "o" and the one for the player to "x".

Note: By default, computer is always "x" and player is always "o".

boardEvaluate(gameBoard /same as previous/)

Returns the current state of the game. Possible return values:

• "win" (for computer)
• "loss"
• "tie"
• "none"

The structure of the return value is an object with a data member "status".

Examples:

const tictactoe = require('tictactoe-minimax-ai');
// array representation of the game board
let data = [
    ['o','_','_'],
    ['_','x','_'],
    ['_','_','_']];
 
let options = {
    "computer": "o",
    "opponent" "x"
};
 
console.log(tictactoe.bestMove(data, options)); // prints out lcation for best move
 
console.log(tictactoe.boardEvaluate(data)); // returns either "tie", "win", "loss", "none". Expected "none"

console.log(tictactoe.bestMove(data)); logs 8 in the console because tictactoe.bestMove() returns the best location for the computer if the scenario was:

O	_	_
_	X	_
_	_	_

The 8 represents the bottom right position. More return options will be added in futur versions.

console.log(tictactoe.boardEvaluate(options)); logs:

{
    "status": "none"
}

because the game still hasn't finished.

Installation:

You can install Smart-TicTacToe like any other npm module:

npm i tictactoe-minimax-ai

tictactoe-minimax-ai requires node-gyp to compile from source. Visit the node-gyp package page for details.

License:

Copyright 2019 <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.