Crate riichi_hand

A collection of utilities for working with Riichi Mahjong player hands.

This currently includes:

• Hand representation object
• Parser that allows to quickly create a hand using human-readable string, such as 123m456p_7*77z
• Renderer that allows to draw a hand to a raster image (along with a few ready-to-use sets of tile images)

Feature flags

By default, all the crate features are enabled. You can disable some of them on demand to save on the compilation time and resulting library size.

• raster-renderer - renderer for hands that outputs raster images
• fluffy-stuff-tile-sets - ready-to-use tile sets based on FluffyStuff’s work. Greatly increases build time
• martin-persson-tile-sets - ready-to-use tile sets based on Martin Persson’s work

Example

use riichi_hand::parser::HandParser;
use riichi_hand::raster_renderer::fluffy_stuff_tile_sets::YELLOW_FLUFFY_STUFF_TILE_SET;
use riichi_hand::raster_renderer::{RasterRenderer, RenderOptions};

let hand = HandParser::parse("123m123p123sEESS").unwrap();
let image = RasterRenderer::render(&hand, &*YELLOW_FLUFFY_STUFF_TILE_SET, RenderOptions::default()).unwrap();
image.save("hand.png").unwrap();

Modules

• parser
  Hand parser that is able to convert string representation of a hand (e.g. 123m456p_7*77z) into Hand instance
• points
  Storing the number of han and fu, and calculating winning points
• raster_renderer
  Module that renders Hand instance into raster images
• tiles
  Constant objects that represent all valid tiles

Structs

• Hand
  Hand object representation.
• HandTile
  Representation of a tile on a hand (tile and rotation).
• InvalidTileError
  Error that denotes that a user tried to create an invalid tile.
• Tile
  Tile representation (suite and value).
• TileValue
  A value of a tile:

Enums

• Suite
  Tile suite, or Any (if used with an unknown tile).
• TilePlacement
  Representation of a tile placement:

Type Aliases

• HandGroup
  A group consists of a list of hand tiles (tiles and their placements).