en-libsaki.md

layout	title	permalink
page	Libsaki Tutorial	/en/docs/libsaki/

General

These pages introduce the code details of the Pancake Mahjong core library, Libsaki.

Please carefully check through the Pancake C++ Style Guide before taking any change to the code.

This library is written in plain C++ without any third party library.

Layering

The architecture of Libsaki is based on a layered approach.

Level	Layer Name	Related Directory
6	Application Layer	/app
5	Operation and Observation Layer	/table
4	Skill Interfering Layer	/girl
3	Standard Mahjong Layer	/table
2	Hand/Form Layer	/form
1	Base Unit Layer	/unit

It is recommended to read the following detailed documents together with their correspending source code. (We don't use doxygen since it is painful to rebuild a C++ project due to every comment change)

1. Base Unit Layer

• Mahjong Tiles T34 and T37
• Player Identities Who

2. Hand/Form Layer

• Multiset for Tiles TileCount
• Status of One's Hand Hand
• The Mountain System Mount

3. Standard Mahjong Layer

• Main Mahjong Logic Table

4. Skill Interfering Layer

• Character Skills Girl
• Tile Dealing System Princess

5. Operation and Observation Layer

• (TODO)

6. Application Layer

• (TODO)