ajayat/minichess

A terminal-based chess program using Stockfish engine

MiniChess Project

Authors: Adrien Jayat

A chess game in C++ with a colorful CLI.

Implements all the rules defined by the Internal Chess Federation.

Get Started

This project is using two submodules:

• the Doxygen Awesome theme for the Doxygen documentation generation tool.

• the Stockfish chess engine.

First, clone the project and its submodules:

git clone https://gitlab.unistra.fr/jayat/minichess-project
cd minichess-project
git submodule init && git submodule update

Dependencies

Install make, gcc, doxygen and graphviz with your package manager :

Ubuntu

sudo apt update
sudo apt install make gcc doxygen graphviz

Arch Linux

sudo pacman -Syu
sudo pacman -S make gcc doxygen graphviz

Build

Windows

Install MinGW, CMake and make with Chocolatey, then run the following command in the project root directory:

cmake . -G "MinGW Makefiles"

Linux

cmake . -G "Unix Makefiles"

Then, run make to build the project.

To use the Stockfish engine, you need to build it with the following command:

cd Stockfish/src
make -j profile-build

You can also run make docs to generate the documentation.

Preview it with firefox docs/html/index.html for instance.

How to use

After building the project, you can run the ./echecs executable to start the program.

Options

The program accepts the following options:

Option	Description
--engine	Black are played by the Stockfish engine.

Tests

To test the program, you can run the test-level.sh script in the tests directory. For example, to test the level 1, run the following command:

cd tests && bash test-level.sh 1 ../echecs