From 055410c0e0c1297612ce9677331d012af2226fac Mon Sep 17 00:00:00 2001 From: Loic Guegan Date: Fri, 12 May 2023 15:29:04 +0200 Subject: Improve doxygen documentation --- tools/doxygen/BoardTheming.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) (limited to 'tools/doxygen/BoardTheming.md') diff --git a/tools/doxygen/BoardTheming.md b/tools/doxygen/BoardTheming.md index 0bdb857..a7de422 100644 --- a/tools/doxygen/BoardTheming.md +++ b/tools/doxygen/BoardTheming.md @@ -1,4 +1,21 @@ Board Theming ====== -TBA \ No newline at end of file +In OChess, every board skins (squares and pieces) are made of *200x200* pixels tiles stored in .png images. OChess is in charge of breaking these tiles apart into individual elements. + +### Squares +Squares skins are .png images, with a dimension of *400x200* pixels (2 tiles next to each other). The tile starting at pixel (0,0) are for dark squares and the other one for light squares. + +### Pieces + +Pieces skins are .png images, with a dimension of *400x1200* pixels (2 columns of 6 tiles). The first column, starting at pixel (0,0) are for black pieces and the other column for the white pieces. From top, to bottom pieces are in the following order: King, Queen, Rook, Bishop, Knight, Pawn. + +### Create a Skin with generate.sh + +To create a pieces skin named *myskin*, create the folder `tools/skin/pieces/myskin`. In this folder, place all the pieces in the .svg format with the following name convention: `bb.svg` for black bishop, `wk.svg` for white king, `wn.svg` for white knight, `bn.svg` for black knight,... + +Then, run the `tools/skin/generate.sh` script. This script will combine the .svg file into a single .png file located in `tools/assets/pieces/myskin.png`. + +Use the same approach to create boards skins. + +**Note:** The `tools/skin/generate.sh` script is meant to be used on Linux Distributions and requires [Bash](https://www.gnu.org/software/bash/), [ImageMagick](https://imagemagick.org/) and [Inkscape](https://inkscape.org/). \ No newline at end of file -- cgit v1.2.3