Skip to content

XiaoGeNintendo/JMahjong

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JMahjong

Codacy Badge

(Aims to be) an easy-to-use, extensive Mahjong library for JVM languages

Motivation

JMahjong is born with the intention to provide an alternative to the most popular Java Japanese Mahjong library Mahjong4j.

The original project has not been updated for 2 years and lack useful functions and English documentation.

This is also a self-use library for my future projects.

Features

  • Score calculation, yaku determination with complete ankan, fuuro and dora support.
  • Extensive enough to build custom dora tiles(like 花鳥), custom yakus and even custom scoring.
  • All yakus on riichi.wiki (except for 流し満貫) are supported
  • An not-so-good English documentation and Javadoc
  • Complete Shanten calculation
  • Suggestion according to tile efficiency
  • Validate tiles and hands
  • Take a look at the online demo(in Chinese) here also open-sourced (ps. might get destroyed at any time)

Disadvantages

Well, I hate telling others what we have without telling them what we don't have.

  • Author is Chinese. You can expect Chinglish everywhere.
  • No coverage, no standard tests, not up-to-standard library building.
  • Hard-to-read code style and messy project files.
  • Some parts are not elegant enough.
  • No building instruction.

How to use

Please refer to the WIP Github wiki...

Links

Mahjong4j

Peafowl

九条可怜

About

An easy-to-use, extensive Mahjong library for JVM languages

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages