cgeditor/README.md

[![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/keyboard events.

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

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

See example for more informations.

# Example
An example based on *wxWidgets* is available in the `examples/` folder:
![wxWidgets](examples/wxWidgets/demo.gif)
Update 2022-02-12 19:20:02 +01:00			`[![license](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)`

Create project 2022-02-12 19:13:34 +01:00			`# cgeditor: Chess Game Editor`
Decouple editor event from the Draw class 2023-01-01 17:25:27 +01:00			`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/keyboard events.`
Create project 2022-02-12 19:13:34 +01:00
			`# Features`
Decouple editor event from the Draw class 2023-01-01 17:25:27 +01:00			`- Show move, move number, variations, NAGs, comments etc.`
			`- Delete, Promote and Set as main line menu entries`
Create project 2022-02-12 19:13:34 +01:00			`- Handle pieces icons`
			`- Its graphical appareance is entirely customizable`

			`# Architecture`
Decouple editor event from the Draw class 2023-01-01 17:25:27 +01:00			`To run cgeditor 2 classes need to be extended:`
Create project 2022-02-12 19:13:34 +01:00			`- CGEditor (To draw and handle events)`
			`- CGEHalfMove (The data structure displayed by the editor)`

Decouple editor event from the Draw class 2023-01-01 17:25:27 +01:00			`See example for more informations.`

Create project 2022-02-12 19:13:34 +01:00			`# Example`
			An example based on wxWidgets is available in the `examples/` folder:
			`![wxWidgets](examples/wxWidgets/demo.gif)`