# qunming/sc2002-restaurant-rush architecture

> Architecture diagram of the GitHub repository qunming/sc2002-restaurant-rush, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/qunming/sc2002-restaurant-rush
- Repository: https://github.com/qunming/sc2002-restaurant-rush

## Overview

Restaurant Rush is an offline, turn-based terminal game in which the player manages restaurant operations to meet revenue, paid-customer, and satisfaction targets within 18 turns. The main workflow is scheduled arrivals, seating, customer-selected orders, preparation, serving, eating, and automatic payment, with satisfaction loss and abandonment shaping outcomes. Its enhanced release adds cooking challenges, quality-based feedback, reviews, tips, and Happy Hour; Stage 3 adds a Host and combo meals. The GameController and some managers are not excerpted, so links relying on their runtime behavior are documented or marked unverified.

Main entry points: [`src/controller/GameController.java`](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/controller/GameController.java) (Turn controller), [`src/controller/GameState.java`](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/controller/GameState.java) (Game state), [`src/staff/Waiter.java`](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/staff/Waiter.java) (Waiter), [`src/customer/Customer.java`](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/customer/Customer.java) (Customer lifecycle)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_game["Game orchestration"]
  node_main["Game entry<br/>[Main.java]"]
  node_controller["Turn controller"]
  node_state["Game state<br/>[GameState.java]"]
  node_ui["Console interface<br/>[ConsoleUI.java]"]
  node_input["Action input<br/>[InputHandler.java]"]
end

subgraph group_operations["Restaurant operations"]
  node_tables["Tables<br/>[TableManager.java]"]
  node_orders["Order lifecycle<br/>[Order.java]"]
  node_order_manager["Order manager<br/>[OrderManager.java]"]
  node_host["Host<br/>[Host.java]"]
  node_waiter["Waiter<br/>[Waiter.java]"]
  node_chef["Chef<br/>[Chef.java]"]
  node_cashier["Automatic cashier<br/>[Cashier.java]"]
end

subgraph group_domain["Customers and menu"]
  node_customers["Customer lifecycle<br/>[Customer.java]"]
  node_customer_types["Customer types"]
  node_customer_manager["Customer manager"]
  node_menu["Menu and combos<br/>[Menu.java]"]
end

subgraph group_enhancements["Enhanced features"]
  node_challenge["Cooking challenge"]
  node_reviews["Customer reviews<br/>[ReviewManager.java]"]
  node_tips["Tip calculation<br/>[TipCalculator.java]"]
end

node_player(("Player"))
node_terminal["Terminal"]

node_player -->|"chooses actions"| node_terminal
node_terminal -->|"starts game"| node_main
node_main -.->|"starts controller"| node_controller
node_main -.->|"creates interface"| node_ui
node_main -.->|"creates input"| node_input
node_controller -.->|"manages turns"| node_state
node_controller -.->|"handles arrivals"| node_customer_manager
node_controller -.->|"requests action"| node_host
node_controller -.->|"requests action"| node_waiter
node_controller -.->|"requests action"| node_chef
node_controller -->|"processes payment"| node_cashier
node_controller -.->|"displays status"| node_ui
node_input -.->|"dispatches action"| node_waiter
node_input -.->|"dispatches action"| node_chef
node_input -.->|"dispatches action"| node_host
node_state -->|"holds manager"| node_customer_manager
node_state -->|"holds manager"| node_tables
node_state -->|"holds manager"| node_order_manager
node_state -->|"holds menu"| node_menu
node_state -->|"holds manager"| node_reviews
node_customer_manager -->|"manages customers"| node_customers
node_customer_types -->|"extends behavior"| node_customers
node_waiter -->|"looks up customer"| node_customer_manager
node_waiter -->|"seats customer"| node_tables
node_waiter -->|"creates order"| node_order_manager
node_order_manager -->|"gets food choice"| node_customers
node_customers -->|"chooses item"| node_menu
node_order_manager -->|"creates order"| node_orders
node_chef -->|"prepares order"| node_orders
node_waiter -->|"serves order"| node_orders
node_cashier -->|"records payment"| node_state
node_cashier -->|"releases table"| node_tables
node_controller -.->|"runs challenge"| node_challenge
node_challenge -.->|"records quality"| node_orders
node_controller -.->|"records feedback"| node_reviews
node_customers -.->|"provides feedback"| node_reviews
node_state -->|"calculates tip"| node_tips
node_tips -.->|"reads quality"| node_orders

click node_main "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/app/Main.java"
click node_controller "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/controller/GameController.java"
click node_state "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/controller/GameState.java"
click node_ui "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/ui/ConsoleUI.java"
click node_input "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/ui/InputHandler.java"
click node_customers "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/customer/Customer.java"
click node_customer_types "https://github.com/qunming/sc2002-restaurant-rush/tree/main/src/customer"
click node_customer_manager "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/customer/CustomerManager.java"
click node_menu "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/menu/Menu.java"
click node_tables "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/restaurant/TableManager.java"
click node_orders "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/order/Order.java"
click node_order_manager "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/order/OrderManager.java"
click node_host "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/staff/Host.java"
click node_waiter "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/staff/Waiter.java"
click node_chef "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/staff/Chef.java"
click node_cashier "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/staff/Cashier.java"
click node_challenge "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/challenge/CookingChallenge.java"
click node_reviews "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/feedback/ReviewManager.java"
click node_tips "https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/policy/TipCalculator.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main,node_controller,node_state,node_ui,node_input toneBlue
class node_tables,node_orders,node_order_manager,node_host,node_waiter,node_chef,node_cashier toneAmber
class node_customers,node_customer_types,node_customer_manager,node_menu toneMint
class node_challenge,node_reviews,node_tips toneRose
class node_player,node_terminal toneIndigo
```

## Components

### Game orchestration

- [Game entry](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/app/Main.java): `src/app/Main.java`
- [Turn controller](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/controller/GameController.java): `src/controller/GameController.java`
- [Game state](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/controller/GameState.java): `src/controller/GameState.java`
- [Console interface](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/ui/ConsoleUI.java): `src/ui/ConsoleUI.java`
- [Action input](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/ui/InputHandler.java): `src/ui/InputHandler.java`

### Restaurant operations

- [Tables](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/restaurant/TableManager.java): `src/restaurant/TableManager.java`
- [Order lifecycle](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/order/Order.java): `src/order/Order.java`
- [Order manager](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/order/OrderManager.java): `src/order/OrderManager.java`
- [Host](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/staff/Host.java): `src/staff/Host.java`
- [Waiter](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/staff/Waiter.java): `src/staff/Waiter.java`
- [Chef](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/staff/Chef.java): `src/staff/Chef.java`
- [Automatic cashier](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/staff/Cashier.java): `src/staff/Cashier.java`

### Customers and menu

- [Customer lifecycle](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/customer/Customer.java): `src/customer/Customer.java`
- [Customer types](https://github.com/qunming/sc2002-restaurant-rush/tree/main/src/customer): `src/customer`
- [Customer manager](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/customer/CustomerManager.java): `src/customer/CustomerManager.java`
- [Menu and combos](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/menu/Menu.java): `src/menu/Menu.java`

### Enhanced features

- [Cooking challenge](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/challenge/CookingChallenge.java): `src/challenge/CookingChallenge.java`
- [Customer reviews](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/feedback/ReviewManager.java): `src/feedback/ReviewManager.java`
- [Tip calculation](https://github.com/qunming/sc2002-restaurant-rush/blob/main/src/policy/TipCalculator.java): `src/policy/TipCalculator.java`

### Other components

- **Player**
- **Terminal**

## Connections

- Player → Terminal: chooses actions (evidence: `README.md`)
- Terminal → Game entry: starts game (evidence: `README.md`)
- Game entry → Turn controller: starts controller (evidence: `src/app/Main.java`)
- Game entry → Console interface: creates interface (evidence: `src/app/Main.java`)
- Game entry → Action input: creates input (evidence: `src/app/Main.java`)
- Turn controller → Game state: manages turns (evidence: `src/controller/GameController.java`)
- Turn controller → Customer manager: handles arrivals
- Turn controller → Host: requests action (evidence: `src/controller/GameController.java`)
- Turn controller → Waiter: requests action (evidence: `src/controller/GameController.java`)
- Turn controller → Chef: requests action (evidence: `src/controller/GameController.java`)
- Turn controller → Automatic cashier: processes payment (evidence: `README.md`)
- Turn controller → Console interface: displays status (evidence: `src/controller/GameController.java`)
- Action input → Waiter: dispatches action (evidence: `src/ui/InputHandler.java`)
- Action input → Chef: dispatches action (evidence: `src/ui/InputHandler.java`)
- Action input → Host: dispatches action (evidence: `src/ui/InputHandler.java`)
- Game state → Customer manager: holds manager (evidence: `src/controller/GameState.java`)
- Game state → Tables: holds manager (evidence: `src/controller/GameState.java`)
- Game state → Order manager: holds manager (evidence: `src/controller/GameState.java`)
- Game state → Menu and combos: holds menu (evidence: `src/controller/GameState.java`)
- Game state → Customer reviews: holds manager (evidence: `src/controller/GameState.java`)
- Customer manager → Customer lifecycle: manages customers (evidence: `src/customer/CustomerManager.java`)
- Customer types → Customer lifecycle: extends behavior (evidence: `src/customer/RegularCustomer.java`)
- Waiter → Customer manager: looks up customer (evidence: `src/staff/Waiter.java`)
- Waiter → Tables: seats customer (evidence: `src/staff/Waiter.java`)
- Waiter → Order manager: creates order (evidence: `src/staff/Waiter.java`)
- Order manager → Customer lifecycle: gets food choice (evidence: `src/order/OrderManager.java`)
- Customer lifecycle → Menu and combos: chooses item (evidence: `src/customer/Customer.java`)
- Order manager → Order lifecycle: creates order (evidence: `src/order/OrderManager.java`)
- Chef → Order lifecycle: prepares order (evidence: `README.md`)
- Waiter → Order lifecycle: serves order (evidence: `src/staff/Waiter.java`)
- Automatic cashier → Game state: records payment (evidence: `README.md`)
- Automatic cashier → Tables: releases table (evidence: `README.md`)
- Turn controller → Cooking challenge: runs challenge (evidence: `src/controller/GameController.java`)
- Cooking challenge → Order lifecycle: records quality
- Turn controller → Customer reviews: records feedback
- Customer lifecycle → Customer reviews: provides feedback (evidence: `src/feedback/ReviewManager.java`)
- Game state → Tip calculation: calculates tip (evidence: `src/controller/GameState.java`)
- Tip calculation → Order lifecycle: reads quality (evidence: `src/policy/TipCalculator.java`)
