riichi 0.1.0

Japanese Riichi Mahjong game engine
Documentation 
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299

/// An non-exhaustive list of Yaku's (役) known to this crate.
/// <https://riichi.wiki/Yaku>
#[derive(
    Copy,
    Clone,
    Debug,
    Eq,
    PartialEq,
    Hash,
    strum::FromRepr,
    strum::AsRefStr,
    strum::IntoStaticStr,
    strum::Display,
)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
#[repr(u16)]
pub enum Yaku {
    /// 門前清自摸和
    /// <https://riichi.wiki/Menzenchin_tsumohou>
    #[strum(to_string = "門前清自摸和")]
    Menzenchintsumohou,

    /// 立直 / リーチ
    /// <https://riichi.wiki/Riichi>
    #[strum(to_string = "立直")] // tenhou
    #[strum(serialize = "リーチ")] // katakana
    Riichi,

    /// 一発
    /// <https://riichi.wiki/Ippatsu>
    #[strum(to_string = "一発")]
    Ippatsu,

    /// 槍槓
    /// <https://riichi.wiki/Chankan>
    #[strum(to_string = "槍槓")]
    Chankan,

    /// 嶺上開花
    /// <https://riichi.wiki/Rinshan_kaihou>
    #[strum(to_string = "嶺上開花")]
    Rinshankaihou,

    /// 海底摸月 / 海底撈月
    /// - <https://riichi.wiki/Haitei_raoyue_and_houtei_raoyui>
    /// - <https://ja.wikipedia.org/wiki/海底_(麻雀)#海底摸月>
    #[strum(to_string = "海底摸月")] // tenhou
    #[strum(serialize = "海底撈月")] // common alternative
    Haiteimouyue,

    /// 河底撈魚
    /// - <https://riichi.wiki/Haitei_raoyue_and_houtei_raoyui>
    /// - <https://ja.wikipedia.org/wiki/海底_(麻雀)#河底撈魚>
    #[strum(to_string = "河底撈魚")]
    Houteiraoyui,

    /// 平和
    /// <https://riichi.wiki/Pinfu>
    #[strum(to_string = "平和")]
    Pinfu,

    /// 断幺九 / 断么九 / 断ヤオ九 / ...
    /// <https://riichi.wiki/Tanyao>
    #[strum(to_string = "断幺九")] // tenhou
    #[strum(serialize = "断么九")] // common alternative
    #[strum(serialize = "断ヤオ九")] // common alternative
    Tanyaochuu,

    /// 一盃口
    /// <https://riichi.wiki/Iipeikou>
    #[strum(to_string = "一盃口")]
    Iipeikou,

    /// 場風 _(unspecified self wind)_
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "役牌:自風牌")] // majsoul
    JikazehaiAny,

    /// 自風 東 (Self East)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "自風 東")]
    JikazehaiE,

    /// 自風 南 (Self South)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "自風 南")]
    JikazehaiS,

    /// 自風 西 (Self West)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "自風 西")]
    JikazehaiW,

    /// 自風 北 (Self North)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "自風 北")]
    JikazehaiN,

    /// 場風 _(unspecified prevalent wind)_
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "役牌:場風牌")] // majsoul
    BakazehaiAny,

    /// 場風 東 (Prevalent East)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "場風 東")]
    BakazehaiE,

    /// 場風 南 (Prevalent West)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "場風 南")]
    BakazehaiS,

    /// 場風 西 (Prevalent West)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "場風 西")]
    BakazehaiW,

    /// 場風 北 (Prevalent North)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "場風 北")]
    BakazehaiN,

    /// 役牌 白 (White Dragon)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "役牌 白")]
    SangenpaiHaku,

    /// 役牌 發 (Green Dragon)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "役牌 發")]
    SangenpaiHatsu,

    /// 役牌 中 (Red Dragon)
    /// <https://riichi.wiki/Yakuhai>
    #[strum(to_string = "役牌 中")]
    SangenpaiChun,

    /// 両立直
    /// <https://riichi.wiki/Daburu_riichi>
    #[strum(to_string = "両立直")] // tenhou
    #[strum(serialize = "ダブル立直")] // majsoul (half katakana)
    #[strum(serialize = "ダブルリーチ")] // majsoul (full katakana)
    #[strum(serialize = "W立直")] // common alternative (W = double)
    #[strum(serialize = "Wリーチ")] // common alternative (W = double)
    DoubleRiichi,

    /// 七対子 (Seven Pairs)
    /// <https://riichi.wiki/Chiitoitsu>
    #[strum(to_string = "七対子")]
    Chiitoitsu,

    /// 混全帯幺九
    /// <https://riichi.wiki/Chanta>
    #[strum(to_string = "混全帯幺九")]
    Honchantaiyaochuu,

    /// 一気通貫
    /// <https://riichi.wiki/Ikkitsuukan>
    #[strum(to_string = "一気通貫")]
    Ikkitsuukan,

    /// 三色同順
    /// <https://riichi.wiki/Sanshoku_doujun>
    #[strum(to_string = "三色同順")]
    Sanshokudoujun,

    /// 三色同刻
    /// <https://riichi.wiki/Sanshoku_doukou>
    #[strum(to_string = "三色同刻")]
    Sanshokudoukou,

    /// 三槓子
    /// <https://riichi.wiki/Sankantsu>
    #[strum(to_string = "三槓子")]
    Sankantsu,

    /// 対々和
    /// <https://riichi.wiki/Toitoihou>
    #[strum(to_string = "対々和")]
    Toitoihou,

    /// 三暗刻
    /// <https://riichi.wiki/Sanankou>
    #[strum(to_string = "三暗刻")]
    Sannankou,

    /// 小三元
    /// <https://riichi.wiki/Shousangen>
    #[strum(to_string = "小三元")]
    Shousangen,

    /// 混老頭
    /// <https://riichi.wiki/Honroutou>
    #[strum(to_string = "混老頭")]
    Honroutou,

    /// 二盃口
    /// <https://riichi.wiki/Ryanpeikou>
    #[strum(to_string = "二盃口")]
    Ryanpeikou,

    /// 純全帯幺九
    /// <https://riichi.wiki/Junchantaiyaochuu>
    #[strum(to_string = "純全帯幺九")]
    Junchantaiyaochuu,

    /// 混一色
    /// <https://riichi.wiki/Honiisou>
    #[strum(to_string = "混一色")]
    Honniisou,

    /// 清一色
    /// <https://riichi.wiki/Chiniisou>
    #[strum(to_string = "清一色")]
    Chinniisou,

    /// 天和
    /// <https://riichi.wiki/Tenhou_and_chiihou>
    #[strum(to_string = "天和")]
    Tenhou,

    /// 地和
    /// <https://riichi.wiki/Tenhou_and_chiihou>
    #[strum(to_string = "地和")]
    Chiihou,

    /// 人和 _(non-standard)_
    /// <https://riichi.wiki/Renhou>
    #[strum(to_string = "人和")]
    Renhou,

    /// 大三元
    /// <https://riichi.wiki/Daisangen>
    #[strum(to_string = "大三元")]
    Daisangen,

    /// 四暗刻
    /// <https://riichi.wiki/Suuankou>
    #[strum(to_string = "四暗刻")]
    Suuankou,

    /// 四暗刻単騎
    /// <https://riichi.wiki/Suuankou>
    #[strum(to_string = "四暗刻単騎")]
    SuuankouTanki,

    /// 字一色
    /// <https://riichi.wiki/Tsuuiisou>
    #[strum(to_string = "字一色")]
    Tsuuiisou,

    /// 緑一色
    /// <https://riichi.wiki/Ryuuiisou>
    #[strum(to_string = "緑一色")]
    Ryuuiisou,

    /// 清老頭
    /// <https://riichi.wiki/Chinroutou>
    #[strum(to_string = "清老頭")]
    Chinroutou,

    /// 九蓮宝燈
    /// <https://riichi.wiki/Chuuren_poutou>
    #[strum(to_string = "九蓮宝燈")]
    Chuurenpoutou,

    /// 純正九蓮宝燈
    /// <https://riichi.wiki/Chuuren_poutou>
    #[strum(to_string = "純正九蓮宝燈")]
    Junseichuurenpoutou,

    /// 国士無双
    /// <https://riichi.wiki/Kokushi_musou>
    #[strum(to_string = "国士無双")]
    Kokushi,

    /// 国士無双１３面
    /// <https://riichi.wiki/Kokushi_musou>
    #[strum(to_string = "国士無双１３面")] // tenhou
    #[strum(serialize = "国士無双十三面待ち")] // majsoul
    Kokushi13,

    /// 大四喜
    /// <https://riichi.wiki/Suushiihou>
    #[strum(to_string = "大四喜")]
    Daisuushi,

    /// 小四喜
    /// <https://riichi.wiki/Suushiihou>
    #[strum(to_string = "小四喜")]
    Shousuushi,

    /// 四槓子 (Four Kans)
    /// <https://riichi.wiki/Suukantsu>
    #[strum(to_string = "四槓子")]
    Suukantsu,
}