# mahjonggame

`mahjonggame` is a LaTeX package implemented with LaTeX3 and TikZ for drawing Mahjong tiles and Mahjong game layouts.

## Installation

Place `mahjonggame.sty` in a directory searched by TeX, or in the same directory as your document. Then load the package with:

```latex
\usepackage{mahjonggame}
```

## Documentation

The complete user documentation is provided in `mahjonggame.pdf`. The source of the documentation is `mahjonggame.tex`.

## Main features

- Drawing Mahjong tiles and tile sequences with TikZ.
- Standard tile notation such as `1m`, `5s`, and `7z`.
- Compact notation such as `123m`, `456s`, and `789p`.
- Rotated, reach, and added tiles.
- Multiple visual effects through the `function` option.
- Configurable tile and game scaling.
- Four-player and three-player game layouts.
- Automatic grouping and positioning of discards, hands, calls, and flowers.
- Automatic counting of tiles placed in a game and calculation of the remaining tiles.
- Dora indicator display with automatic padding.
- Configurable table and overlay colours.
- Chinese text can be used directly in documents supported by `ctex`.

## Requirements

The package requires:

- LaTeX3 (`expl3`)
- TikZ
- `xcolor`
- `xparse`
- `ctex`

XeLaTeX or LuaLaTeX is recommended, especially when Chinese text is used.

## Repository

The development repository is available at:

<https://github.com/Clignniis/latex3-mahjong>

Bug reports and feature requests may be submitted through the GitHub issue tracker:

<https://github.com/Clignniis/latex3-mahjong/issues>

## Maintainer

Clignniis

## Contact

vceadliosr@gmail.com

## License

This package is distributed under the LaTeX Project Public License, version 1.3c or later (LPPL 1.3c+).

The latest version of the LPPL is available from:

<https://latex-project.org/lppl.txt>