⚔️ PATTERN QUEST

A gamified exploration of Software Design Patterns — built entirely with programmatic JavaFX.

---

📡 About the Project

Pattern Quest is a pure Java/JavaFX desktop application that transforms the study of Software Engineering Design Patterns from abstract UML diagrams into a fully interactive, visually immersive experience.

Every screen in the application is a living implementation of a GoF (Gang of Four) Design Pattern — not just a demonstration, but a production-grade UI component that you can click, drag, configure, and navigate.

🎨 Architectural Philosophy

Principle	Implementation
16-bit Retro-Brutalist Cyberpunk	Deep black backgrounds (#111111), crisp 1px borders (#CCCCCC), neon green accents (#00FF41), heavy solid drop shadows
Strictly FLAT UI	Zero 3D bevels. Zero gradients on controls. Square corners everywhere.
100% Programmatic UI	Every pixel is placed via Java code — new VBox(), new HBox(), setStyle(). Zero FXML files.
Reactive State	JavaFX Property bindings (bindBidirectional) drive all UI updates. No manual refresh cycles.
CRT Post-Processing	Every screen features a scanline canvas overlay for authentic retro atmosphere.

"Why read about the Builder Pattern when you can literally build a cyberpunk hero with it?"

---

🧬 The 10 Design Patterns

The core of Pattern Quest. Each pattern is mapped to a specific screen or architectural component.

🏗️ 1. Facade — ViewManager (GameFacade)

The Central Orchestrator

GameFacade.java acts as the single entry point for all navigation and overlay management. It hides the complexity of a three-layer StackPane architecture:

• Layer 0 — BorderPane baseLayer (active screen via setCenter())
• Layer 1 — StackPane overlayLayer (modals, pause menu, weapon stats)
• Layer 2 — StackPane consoleLayer (developer console drawer)

// One call to navigate — the Facade handles layer cleanup,
// overlay dismissal, and screen instantiation internally.
GameFacade.getInstance().navigateToDungeon();

All 8+ screens and 6+ modals route through this single class. No screen knows about any other screen.

---

🔄 2. State — Pause Menu / UI State Management

Context-Aware Mode Switching

The AppModeState interface and its implementations (BootingState, ActiveState) manage global application mode transitions. The Pause Menu overlay transitions the application between active gameplay and an interrupted state without logic duplication.

BOOTING → ACTIVE → PAUSED → ACTIVE → ...

Each state defines its own onEnter(), onExit(), and handleInput() behavior.

---

🔨 3. Builder — BuilderLabScreen

Step-by-Step Hero Assembly

The Builder Lab allows step-by-step construction of a complex Hero object:

Step	Control	Options
Hero Class	ComboBox	WARRIOR_PROTOCOL, STEALTH_ASSASSIN, ARCANE_MAGE
Primary Armament	ComboBox	IRON_CLAYMORE, PLASMA_WHIP, VOID_DAGGER
Armor Coating	ComboBox	LEATHER_CHASSIS, HEAVY_TITANIUM, SHADOW_CLOAK
Stats	Slider ×3	STR, AGI, INT (0–100, auto-derives HP/MP)

All selections are bound to PlayerSessionManager and persist across navigation. Clicking FINALIZE_HERO executes the HeroBuilder.build() chain.

---

🎯 4. Strategy — StrategyTrainingScreen

Runtime Algorithm Swapping

The Training Arena lets users dynamically swap combat algorithms at runtime:

• ⚔️ Melee Protocol — High damage, close range
• 🗡️ Stealth Protocol — Critical multipliers, evasion bonuses
• 🔮 Arcane Protocol — Area damage, mana cost scaling

The active strategy determines damage calculations, animation styles, and combat log output — all without conditional branching in the combat engine.

---

👁️ 5. Observer — DungeonScreen & AchievementHall

Real-Time Reactive UI

JavaFX Properties act as the Observable layer:

• GameState properties (bootProgress, cpuLoad, memAlloc) fire change events
• HP bars, XP bars, and combat log entries update reactively via property listeners
• The Achievement Hall's STATS button triggers OperatorStatsModal with live session telemetry
• Toast notifications propagate from global events to any active screen

session.hpPoolProperty().addListener((obs, old, val) ->
    hpLabel.setText(String.valueOf(val.intValue())));

---

🧪 6. Prototype — CloningScreen

Clone, Don't Instantiate

The Cloning Bay visually represents the Prototype pattern: duplicating an existing entity's configuration (memory mapping, core uploads, DNA sequences) rather than constructing from scratch.

Features an animated chamber visualization, source/target entity panels, and confirmation dialogs for clone initiation and abort.

---

🔧 7. Decorator — DecoratorForgeScreen & WeaponStatsModal

Dynamic Behavior Wrapping

The Forge allows runtime decoration of base weapon components:

Base: VOID_REAPER (ATK: 120)
  + Fire Rune Decorator    → ATK: +45 🔥
  + Shadow Rune Decorator  → CRIT: +12% 🌑
  = Final: ATK 165, CRIT 12%

The WeaponStatsModal renders the delta calculation between base and decorated stats in real-time, showing exactly how each decorator layer contributes.

---

👑 8. Singleton — GameState & SettingsManager

One Instance, Global Truth

Three critical singletons ensure consistent state across all 39 source files:

Singleton	Responsibility	Properties
SettingsManager	Engine config (audio, display, controls)	8 JavaFX Properties
PlayerSessionManager	Hero config, stats, session data	9 Properties + 3 ObservableLists
GameState	Boot progress, telemetry, app mode	4 Properties + State Pattern context

// Guaranteed single instance across entire application
SettingsManager.getInstance().masterVolumeProperty()
    .bindBidirectional(slider.valueProperty());

---

📋 9. Command — Main Menu & Combat Actions

Requests as Objects

Combat actions in the Dungeon (⚔ ATTACK, ✨ SKILLS, 🛡 DEFEND, 📋 ITEMS) are encapsulated as command objects. Each click:

1. Logs the action to the ConsoleOverlay command history
2. Triggers a CombatResultModal with themed feedback
3. Can be queued, undone, or replayed

The Main Menu buttons (START NEW JOURNEY, CONTINUE LEGEND, QUIT GAME) follow the same pattern — QUIT triggers a ConfirmActionModal before executing.

---

💾 10. Adapter (+ Memento) — AdapterStorageScreen

Interface Translation & State Snapshots

The Storage terminal adapts between different save data formats:

• LOAD_SNAPSHOT — Restores a previous game state (Memento)
• OVERWRITE — Writes current session to an existing slot
• CREATE_NEW_SAVE — Serializes the active session to a new slot
• CLOUD_SYNC — Adapts local save format to a remote sync protocol
• PURGE_SLOT — Destructive deletion with confirmation guard

Each action routes through the GameFacade to display appropriate confirmation modals.

---

🛠️ Tech Stack

Technology	Purpose
Java 23+	Core language (Project compiled with OpenJDK 25)
JavaFX 23	UI framework — 100% programmatic, zero FXML
Maven	Build tool & dependency management
CSS	Custom retro-brutalist theme (retro-cyber.css)
JavaFX Properties	Reactive state management via bindBidirectional()

---

🚀 Getting Started

Prerequisites

• JDK 17+ (tested with OpenJDK 25)
• Maven 3.8+ (or use the included mvnw wrapper)

Installation

# 1. Clone the repository
git clone https://github.com/BolaGehad/Pattern-Game.git

# 2. Navigate into the project directory
cd Pattern-Game

Running the App

# Using the Maven wrapper (recommended)
./mvnw clean javafx:run

# Or with a system-installed Maven
mvn clean javafx:run

Windows users: Use mvnw.cmd instead of ./mvnw.

---

📂 Folder Structure

Pattern-Game/
├── src/main/java/com/patternquest/
│   ├── Main.java
│   ├── engine/
│   │   ├── GameFacade.java              # Facade — Central orchestrator
│   │   └── ScreenType.java             # Screen routing enum
│   ├── state/
│   │   ├── GameState.java               # Singleton — Global state
│   │   ├── SettingsManager.java         # Singleton — Engine settings
│   │   ├── PlayerSessionManager.java    # Singleton — Player session
│   │   └── app/
│   │       ├── AppModeState.java        # State — Interface
│   │       └── BootingState.java        # State — Boot mode
│   ├── ui/
│   │   ├── components/
│   │   │   ├── TopNavBar.java           # Global navigation bar
│   │   │   ├── SideNavBar.java          # Sidebar navigation
│   │   │   └── ConsoleOverlay.java      # Command — Console drawer
│   │   └── screens/
│   │       ├── BootScreen.java          # Animated boot sequence
│   │       ├── MainMenuScreen.java      # Command — Main menu
│   │       ├── BuilderLabScreen.java    # Builder — Hero assembly
│   │       ├── StrategyTrainingScreen.java  # Strategy — Algorithm swap
│   │       ├── DungeonScreen.java       # Observer — Combat arena
│   │       ├── CloningScreen.java       # Prototype — Entity cloning
│   │       ├── DecoratorForgeScreen.java # Decorator — Weapon forge
│   │       ├── AdapterStorageScreen.java # Adapter — Save management
│   │       ├── AchievementHallScreen.java   # Observer — Stats
│   │       ├── EngineSettingsModal.java  # Multi-tab settings
│   │       ├── WeaponStatsModal.java    # Decorator — Stat deltas
│   │       ├── ConfirmActionModal.java  # Confirmation dialogs
│   │       ├── CombatResultModal.java   # Combat feedback
│   │       ├── CloudSyncModal.java      # Sync animation
│   │       ├── HelpModal.java           # Keybinding reference
│   │       ├── OperatorStatsModal.java  # Session telemetry
│   │       └── PauseMenuScreen.java     # State — Pause overlay
│   └── util/
│       └── ResourceLoader.java          # Local asset loading
├── src/main/resources/com/patternquest/
│   ├── css/retro-cyber.css              # Brutalist theme stylesheet
│   └── images/                          # All local image assets
├── pom.xml                              # Maven build configuration
└── mvnw / mvnw.cmd                      # Maven wrapper scripts

---

🎮 Screen Navigation Map

BOOT SEQ ──> MAIN MENU
                │
                ├── START NEW ──> BUILDER LAB ──> DUNGEON
                ├── CONTINUE  ──> BUILDER LAB        │
                ├── HALL      ──> ACHIEVEMENT HALL    │
                ├── SETTINGS  ──> SETTINGS MODAL      │
                └── QUIT      ──> CONFIRM MODAL       v
                                  STRATEGY <──> CLONING
                                  FORGE    <──> STORAGE

---

🧑‍💻 Author

Bola Gehad — @BolaGehad

---

Built with ☕ Java, 🎮 JavaFX, and a deep appreciation for design patterns.