% MUGS Design Documents

Reviewed 2021-05-19 by japhb

NOTE: If you would like to contribute to MUGS, please read and follow the Coding Standards before sending your pull request.

This directory contains the core MUGS design documents, plus less formal design notes and sketches. Note that some may be out of date or NYI (Not Yet Implemented). If you notice any of these, feel free to make sure there is an open issue to address this.

The design docs can be split into several categories:

Overview and Orientation

• Coding Standards

• Architecture Sketch

• Repository Layout

• Game Classes

• Built With

Details

• Concurrency Design

• Logo Ideas

• Lifecycles INCOMPLETE

• Data Validation WIP

• Error-Handling Principles WIP

• Chain of Identity Rights NYI

• Login Sequence NYI

Diagrams

• Queuing Architecture

Life of a ...

• Life of a UI NEEDS UPDATE

• Life of a Request NEEDS UPDATE

Fun With Numbers

• Supporting "Bullet Hell" Games

• Sources of Lag/Latency

Ruminations

• Sessions and Identities WIP

• Caches and Invalidation NYI

• Turns, Rounds, Matches NYI

• Preventing an Identity Apocalypse PARTIALLY SPECULATIVE

• Messaging and Communication PROBLEM STATEMENT

• Dial-A-Game ASPIRATIONAL