Hong Kong Old Style Mahjong Engine
Find a file
2026-05-16 07:14:48 -07:00
hkos delete cache 2026-05-16 07:14:16 -07:00
tests move tests 2026-05-16 07:07:15 -07:00
.gitignore update gitignore 2026-05-16 07:14:48 -07:00
LICENSE add license 2026-05-16 07:06:21 -07:00
pyproject.toml initial iteration 2026-05-16 07:02:59 -07:00
README.md readme update 2026-05-16 07:08:21 -07:00

HKOS (Hong Kong Old Style Mahjong)

A pure Python engine and Rule-Based AI agent for Hong Kong Old Style (HKOS) Mahjong.

This library provides a completely stateless, server-ready mathematical engine for validating hands, calculating complex Faan scoring, and managing game state. It also includes multi-difficulty Heuristic AI bots capable of evaluating the best combinations and safe discards.

Installation

Install the library directly from this repository using pip.

Quick Install

To install the latest version directly into your project's virtual environment, run:

pip install git+[https://vampire.church/operatorjen/hkos.git](https://vampire.church/operatorjen/hkos.git)

Running Tests

pytest -v