riichi-hand-cli 0.1.0

Cli wrapper of riichi-hand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# Riichi Hand Cli

Cli version of [riichi-hand-rs](https://github.com/m4tx/riichi-hand-rs)

---
riichi-hand-cli is a command-line tool for generating mahjong hand images. It can either save the image to a file or copy it directly to your clipboard, making it convenient for game reviews or studying mahjong books without switching between browser windows.

# Installation
```shell
cargo install riichi-hand-cli
```

# Usage
```txt
Cli wrapper of riichi-hand

Usage: riichi-hand-cli [OPTIONS] <HAND>

Arguments:
  <HAND>  Mahjong hand in human readable format --help for more information

Options:
  -n, --name <NAME>  Name and path of the image to save. If not specified, the image will be copied to clipboard
  -t, --tile <TILE>  Tile design to use [default: yellow]
  -h, --help         Print help (see more with '--help')
  -V, --version      Print version
```

```shell
# For more detailed information about HAND format
riichi-hand-cli --help
```

# example

```shell
riichi-hand-cli --name hand.png --tile yellow 123456789s567p99m
# short hand command
riichi-hand-cli -n hand.png -t yellow 123456789s567p99m
# some complex example
riichi-hand-cli -n hand.png '123456s99m_5*67p_?99s?'
```

# Attribution

This project uses modified
[riichi-mahjong-tiles](https://github.com/FluffyStuff/riichi-mahjong-tiles)
by [FluffyStuff](https://github.com/FluffyStuff) in
[public domain/CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/).

This project uses mahjong tiles by
[Martin Persson](https://www.martinpersson.org/) which are free for personal
and commercial use under the condition that a link to the author's page
is provided.