Welcome to Mahjong’s documentation!

Mahjong is a Python library that analyze the hands of a Mahjong game and provide the best move to train a player to play Mahjong in the most efficient way.

Note

This project is under active development.

Contents

• Installation
• API
  • Tile
    • Tile
      • Tile.increment_hex()
      • Tile.increment_str()
      • Tile.number
      • Tile.suit
  • Suit
    • DragonSuitEnum
      • DragonSuitEnum.Green
      • DragonSuitEnum.RED
      • DragonSuitEnum.White
    • FlowerSuitEnum
      • FlowerSuitEnum.BAMBOO
      • FlowerSuitEnum.CHRYSANTHEMUM
      • FlowerSuitEnum.ORCHID
      • FlowerSuitEnum.PLUM_BLOSSOM
    • SeasonSuitEnum
      • SeasonSuitEnum.AUTUMN
      • SeasonSuitEnum.SPRING
      • SeasonSuitEnum.SUMMER
      • SeasonSuitEnum.WINTER
    • Suit
      • Suit.name
    • SuitEnum
      • SuitEnum.BAMBOO
      • SuitEnum.CHARACTERS
      • SuitEnum.DOTS
      • SuitEnum.DRAGONS
      • SuitEnum.FLOWERS
      • SuitEnum.SEASONS
      • SuitEnum.WINDS
    • WindSuitEnum
      • WindSuitEnum.EAST
      • WindSuitEnum.NORTH
      • WindSuitEnum.SOUTH
      • WindSuitEnum.WEST
  • Hand
    • Hand
      • Hand.breakdown_groups()
      • Hand.group_by_suit()
      • Hand.is_valid_hand()
      • Hand.raw_tiles
      • Hand.split_interval
  • Group
    • Group
      • Group.complete_2_parts()
      • Group.complete_3_parts()
      • Group.complete_multiple_parts()
      • Group.complete_set()
      • Group.tiles
  • Group Maker
    • GroupMaker
      • GroupMaker.group_dict
      • GroupMaker.group_suit()
      • GroupMaker.make_groups()
  • Rules
    • Rules
      • Rules.hand_count
      • Rules.have_bonus
      • Rules.have_honors
  • Utils
    • find_chow_tiles()
    • find_friends()
    • get_meld()
  • Mahjong Set
    • MahjongSet
      • MahjongSet.rules
      • MahjongSet.tiles
  • Tile Displayer
    • TileDisplayer
      • TileDisplayer.increment_hex()
      • TileDisplayer.increment_str()
      • TileDisplayer.number
      • TileDisplayer.suit