README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# Open Chess &nbsp; [![Pipeline](https://gitlab.com/manzerbredes/ochess/badges/master/pipeline.svg)](https://gitlab.com/manzerbredes/ochess/pipelines) [![Pipeline](https://img.shields.io/badge/cmake-v3.10-blue)](https://cmake.org/download/) [![Pipeline](https://img.shields.io/badge/wxWidgets-v3.0.4-blue)](https://www.wxwidgets.org/)

![Screenshot](tools/assets/icons/screenshot.jpg)

## Features
 - PGNs files (*.si4* files not yet but soon!)
 - Handle heavy game files
 - Live chess engine analysis with *UCI* compliant chess engines
 - Intuitive game annotations
 - Simple database management system 

## Installation
Requires *CMake* and *wxWidgets*:

    > git clone https://gitlab.com/manzerbredes/ochess
    > cd ./ochess
    > git submodule init
    > git submodule update
    > mkdir ./build && cd ./build
    > cmake ../ && make

## Notes

- OChess is still in early development stage. For more informations, please read the `TODO.md` file.
- For questions and discussions please join [irc://irc.libera.chat/ochess](https://web.libera.chat/#ochess).

## Satellites projects
OChess is based on several satellite projects that implement individual and independant features:
 - [chessarbiter](https://gitlab.com/manzerbredes/chessarbiter): A chess game rule and board manager
 - [pgnp](https://gitlab.com/manzerbredes/pgnp): An efficient PGN parser
 - [uciadapter](https://gitlab.com/manzerbredes/uciadapter): A cross platform utility to interact with *UCI* chess engines
 - [cgeditor](https://gitlab.com/manzerbredes/cgeditor): A 2D chess game moves presenter/editor