User Guide
There are two ways to use RabiRiichi:
- Just play — open one of the officially hosted web clients in your browser. Nothing to install. Start at Play online.
- Run it yourself — build the server (and optionally the web client) from source and host your own games.
Which path is for you?
| I want to… | Go to |
|---|---|
| Play right now in my browser | Play online |
| Build everything from a clean machine | Install from scratch |
| Run the game server locally | Run the server |
| Run the 3D web client locally | Host the web client |
| Deploy a public server (systemd) | Deploy to production |
The pieces
RabiRiichi is three repositories that work together:
| Repo | What it is |
|---|---|
RabiRiichi | The C#/.NET rules engine and the WebSocket game server. |
RabiRiichi-Web | The 3D browser client (Vite + React + three.js). |
RabiRiichi-Proto | The shared Protobuf definitions, used by both as a git submodule. |
The web client connects to a server over a WebSocket. To play, you only need a client pointed at a running server — and the official clients already bundle a server picker, so most people never build anything.
Just want to play?
Skip straight to Play online. The rest of this guide is for running your own server or client.
Developers building on the engine or protocol should read the Core Engine and Server docs instead.