mirror of
https://github.com/tiyn/yeschess.git
synced 2025-04-01 14:47:44 +02:00
6ad11fde2a
Documentation is now set for every method with complete parameters. Also all global variables and constants as well as types are documented.
ychess
Attention: The Chess engine is not finished yet.
ychess is a chess implementation and engine written in nim.
Usage
Simply download the code and run nim c -r game.nim.
You can now play a 1v1 hotseat game of chess in the commandline.
Testing
Testing is done by einheit by jyapayne.
All legal chess moves are implemented in chess.nim and tested by the TestSuite
in test.nim.
You can simply run the tests with nim c -r test.nim.
Documentation
Documentation is written into the code via DocGen.
For this reason it is not saved in this repository.
To extract it into html run nim doc --project --index:on --outdir:htmldocs game.nim
Board Representation
Due to easier off the board checking a 10x12 board is used.