From 30bbfbc87310279982196296b18fe2a2081e8681 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 17 Apr 2021 20:51:02 +0000 Subject: mahjong (17apr21) git-svn-id: svn://tug.org/texlive/trunk@58896 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/mahjong/README.md | 76 +++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 Master/texmf-dist/doc/latex/mahjong/README.md (limited to 'Master/texmf-dist/doc/latex/mahjong/README.md') diff --git a/Master/texmf-dist/doc/latex/mahjong/README.md b/Master/texmf-dist/doc/latex/mahjong/README.md new file mode 100644 index 00000000000..ead057bbfe1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/mahjong/README.md @@ -0,0 +1,76 @@ +# mahjong-tex + +[![CTAN](https://img.shields.io/ctan/v/mahjong)](https://ctan.org/pkg/mahjong) + +A LaTeX 3 package for typesetting mahjong hands using MPSZ algebraic notation. +This package provides an interface for LaTeX 2e, so you can use it without any experience in LaTeX 3. + +![A display of all tiles used for Riichi Mahjong](doc/all_tiles.png) + +This package focuses on Riichi (a.k.a. Japanese) Mahjong but can be used to typeset any style. +However, flower tiles are currently missing. + +## Usage +``` +\usepackage{mahjong} +\mahjong{} +``` +Insert mahjong tiles as specified by ``. For instance, +``` +\mahjong{119p 19s 19m 1234567z} +``` +produces an image of the "Thirteen Orphans" hand with a pair of 1 dots. + +![A row of mahjong tiles: 1 dots, 1 dots, 9 dots, 1 bamboo, 9 bamboo, 1 character, 9 character, east wind, south wind, west wind, north wind, white dragon, green dragon, and red dragon](doc/13orphans.png) + +Additional supported features are: + +* Red fives +* Concealed tiles +* Spaces +* Blank tiles +* Rotated tiles (90° counter-clockwise) +* Stacked, rotated tiles + +``` +\mahjong{X44Xp-123's-50"5m-33?z} +``` +![4 groups of mahjong tiles separated by spaces. +Group 1: A concealed tile, showing its red backside, 4 dots, 4 dots, concealed tile. +Group 2: 1 bamboo, 2 bamboo, 3 bamboo, rotated 90° counter-clockwise. +Group 3: 5 character, two red 5 character, rotated 90° counter-clockwise and stacked, 5 character. +Group 4: south wind, south wind, a tile with a question mark.](doc/expansions.png) + +The size of the typeset hand can be changed. +Either locally as an optional argument to `\mahjong` or as a package option. + +## Prerequisites +You need a sufficiently recent version of LaTeX which ships with the L3 programming layer. +This applies to all version released after October 2019. + +mahjong depends on stackengine, which is included in all major TeX distributions. + +## Building +A simple invocation of make is enough to produce a zip file in `out/` which can be submitted to CTAN. +``` +make +``` + +## Installation +Run +``` +make install +``` + +to install the package to your local texmf directory. +It should be available for use in your documents. + +Run +``` +texdoc mahjong +``` +to get an introduction to the package, including the extended flavor of MPSZ notation this package uses. + +## Attribution +The mahjong tiles used in this package were created by [@FluffyStuff](https://github.com/FluffyStuff). +The original repository is [FluffyStuff/riichi-mahjong-tiles](https://github.com/FluffyStuff/riichi-mahjong-tiles), used under CC-BY. \ No newline at end of file -- cgit v1.2.3