Skip to content

foxfriends/mahjong

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mahjong

Work in progress: This game is probably functional, but has not been thoroughly tested. Play at your own risk.

Play Mahjong in your browser with your friends.

Please note this is the real Mahjong game, not the weird tile matching one. We don't play that one.

Installation

This repository uses submodules. Clone using --recursive (or initialize submodules manually if it's already too late):

git clone --recursive [email protected]:foxfriends/mahjong

# OR, after cloning normally
git submodule init
git submodule update

Usage

# Create a directory for the games to be saved to
mkdir state

# Compile the client
cd client
npm install
npm run build

# Then run the server
cd server
npm install
npm start

You can now visit localhost:1234 in your browser to play. Enter your name, and then enter a game name. All players (up to 4) who enter the same game name will join that game. Once all players have pressed "Ready", the game will begin.

Developing

Very similar to running, but run the client as npm start instead of building it:

# Compile the client
cd client
npm install
npm start

# Then run the server
cd server
npm install
npm start

You'll have to restart the server manually when it changes, but the client will rebuild automatically.

Configuration

The port (mahjong_port) and save data directory (mahjong_state) can be changed by modifying the values in server/.env. Changing the mahjong_dist directory is not recommended.

About

Play Mahjong in your browser with your friends.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published