p-chess / chess-bundle
Provide integration with p-chess/chess library
Installs: 28
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 0
Open Issues: 0
Type:symfony-bundle
Requires
- php: ^8.0
- p-chess/chess: ^0.4
- symfony/config: ^5.4 || ^6.4 || ^7.0
- symfony/dependency-injection: ^5.4 || ^6.4 || ^7.0
- symfony/http-kernel: ^5.4 || ^6.4 || ^7.0
- symfony/routing: ^5.4 || ^6.4 || ^7.0
- twig/twig: ^3.0
Requires (Dev)
- dg/bypass-finals: ^1.3
- phpunit/phpunit: ^9.6
- symfony/phpunit-bridge: ^7.0
This package is auto-updated.
Last update: 2024-11-03 15:44:35 UTC
README
Installation
Run composer require p-chess/chess-bundle
Configuration
Create a service that extends PChess\ChessBundle\HtmlOutput
and
implements required methods.
You probably want to inject Symfony's router service here, and use it
to return required URLs.
Note that each route can be provided with an identifier for your game.
Create a configuration file, and use a content like the following:
# config/packages/chess.yaml chess: output_service: App\YourOutputService
This is an example of how routes can be defined (using an "id" parameter as identifier):
# config/routes.yaml move_start: path: /{id}/move/{from} methods: GET controller: ... # your controller action move_cancel: path: /{id} methods: GET controller: ... # your controller action move_promotion: path: /{id}/promote/{from}/{to} methods: GET controller: ... # your controller action move_end: path: /{id}/move/{from}/{to}/{promotion} methods: GET controller: ... # your controller action defaults: promotion: ~
Usage
You can inject a service implementing \PChess\ChessBundle\ChessProviderInterface
in your controller, then
implement different actions, using provided \PChess\Chess\Chess
object.
In your template, you can use Twig function chess_render(chess)
to render the board.
If you need to pass an identifier, use chess_render(chess, identifier)
instead.
The main service you can use is \PChess\ChessBundle\SessionChessProvider
.
This service allows you to keep chess games in session, providing following methods:
getChess($identifier, $fen)
to get main\PChess\Chess\Chess
instance (as provided by interface)restart($identifier)
to restart the gamesave($identifier)
to save the game in sessionreverse($identifier)
to switch sidesgetAllowedMoves($chess, $from)
to get a list of currently allowed moves (optionally limited to$from
square)
Using $identifier
is not mandatory.
Styling
You can use provided _board.scss
file to style the board:
@import '~@p-chess/chess-bundle/scss/board';
Don't forget to update your frontend files, using npm or yarn.
The final result should be something like this:
Persisting a Chess object
You can easily save a Chess
object into Doctrine (or other kind of mapping libraries), using two fields/properties:
fen
, and history
.
The first one is a simple string. The second one can be a simple_array
(for Doctrine), where you should put
the result of Mover::getHistoryStrings()
method.
When retrieving an object, you should use fen
and the result of Mover::getHistoryEntries()
to build back your
Chess
object.