Skip to content

Repository files navigation

Mahjong Tracker

A Google Sheets-based mahjong score tracking system for Japanese style Riichi Mahjong parlors or home tournaments.

Do you have a group of friends or a mahjong parlor and need to track everybody's scores over the season? If so, use this google sheet template + its App Script, it allows you to easily add games and track player stats. Let's make Riichi Mahjong more popular in the west!

image

TIP: You might also want to use RTEventTimer, a custom mahjong event timer for tournaments.

A template example of it can be viewed and copied here. However, this won't copy the Apps Script files, so I think you'll have to copy those from the apps_script_files dir here into it, manually (Extensions->Apps Scripts), or use the fancy harder to use scripts in this repo to copy them for you.

Note: The permissions are very scary on this due to the auto file syncing etc, you don't have to approve them all if you aren't using the auto file syncing stuff, etc. You do need to approve access to read/write to the sheets file when it asks as a minimum though.

If you install the scripts right, in the Sheets file you'll notice a new option: "C2 Options"

image

Scoring rules and such

The Riichi Mahjong scoring is similar to MLeague but with some modifications. (no two parlours work exactly the same, ours are tweaked to be slightly more beginner friendly and fun)

The (70% done, under construction) Official C2 Kyoto house rules: English Japanese

C2 Kyoto

Come visit C2 Kyoto someday and play with us!

Features

  • Score Tracking: Track individual games and calculate player rankings automatically
  • Team Management: Support for team-based competitions with rankings
  • Flags and images: Can assign country flags for each player, and images for teams
  • Nick names: Can specify a "nick name" for players to use in the rankings, helps with privacy
  • Easy editing: Every player, game etc is just a row in a spreadsheet, so easy to make revisions or delete games
  • Seating charts: Option to create a table seating plan for your tournament that minimizes repeat player pairings and won't allow teammates at the same table. Just enter the tables count and rounds you want.
  • Adding game results is easy: Names are chosen with a dropdown that is limited to players marked "Here today?" in the players tab, helps reduce entry mistakes. Auto-detects if it's a 3 or 4 player game and separates them in rankings. (It's easy enough that our patrons enter their own games!)
  • Debug Tab: This let's you examine/verify the math used to compute the rankings

Optional Workflow Benefits

If you just use the sheet with its Apps Script it will work, but you can also go next level for stuff like this:

  • GitHub Pages Publishing: One-click publishing to your GitHub Pages website from the Apps Script
  • Automated Sync: Local python script to download and upload Google Apps Script files for faster development
  • Data Export: Local python script that can download spreadsheet data in CSV, JSON, and Excel formats

More screenshots

image

Example of HTML publishing

Optional fancy scripts

To use the fancy python scripts that do auto uploading and write HTML rankings to a git page automatically, see the SETUP_GUIDE.md

License

This project is licensed under the MIT License - see the LICENSE file for details.

AI Disclosure

This software was partially developed with the assistance of AI tools. The codebase includes contributions from AI-assisted development while maintaining human oversight and testing.

Notes and misc

  • This has nothing to do with Seth's Mahjong AI robot, that's a different project.
  • I just realized I hardcoded it so flag images are read from rtsoft, but meh, that's fine I guess, I have the bandwidth

Credits

  • Written by Seth A. Robinson
  • House rules documents written by Akiko Robinson and Wei Yi
  • Special thanks to C2 Kyoto patrons for being forced to beta test this for the last few years

About

The Google Sheets/Apps Script we use at C2 Kyoto to track our Japanese Mahjong players' seasonal rankings

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages