https://github.com/dmeybohm/wisdom-chess
Simple multiplatform C++ chess program.
https://github.com/dmeybohm/wisdom-chess
chess chess-engine chess-engine-gui
Last synced: 3 months ago
JSON representation
Simple multiplatform C++ chess program.
- Host: GitHub
- URL: https://github.com/dmeybohm/wisdom-chess
- Owner: dmeybohm
- License: mit
- Created: 2021-06-18T16:12:49.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T04:41:18.000Z (about 1 year ago)
- Last Synced: 2024-05-01T23:55:20.269Z (about 1 year ago)
- Topics: chess, chess-engine, chess-engine-gui
- Language: C++
- Homepage:
- Size: 2.86 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Wisdom Chess
----
Wisdom Chess is a simple multiplatform chess engine written in C++ with a React web front-end and a Qt
mobile and desktop front-end.
View the web version at https://wisdom-chess.netlify.app
## Building the web version
To build the web version, you'll first need to compile the C++ library with [Emscripten](https://emscripten.org/).
You also need to compile some dependencies using the [conan](https://conan.io/) package manager.
### Setting up Emscripten
See [emscripten's website](https://emscripten.org/) for how to install emscripten.
### Setting up Conan
See [conan's website](https://conan.io/) for how to install conan.
After installing, you can follow these instructions to link conan with Emscripten:
https://docs.conan.io/en/1.53/integrations/cross_platform/emscripten.html
Conan version 1 has been tested successfully - Conan 2 may not work yet.
### Building the C++ library for emscripten
First, activate the emscripten environment. Then build with the emscripten compiler:
```bash
$ mkdir build
$ cd build
# Install packages needed to build
$ conan install .. -pr:b=emscripten -s build_type=Release # specify build profile
$ emcmake cmake .. -DCMAKE_BUILD_TYPE=Release
$ cmake --build . -j 8
```
If you want a debug version instead of a release version replace "Release" with "Debug".
### Building the web front-end
To build the web front-end, use (yarn)[https://yarnpkg.com/]
```bash
cd ui/react
yarn install
yarn dev
```
## Building desktop version
For the UI, `wisdom-chess` uses [Qt](https://www.qt.io/), specifically Qt version 6.
You can either use [CMake](https://cmake.org/) or Qt Creator (provided by Qt) in order
to build. You will need to some supplemental libraries, for which you can use the
[Conan package manager](https://conan.io/) ([vcpkg](https://vcpkg.io/) might work also,
but hasn't been tested.
Here's an example set of build commands:
```sh
mkdir build
cd build
# Install packages needed to build
conan install .. -pr:b=default # specify build profile
cmake -DQTDIR=C:\path\to\Qt\6.5.0 ..
cmake --build . -j 8
```
For Qt Creator on desktop, you should just have to setup the appropriate "kit"
and then click "Build." See below for notes on building for Android, and see
[this document](wasm/README.md) for notes on building the web assembly version.
## Building on Android
You can build on Android using Qt Creator.
You need to set up your Kit to point to Android and install the appropriate
libraries for Qt/QML there. See [this "Getting Started" document](https://doc.qt.io/qt-6/android-getting-started.html)
for how to use Qt on Android.
## Running
## Running Tests
If you want to run the tests, there are two binaries produced called
`fast_tests` and `slow_tests`. You have to pass some flags to CMake
in order to enable those :
```sh
cmake -DWISDOM_CHESS_FAST_TESTS=On -DWISDOM_CHESS_SLOW_TESTS=On ..
cmake --build . -j 8
```
Make sure to run the `slow_tests` on optimized code, or
you may have to wait a long time.
### Copyright Info
Images copyright Colin M.L. Burnett and used under creative commons license.
https://creativecommons.org/licenses/by-sa/3.0/
Some icons are from https://boxicons.com/ and used by Creative Commons 4.0
license.
The chess program itself is released under the MIT license.