| 1 |
# MPchess |
| 2 |
|
| 3 |
This package allows you to draw chess boards and positions. The appearance of |
| 4 |
the drawings is modern and largely inspired by what is offered by the excellent |
| 5 |
web site [Lichess.org](lichess.org). Relying on METAPOST probably |
| 6 |
allows more graphic flexibility than the excellent LaTeX packages. |
| 7 |
|
| 8 |
_This package is in beta version, do not hesitate to report bugs, as well as |
| 9 |
requests for improvement_. |
| 10 |
|
| 11 |
## Github |
| 12 |
|
| 13 |
To allow for easier feedback and bug reporting, this repository has a mirror |
| 14 |
repository on github: |
| 15 |
[https://github.com/chupinmaxime/mpchess](https://github.com/chupinmaxime/mpchess) |
| 16 |
|
| 17 |
## Installation |
| 18 |
|
| 19 |
MPchess is on the [ctan](ctan.org) and can be installed via the package manager of your |
| 20 |
distribution [https://www.ctan.org/pkg/mpchess](https://www.ctan.org/pkg/mpchess). |
| 21 |
|
| 22 |
### With TeX live under Linux or MacOS |
| 23 |
|
| 24 |
To install MPchess with TeX live, you will have to create the directory texmf |
| 25 |
directory in your home. |
| 26 |
```bash |
| 27 |
user $> mkdir ~/texmf |
| 28 |
``` |
| 29 |
|
| 30 |
Then, you will have to place the .mp files in the |
| 31 |
`~/texmf/tex/metapost/mpchess/`. |
| 32 |
|
| 33 |
MPchess consists of 7 files METAPOST : |
| 34 |
* `mpchess.mp`; |
| 35 |
* `mpchess-chessboard.mp`; |
| 36 |
* `mpchess-pgn.mp`; |
| 37 |
* `mpchess-fen.mp`; |
| 38 |
* `mpchess-cburnett.mp`; |
| 39 |
* `mpchess-pieces.mp`; |
| 40 |
* `mpchess-skak.mp`. |
| 41 |
|
| 42 |
MPchess comes with a very basic chess font `mpchess font.ttf` that includes only |
| 43 |
13 glyphs. |
| 44 |
|
| 45 |
Once this is done, MPchess will be loaded with the classic |
| 46 |
```metapost |
| 47 |
input mpchess |
| 48 |
``` |
| 49 |
|
| 50 |
### With MikTEX and Windows |
| 51 |
|
| 52 |
These two systems are unknown to the author of MPchess, so we refer to their |
| 53 |
documentation to add local packages: |
| 54 |
[http://docs.miktex.org/manual/localadditions.html](http://docs.miktex.org/manual/localadditions.html) |
| 55 |
|
| 56 |
## Dependencies |
| 57 |
|
| 58 |
MPchess depends on the packages METAPOST: `hatching` and, if MPchess is not |
| 59 |
used with LuaLaTeX and luamplib, `latexmp`. |
| 60 |
|
| 61 |
## Documentation |
| 62 |
|
| 63 |
* [English documentation](doc/mpchess-doc-en.pdf) |
| 64 |
* [Documentation en français](doc/mpchess-doc-fr.pdf) |
| 65 |
|
| 66 |
### Piece Set |
| 67 |
|
| 68 |
A piece set has been designed for this package. It has also be added to |
| 69 |
[lichess.org](https://lichess.org) under the name of `mpchess`. |
| 70 |
|
| 71 |
A dedicated git repository is available: |
| 72 |
[https://plmlab.math.cnrs.fr/mchupin/mpchess-pieces](https://plmlab.math.cnrs.fr/mchupin/mpchess-pieces) |
| 73 |
and |
| 74 |
[https://github.com/chupinmaxime/mpchess-pieces](https://github.com/chupinmaxime/mpchess-pieces). |
| 75 |
|
| 76 |
A TrueType font is available. |
| 77 |
## Contact |
| 78 |
|
| 79 |
Maxime Chupin, `notezik(at)gmail.com` |
| 80 |
|
| 81 |
## Licenses |
| 82 |
|
| 83 |
This projet is under LATEX Project Public License 1.3c but the file |
| 84 |
`mpchess-cburnett` is under GPLv2+ as asked by the author. |