Skip to content

ActuallyConnor/php-chess

 
 

Repository files navigation

PHP Chess

Latest Stable Version Build Status License: GPL v3

A chess library for PHP.

Install

Via composer:

$ composer require chesslablab/php-chess

Documentation

Read the latest docs here.

Demo

PHP Chess is being used on Redux Chess, which is a React chessboard connected to a PHP Chess Server. Check out this demo.

Please note the sandbox server might not be up and running all the time.

Play Chess

use Chess\Game;

$game = new Game();

$game->play('w', 'e4');
$game->play('b', 'e5');

The call to the $game->play method returns true or false depending on whether or not a chess move can be run on the board.

Play Chess With an AI

Pass the Game::MODE_AI parameter when instantiating a $game:

$game = new Game(Game::MODE_AI);

$game->play('w', 'e4');
$game->play('b', $game->response());
$game->play('w', 'e5');
$game->play('b', $game->response());

The AIs are stored in the model folder. The default is a1.model, if you want to play with a different AI pass it as a second parameter to the Chess\Game constructor:

$game = new Game(Game::MODE_AI, 'a2.model');

$game->play('w', 'e4');
$game->play('b', $game->response());
$game->play('w', 'e5');
$game->play('b', $game->response());

License

The GNU General Public License.

Contributions

See the contributing guidelines.

Happy learning and coding! Thank you, and keep it up.


For further information you're invited to read my learning journey:

About

A chess library for PHP.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%