diff options
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/mahjong/LICENSE | 21 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mahjong/README.md | 76 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mahjong/mahjong-code.pdf | bin | 0 -> 611151 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/mahjong/mahjong-code.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mahjong/mahjong.pdf | bin | 0 -> 511487 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/mahjong/mahjong.tex | 2 |
6 files changed, 101 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/mahjong/LICENSE b/Master/texmf-dist/doc/latex/mahjong/LICENSE new file mode 100644 index 00000000000..73b877f67b6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/mahjong/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Daniel Schmitz + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. 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{<tiles>} +``` +Insert mahjong tiles as specified by `<tiles>`. 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 diff --git a/Master/texmf-dist/doc/latex/mahjong/mahjong-code.pdf b/Master/texmf-dist/doc/latex/mahjong/mahjong-code.pdf Binary files differnew file mode 100644 index 00000000000..10401366896 --- /dev/null +++ b/Master/texmf-dist/doc/latex/mahjong/mahjong-code.pdf diff --git a/Master/texmf-dist/doc/latex/mahjong/mahjong-code.tex b/Master/texmf-dist/doc/latex/mahjong/mahjong-code.tex new file mode 100644 index 00000000000..3f35b00e9fc --- /dev/null +++ b/Master/texmf-dist/doc/latex/mahjong/mahjong-code.tex @@ -0,0 +1,2 @@ +\AtBeginDocument{\AlsoImplementation} +\input{mahjong.dtx}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/mahjong/mahjong.pdf b/Master/texmf-dist/doc/latex/mahjong/mahjong.pdf Binary files differnew file mode 100644 index 00000000000..f3bc3d44a8b --- /dev/null +++ b/Master/texmf-dist/doc/latex/mahjong/mahjong.pdf diff --git a/Master/texmf-dist/doc/latex/mahjong/mahjong.tex b/Master/texmf-dist/doc/latex/mahjong/mahjong.tex new file mode 100644 index 00000000000..dee23862376 --- /dev/null +++ b/Master/texmf-dist/doc/latex/mahjong/mahjong.tex @@ -0,0 +1,2 @@ +\AtBeginDocument{\OnlyDescription} +\input{mahjong.dtx}
\ No newline at end of file |