v2.0.0

This is a major release that brings significant performance improvements, bug fixes, new features, and a cleaner API. Please check the full CHANGELOG for all the details.

Warning

This release contains breaking changes. Please review the breaking changes section below before upgrading.

Performance

• ~6x faster hand calculation overall (35,364 hands/sec vs 5,925), with a redesigned hand division algorithm (~3x faster on its own).

New features

• Ura dora support — estimate_hand_value() now accepts ura_dora_indicators for hands.
• Separate yakuhai yaku for each seat wind and round wind (e.g., SeatWindEast, RoundWindSouth).

Breaking changes (highlights)

For the full list of breaking changes, please see the CHANGELOG.

• Dropped Python 3.9 — requires 3.10+.
• Yaku is now an abstract base class with class-level attributes; yaku_id values reassigned.
• Wind yakuhai classes renamed (YakuhaiEast -> SeatWindEast, etc.).
• Several constants converted from lists to frozensets (TERMINAL_INDICES, WINDS, etc.).
• AKA_DORA_LIST renamed to AKA_DORAS.
• Meld.tiles is now tuple instead of list.
• Removed deprecated properties (Meld.CHANKAN, Yaku.english, Yaku.japanese, Yaku.tenhou_id).
• Various internal methods/attributes removed.
• Hands without yaku no longer count dora.
• Stricter validation in Shanten (raises ValueError for invalid tile counts).

Full Changelog: v1.4.0...v2.0.0

v1.4.0

What's Changed

• chore: Update astral-sh/setup-uv action by @Apricot-S in #78
• chore: Update actions/checkout action by @Apricot-S in #80
• chore: Add Python 3.14 support by @Apricot-S in #81
• feat: Deprecate Shanten.number_characters and Shanten.number_isolated_tiles by @Apricot-S in #82
• feat: Deprecate internal state properties of Shanten by @Apricot-S in #83
• docs: Apply markdownlint rules to README by @Apricot-S in #87
• docs: Add badges by @Apricot-S in #88
• docs: Change uv venv to uv sync for accurate setup and dependency installation via pyproject.toml by @Apricot-S in #89

Full Changelog: v1.3.0...v1.4.0

v1.3.0

Breaking Changes

• dropped support for Python 3.7 and 3.8

Bug fixes

• fix: Correct miscalculation of shanten number for Seven Pairs (chiitoitsu, 七対子) by @Apricot-S in #61
• fix: Correct miscalculation of shanten number for general form by @Apricot-S in #62

Other changes

• migrate the project to a modern Python stack: uv and ruff
• other minor improvements and optimizations along the way
• add support for Python 3.13

New Contributors

• @Apricot-S made their first contribution in #56

Full Changelog: v1.2.1...v1.3.0

v1.2.1

Features

• Adjust warning configs. Thanks @0num4 for contribution in PR #46

Chores

• Fix type in the test name. Thanks @kianmeng for contribution in PR #45
• Remove Python 3.6 support
• Move wiki files to md files for easier diffs

v1.2.0

This release contains many improvements and bug fixes. The new version was tested over millions of real hanchans and many bugs were fixed.

Incompatibility highlight:

• Python 2 support was dropped
• Changes in interfaces, please refer doc/example.py for usage examples. For example now all four tiles should be in hand tiles when you have kan melds.

v1.1.11

• Speed up performance a bit
• Add support for Python 3.9

v1.1.10

• Add japanese yaku names
• Fix an issue with not correct ryuuiisou detection
• Allow to print aka dora in TilesConverter.to_one_line_string() method ("0" symbol)
• Add support for Python 3.8

v1.1.9

• Add TilesConverter.one_line_string_to_136_array() and TilesConverter.one_line_string_to_34_array() methods

v1.1.8

• Fix an issue with incorrect daburu chuuren poutou calculations
• Allow passing '0' as a red five to tiles converter

v1.1.7

• Introduce OptionalRules hand configuration