aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b092ac23670101b502c2528b140a007340dcfebe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[![license](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)

# cgeditor: Chess Game Editor
cgeditor is a dependency-free chess game editor library written in C++. It can be used with any library that provides 2D canvas drawing and mouse inputs features.

# Features
- Show move,move number, variations, comments etc.
- *Delete*, *Promote* and *Set as main line* features
- Handle pieces icons
- Its graphical appareance is entirely customizable

# Architecture
To run cgeditor you need to extend 2 classes:
- CGEditor (To draw and handle events)
- CGEHalfMove (The data structure displayed by the editor)

# Example
An example based on *wxWidgets* is available in the `examples/` folder:
![wxWidgets](examples/wxWidgets/demo.gif)