Introduction

suzume is a lightweight Riichi Mahjong engine written in C++14.

Get Started

Getting started with suzume should be a painless process.

Dependencies

  • CMake;
  • A C++14 compliant compiler (really, that’s all).

Installing 

git clone https://github.com/szm-dev/suzume
cd suzume
mkdir build && cd build
cmake ..
make

You First Round

To be completed.

./suzume

Tutorial

Step-by-step to get you started on hacking with suzume. Tutorial →

Quick Start

Starting a match in szm::online (to be constructed). Quick Start →

Further Reading

Curious to learn the rules of Mahjong, or do you want to explore the little known theory of Mahjong? Check the sections below for more info.

Rules

Read through the rules of Mahjong. Rules →

Theory

Explore the mathematical theory of Mahjong. Theory →

Contributing

There are no guidelines as of yet, but anyone is invited to open a pull request on Github!

Help

Please open an issue on GitHub (wiki pages and documentation will be added in the near future). Pull request are always welcome!

Quick Start →