Skip to content
/ majiang Public

🀄️ A web-based platform for playing variations of Majiang

License

Notifications You must be signed in to change notification settings

jynnie/majiang

Repository files navigation

Majiang「麻将」

A web-based platform for variations of Majiang (also written Mahjong); built on top of the card.pak engine.

This current iteration gives all clients access to other players information. Thus this is not meant for competitive play. To make this competitive, simply move the functions requiring more than your own information into a server.

Progress being recorded in devlog.

🔨 Development

$ yarn install
$ yarn start

To deploy to majiang.web.app.

$ firebase deploy

🎒 Custom Rules

We're still working on adding in Custom Rules and creating an interface to select what variation of Majiang you want to play -- but in the meantime, we think the current rules are basic enough to play with house restrictions if you wish. Check out this doc for the current base rules.

This section is still in progress!

💪🏼 Motivation

Majiang.pak was built to support many variations of the rules of Majiang. Aside from Riichi Mahjong, variations like Hongkong and Sichuan Mahjong are difficult if not impossible to find online and for free. This platform was built for people to play those games with their friends and even write/contribute their own variations.

🎠 card.pak engine

The game runs on a web-based, modular card game engine dubbed 「card.pak」. The engine was designed to help facilitate and make card games for the web, without having to deal with writing custom frontend, etc. However, while Majiang runs on this engine, a custom frontend has been outfitted for this engine. It is not compatible with non-majiang paks.

🀄