# nkdkhtl/chessgame architecture

> Architecture diagram of the GitHub repository nkdkhtl/chessgame, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nkdkhtl/chessgame
- Repository: https://github.com/nkdkhtl/chessgame

## Overview

##### Project type and purpose
- Type: Standalone Java desktop application (built with Java Swing).
- Purpose: Play chess locally—supports two‐player mode, AI opponent (Easy/Hard), save/load games, multiple themes and sounds.

##### High‑level components
a. Presentation Layer (UI)
– Packages: src/panels (GameMenuPanel, GameModePanel, GameOverPanel, PromotionPanel, SettingsPanel, TimerPanel)
– Utils for UI: src/utils (BackgroundPanel, StyledButton, ScaleImage, ThemeManager)
– Entry point: src/Main.java → initializes GameLauncher
b. Core Game Logic
– src/GameLauncher (Board, Movements, CheckFinder, MouseInput, Type, GameLauncher.java)
– src/pieces (Piece hierarchy: King, Queen, Rook, Bishop, Knight, Pawn)
c. AI / Bot Engine
– src/bot (Bot, EasyBot, HardBot)
– src/bot/engine (SearchEngine, Evaluator and subtypes: OpeningEvaluator, MiddlegameEvaluator, EndgameEvaluator, GamePhaseEvaluator)
d. Persistence & Settings
– src/utils/SettingsManager (load/save game state)
– settings.xml (global configuration)
e. Resource Management
– src/utils/SoundManager
f. Utilities
– ChessTimer, ThemeManager, SoundManager

##### Relationships & Interactions
1. User clicks UI component (e.g., a square):
UI Panel → MouseInput → GameLauncher → Movements → Board → Piece → CheckFinder
2. Board state change triggers UI refresh:
Board → panels (repaint)
3. AI move request:
GameLauncher (on bot mode) → Bot (EasyBot or HardBot) → SearchEngine → Evaluators → returns Move → GameLauncher applies via Movements → Board
4. Save/Load:
SettingsManager ↔ GameLauncher/Board (serializes state to settings.xml)
5. Resource loading:
ThemeManager, SoundManager, ScaleImage load resources from res/ and bin/

##### Architectural patterns / design principles
– Layered architecture (Presentation / Domain / Persistence / Utilities)
– MVC‑like separation: UI panels (View), GameLauncher/Movements (Controller), Board/Piece (Model)
– Strategy pattern in Evaluator (different evaluation strategies for game phases)
– Factory or Polymorphism in Bot selection (EasyBot vs. HardBot)
– Single responsibility in utility classes (ThemeManager solely manages themes, SoundManager solely handles audio)

##### Essential elements to capture
– Presentation: panels, ThemeManager, SoundManager
– Controller: GameLauncher, MouseInput, Movements, CheckFinder
– Domain: Board, Piece hierarchy
– AI: Bot, EasyBot, HardBot, SearchEngine, Evaluators
– Persistence: SettingsManager, settings.xml
– Resources: res/, bin/
– Entry point: Main.java

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        Main["Main"]:::frontend
        PanelsGroup["UI Panels"]:::frontend
        GameMenuPanel["GameMenuPanel"]:::frontend
        GameModePanel["GameModePanel"]:::frontend
        GameOverPanel["GameOverPanel"]:::frontend
        PromotionPanel["PromotionPanel"]:::frontend
        SettingsPanel["SettingsPanel"]:::frontend
        TimerPanel["TimerPanel"]:::frontend
    end

    %% Controller Layer
    subgraph "Controller Layer"
        direction TB
        GameLauncher["GameLauncher"]:::controller
        MouseInput["MouseInput"]:::controller
        Movements["Movements"]:::controller
        CheckFinder["CheckFinder"]:::controller
        Type["Type"]:::controller
    end

    %% Domain Model Layer
    subgraph "Domain Model Layer"
        direction TB
        Board["Board"]:::domain
        Piece["Piece"]:::domain
        King["King"]:::domain
        Queen["Queen"]:::domain
        Rook["Rook"]:::domain
        Bishop["Bishop"]:::domain
        Knight["Knight"]:::domain
        Pawn["Pawn"]:::domain
    end

    %% AI Layer
    subgraph "AI / Bot Engine"
        direction TB
        Bot["Bot"]:::ai
        EasyBot["EasyBot"]:::ai
        HardBot["HardBot"]:::ai
        SearchEngine["SearchEngine"]:::ai
        Evaluator["Evaluator"]:::ai
        OpeningEvaluator["OpeningEvaluator"]:::ai
        MiddlegameEvaluator["MiddlegameEvaluator"]:::ai
        EndgameEvaluator["EndgameEvaluator"]:::ai
        GamePhaseEvaluator["GamePhaseEvaluator"]:::ai
    end

    %% Persistence & Utilities
    subgraph "Utilities & Persistence"
        direction TB
        SettingsManager["SettingsManager"]:::util
        ChessTimer["ChessTimer"]:::util
        ThemeManager["ThemeManager"]:::util
        SoundManager["SoundManager"]:::util
        BackgroundPanel["BackgroundPanel"]:::util
        StyledButton["StyledButton"]:::util
        ScaleImage["ScaleImage"]:::util
        SettingsXML["settings.xml"]:::storage
    end

    %% Resource Storage
    subgraph "Resource Storage"
        direction TB
        RES["res/"]:::storage
        BIN["bin/"]:::storage
    end

    %% Connections: UI to Controller
    Main -->|"initializes"| GameLauncher
    Main -->|"loads UI"| PanelsGroup
    PanelsGroup --> GameMenuPanel
    PanelsGroup --> GameModePanel
    PanelsGroup --> GameOverPanel
    PanelsGroup --> PromotionPanel
    PanelsGroup --> SettingsPanel
    PanelsGroup --> TimerPanel

    GameMenuPanel -->|"user click"| MouseInput
    GameModePanel --> MouseInput
    GameOverPanel --> MouseInput
    PromotionPanel --> MouseInput
    SettingsPanel --> MouseInput
    TimerPanel --> MouseInput

    MouseInput -->|"onClick()"| GameLauncher
    GameLauncher -->|"execute move"| Movements
    Movements -->|"update"| Board
    Board -->|"contains"| Piece
    Piece -->|"checks"| CheckFinder
    Board -.->|"state change"| PanelsGroup

    %% AI flow
    GameLauncher -->|"bot mode"| Bot
    Bot -->|"select move"| SearchEngine
    SearchEngine -->|"evaluate"| Evaluator
    Evaluator -->|"phase logic"| OpeningEvaluator
    Evaluator -->|"phase logic"| MiddlegameEvaluator
    Evaluator -->|"phase logic"| EndgameEvaluator
    Evaluator -->|"phase logic"| GamePhaseEvaluator
    SearchEngine --> Bot
    Bot -->|"move result"| GameLauncher

    %% Persistence
    GameLauncher <-->|"serialize/deserialize"| SettingsManager
    Board <--> SettingsManager
    SettingsManager --> SettingsXML

    %% Utilities & Resources
    ThemeManager --> RES
    SoundManager --> RES
    ScaleImage --> RES
    ThemeManager --> BIN
    SoundManager --> BIN
    BackgroundPanel --> RES
    StyledButton --> BIN

    %% Class definitions
    classDef frontend fill:#d0e7ff,stroke:#009,stroke-width:1px;
    classDef controller fill:#d0ffd6,stroke:#090,stroke-width:1px;
    classDef domain fill:#e0ffe0,stroke:#060,stroke-width:1px;
    classDef ai fill:#ffe0b3,stroke:#e65c00,stroke-width:1px;
    classDef util fill:#f2f2f2,stroke:#666,stroke-width:1px;
    classDef storage fill:#fff2b3,stroke:#bb8f00,stroke-width:1px;

    %% Click Events
    click Main "https://github.com/nkdkhtl/chessgame/blob/main/src/Main.java"
    click GameMenuPanel "https://github.com/nkdkhtl/chessgame/blob/main/src/panels/GameMenuPanel.java"
    click GameModePanel "https://github.com/nkdkhtl/chessgame/blob/main/src/panels/GameModePanel.java"
    click GameOverPanel "https://github.com/nkdkhtl/chessgame/blob/main/src/panels/GameOverPanel.java"
    click PromotionPanel "https://github.com/nkdkhtl/chessgame/blob/main/src/panels/PromotionPanel.java"
    click SettingsPanel "https://github.com/nkdkhtl/chessgame/blob/main/src/panels/SettingsPanel.java"
    click TimerPanel "https://github.com/nkdkhtl/chessgame/blob/main/src/panels/TimerPanel.java"
    click GameLauncher "https://github.com/nkdkhtl/chessgame/blob/main/src/GameLauncher/GameLauncher.java"
    click MouseInput "https://github.com/nkdkhtl/chessgame/blob/main/src/GameLauncher/MouseInput.java"
    click Movements "https://github.com/nkdkhtl/chessgame/blob/main/src/GameLauncher/Movements.java"
    click CheckFinder "https://github.com/nkdkhtl/chessgame/blob/main/src/GameLauncher/CheckFinder.java"
    click Type "https://github.com/nkdkhtl/chessgame/blob/main/src/GameLauncher/Type.java"
    click Board "https://github.com/nkdkhtl/chessgame/blob/main/src/GameLauncher/Board.java"
    click Piece "https://github.com/nkdkhtl/chessgame/blob/main/src/pieces/Piece.java"
    click King "https://github.com/nkdkhtl/chessgame/blob/main/src/pieces/King.java"
    click Queen "https://github.com/nkdkhtl/chessgame/blob/main/src/pieces/Queen.java"
    click Rook "https://github.com/nkdkhtl/chessgame/blob/main/src/pieces/Rook.java"
    click Bishop "https://github.com/nkdkhtl/chessgame/blob/main/src/pieces/Bishop.java"
    click Knight "https://github.com/nkdkhtl/chessgame/blob/main/src/pieces/Knight.java"
    click Pawn "https://github.com/nkdkhtl/chessgame/blob/main/src/pieces/Pawn.java"
    click Bot "https://github.com/nkdkhtl/chessgame/blob/main/src/bot/Bot.java"
    click EasyBot "https://github.com/nkdkhtl/chessgame/blob/main/src/bot/EasyBot.java"
    click HardBot "https://github.com/nkdkhtl/chessgame/blob/main/src/bot/HardBot.java"
    click SearchEngine "https://github.com/nkdkhtl/chessgame/blob/main/src/bot/engine/SearchEngine.java"
    click Evaluator "https://github.com/nkdkhtl/chessgame/blob/main/src/bot/engine/Evaluator.java"
    click OpeningEvaluator "https://github.com/nkdkhtl/chessgame/blob/main/src/bot/engine/OpeningEvaluator.java"
    click MiddlegameEvaluator "https://github.com/nkdkhtl/chessgame/blob/main/src/bot/engine/MiddlegameEvaluator.java"
    click EndgameEvaluator "https://github.com/nkdkhtl/chessgame/blob/main/src/bot/engine/EndgameEvaluator.java"
    click GamePhaseEvaluator "https://github.com/nkdkhtl/chessgame/blob/main/src/bot/engine/GamePhaseEvaluator.java"
    click SettingsManager "https://github.com/nkdkhtl/chessgame/blob/main/src/utils/SettingsManager.java"
    click ChessTimer "https://github.com/nkdkhtl/chessgame/blob/main/src/utils/ChessTimer.java"
    click ThemeManager "https://github.com/nkdkhtl/chessgame/blob/main/src/utils/ThemeManager.java"
    click SoundManager "https://github.com/nkdkhtl/chessgame/blob/main/src/utils/SoundManager.java"
    click BackgroundPanel "https://github.com/nkdkhtl/chessgame/blob/main/src/utils/BackgroundPanel.java"
    click StyledButton "https://github.com/nkdkhtl/chessgame/blob/main/src/utils/StyledButton.java"
    click ScaleImage "https://github.com/nkdkhtl/chessgame/blob/main/src/utils/ScaleImage.java"
    click RES "https://github.com/nkdkhtl/chessgame/tree/main/res/"
    click BIN "https://github.com/nkdkhtl/chessgame/tree/main/bin/"
    click SettingsXML "https://github.com/nkdkhtl/chessgame/blob/main/settings.xml"
```
