File: README.md

Recommend this page to a friend!
  Classes of Massimiliano Arione  >  PHP Chess Engine  >  README.md  >  Download  
File: README.md
Role: Example script
Content type: text/markdown
Description: Example script
Class: PHP Chess Engine
Manage the moves of a chess game
Author: By
Last change:
Date: 8 days ago
Size: 3,533 bytes
 

Contents

Class file image Download

Chess

Chess is a PHP chess library that is used for chess move generation/validation, piece placement/movement, and check/checkmate/stalemate detection - basically everything but the AI.

NOTE: this started as a port of chess.js for php, froked from ryanhs/chess.php

Latest Stable Version buddy branch MIT License

Installation

use composer with composer require p-chess/chess or put in your composer.json

"require": {
    "p-chess/chess": "^1.0"
}

Example Code

The code below plays a complete game of chess ... randomly.

<?php

require 'vendor/autoload.php';
use \PChess\Chess\Chess;
use \PChess\Chess\Output\UnicodeOutput;

$chess = new Chess();
while (!$chess->gameOver()) {
    $moves = $chess->moves();
    $move = $moves[random_int(0, count($moves) - 1)];
    $chess->move($move);
}

echo (new UnicodeOutput())->render($chess) . PHP_EOL;

   +---+---+---+---+---+---+---+---+
 8 |   | ? | ? |   |   |   |   |   | 
   +---+---+---+---+---+---+---+---+
 7 | ? |   |   |   |   |   |   |   | 
   +---+---+---+---+---+---+---+---+
 6 |   |   |   |   |   |   |   |   | 
   +---+---+---+---+---+---+---+---+
 5 |   |   |   |   |   |   |   |   | 
   +---+---+---+---+---+---+---+---+
 4 |   |   |   |   |   | ? | ? |   | 
   +---+---+---+---+---+---+---+---+
 3 | ? |   |   |   |   |   |   |   | 
   +---+---+---+---+---+---+---+---+
 2 |   |   |   |   |   |   |   |   | 
   +---+---+---+---+---+---+---+---+
 1 | ? |   |   |   | ? |   |   |   | 
   +---+---+---+---+---+---+---+---+
     a   b   c   d   e   f   g   h

Supported output formats

ASCII

Pieces are displayed with corresponding codes (e.g. "p" for pawn, "q" for queen, etc.).

<?php
// use...
$chess = new Chess();
echo (new AsciiOutput())->render($chess);

Unicode

Pieces are displayed like in the example above.

<?php
// use...
$chess = new Chess();
echo (new UnicodeOutput())->render($chess);

PNG Image

Pieces are displayed inside a png image.

<?php
// use...
$chess = new Chess();
$imagine = new \Imagine\Gd\Imagine();   // or \Imagine\Imagick\Imagine()
$output = new ImageOutput($imagine, '/your/path/to/images', 480);
header('Content-Type: image/png');  
echo $output->render($chess);

<img src="https://user-images.githubusercontent.com/179866/112304837-411be280-8c9e-11eb-8333-c2489f9bef05.png">

See dedicated documentation for a detailed instructions.

Performance

There is still a lot to do in this topic. akondas/php-grandmaster is a good place to start experiment ;)

Chess::move()

| iteration | mean | comment | | :-------: | :---: | ------- | | 1 | 548.819?s | initial | | 2 | 447.973?s | replace fen with json_encode in history position (inThreefoldRepetition cache) | 3 | 340.375?s | replace fen with json_encode in generateMoves | 4 | 333.145?s | add boardHash calculation on make/undo move | 5 | 25.917?s | :fire: add cache for moveToSAN method


For more information send a message to info at phpclasses dot org.