# kkar1503/smu-cs102-project architecture

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

- Interactive diagram: https://gitdiagram.com/kkar1503/smu-cs102-project
- Repository: https://github.com/kkar1503/smu-cs102-project

## Overview

##### Main Components
- Main Application Entry Points: Classes such as Main.java and Client.java which are responsible for starting the application.
- Game Engine: Centered on the "parade.engine" package, this includes the AbstractGameEngine, its concrete implementation (LocalGameEngine), and the Lobby that likely manages game sessions.
- Player Module: The "parade.player" package includes the IPlayer interface along with its concrete computer player implementations (EasyComputer, NormalComputer, HardComputer) and the LocalHuman class for human interactions.
- Rendering Module: Found in "parade.renderer", with an interface (IClientRenderer) and implementations (AdvancedClientRenderer, BasicLocalClientRenderer) that handle the user interface aspects of the console game.
- Logging Module: Located under "parade.logger" this module defines an AbstractLogger and provides several implementations (JsonLogger, MultiLogger, NopLogger, PrettyLogger) designed to manage logging outputs.
- Configuration/Settings: The "parade.settings" package contains classes for managing configuration keys and settings important for game behavior.
- Utilities & Resources: Helper classes (ConsoleColors in the utils package) and resource files (e.g., configuration properties, ASCII art) which aid the overall user experience and functionality.

##### Architectural Patterns and Design Principles
- The project follows a modular architecture where separation of concerns is evident: game logic, player interactions, presentation, and infrastructure (logging and settings) are clearly segregated.
- There is an abstraction-based approach in many packages (engine, logger, renderer) hinting at use of strategies or factories to select concrete implementations (such as choosing between AdvancedClientRenderer and BasicLocalClientRenderer).
- The use of interfaces (e.g., IPlayer, IClientRenderer) promotes flexibility and testability.
- Exception handling is explicitly addressed in the domain layer with custom exceptions, ensuring robust error management.

##### Technologies and Frameworks
- Java is the primary language.
- Maven is used as build management (indicated by pom.xml).
- Scripts for launching the client and overall game (both Windows and Unix shell scripts) help run the application in different environments.

##### Elements
- Each major component should have a clear label.
- Use annotations to explain key interactions (for example: "Game Engine uses settings to initialize game parameters" or "Logger gathers events from multiple components").

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Application Entry Points"
        MainApp["Main"] 
        Client["Client"]
    end

    subgraph "Game Engine"
        AbstractEngine["AbstractGameEngine"]
        LocalEngine["LocalGameEngine"]
        Lobby["Lobby"]
    end

    subgraph "Domain/Model Layer"
        Card["Card"]
        Deck["Deck"]
        Colour["Colour"]
        Parade["Parade"]
        subgraph "Custom Exceptions"
            EmptyDeckExc["EmptyDeckException"]
            InsufficientCardExc["InsufficientCardException"]
            InvalidSettingExc["InvalidSettingException"]
        end
    end

    subgraph "Player Module"
        IPlayer["IPlayer"]
        EasyComputer["EasyComputer"]
        NormalComputer["NormalComputer"]
        HardComputer["HardComputer"]
        LocalHuman["LocalHuman"]
    end

    subgraph "Rendering Module"
        IClientRenderer["IClientRenderer"]
        ClientRendererProvider["ClientRendererProvider"]
        AdvancedClientRenderer["AdvancedClientRenderer"]
        BasicLocalClientRenderer["BasicLocalClientRenderer"]
    end

    subgraph "Logging Module"
        AbstractLogger["AbstractLogger"]
        LoggerProvider["LoggerProvider"]
        JsonLogger["JsonLogger"]
        MultiLogger["MultiLogger"]
        NopLogger["NopLogger"]
        PrettyLogger["PrettyLogger"]
    end

    subgraph "Configuration/Settings"
        SettingKey["SettingKey"]
        Settings["Settings"]
        ConfigFile["config.example.properties"]
    end

    subgraph "Utilities & Resources"
        ConsoleColors["ConsoleColors"]
        AsciiArt["parade_ascii_art.txt"]
    end

    %% Relationships from Application Entry Points to Game Engine
    MainApp -->|"start"| AbstractEngine
    Client -->|"start"| AbstractEngine

    %% Game Engine Relationships
    AbstractEngine -->|"implementedBy"| LocalEngine
    LocalEngine -->|"manages"| Lobby

    %% Game Engine interacts with Domain/Model Layer
    LocalEngine -->|"state"| Card

    %% Game Engine interacts with Player Module
    LocalEngine -->|"players"| IPlayer

    %% Game Engine interacts with Rendering Module
    LocalEngine -->|"render"| IClientRenderer

    %% Game Engine interacts with Logging Module
    LocalEngine -->|"log"| AbstractLogger

    %% Game Engine interacts with Configuration/Settings
    LocalEngine -->|"settings"| SettingKey

    %% Player Module: IPlayer implemented by concrete players
    IPlayer -->|"implementedBy"| EasyComputer
    IPlayer -->|"implementedBy"| NormalComputer
    IPlayer -->|"implementedBy"| HardComputer
    IPlayer -->|"implementedBy"| LocalHuman

    %% Rendering Module: Renderer provider provides implementations
    ClientRendererProvider -->|"provides"| AdvancedClientRenderer
    ClientRendererProvider -->|"provides"| BasicLocalClientRenderer

    %% Logging Module: Logger provider provides implementations
    LoggerProvider -->|"provides"| JsonLogger
    LoggerProvider -->|"provides"| MultiLogger
    LoggerProvider -->|"provides"| NopLogger
    LoggerProvider -->|"provides"| PrettyLogger

    %% Styling Classes
    class MainApp,Client entry
    class AbstractEngine,LocalEngine,Lobby engine
    class Card,Deck,Colour,Parade,EmptyDeckExc,InsufficientCardExc,InvalidSettingExc domain
    class IPlayer,EasyComputer,NormalComputer,HardComputer,LocalHuman player
    class IClientRenderer,ClientRendererProvider,AdvancedClientRenderer,BasicLocalClientRenderer rendering
    class AbstractLogger,LoggerProvider,JsonLogger,MultiLogger,NopLogger,PrettyLogger logging
    class SettingKey,Settings,ConfigFile settings
    class ConsoleColors,AsciiArt utilities

    %% Class Definitions for Colors
    classDef entry fill:#fce5cd,stroke:#b45f06,stroke-width:2px;
    classDef engine fill:#d9ead3,stroke:#38761d,stroke-width:2px;
    classDef domain fill:#c9daf8,stroke:#1155cc,stroke-width:2px;
    classDef player fill:#ead1dc,stroke:#b854a8,stroke-width:2px;
    classDef rendering fill:#fff2cc,stroke:#bf9000,stroke-width:2px;
    classDef logging fill:#d0e0e3,stroke:#76a5af,stroke-width:2px;
    classDef settings fill:#f9cb9c,stroke:#e69138,stroke-width:2px;
    classDef utilities fill:#ead1dc,stroke:#8e7cc3,stroke-width:2px;

    %% Click Events for Application Entry Points
    click MainApp "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/Main.java"
    click Client "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/Client.java"

    %% Click Events for Game Engine
    click AbstractEngine "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/engine/AbstractGameEngine.java"
    click LocalEngine "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/engine/impl/LocalGameEngine.java"
    click Lobby "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/engine/Lobby.java"

    %% Click Events for Domain/Model Layer
    click Card "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/common/Card.java"
    click Deck "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/common/Deck.java"
    click Colour "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/common/Colour.java"
    click Parade "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/common/Parade.java"
    click EmptyDeckExc "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/common/exceptions/EmptyDeckException.java"
    click InsufficientCardExc "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/common/exceptions/InsufficientCardException.java"
    click InvalidSettingExc "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/common/exceptions/InvalidSettingException.java"

    %% Click Events for Player Module
    click IPlayer "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/player/IPlayer.java"
    click EasyComputer "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/player/computer/EasyComputer.java"
    click NormalComputer "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/player/computer/NormalComputer.java"
    click HardComputer "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/player/computer/HardComputer.java"
    click LocalHuman "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/player/human/LocalHuman.java"

    %% Click Events for Rendering Module
    click IClientRenderer "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/renderer/IClientRenderer.java"
    click ClientRendererProvider "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/renderer/ClientRendererProvider.java"
    click AdvancedClientRenderer "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/renderer/impl/AdvancedClientRenderer.java"
    click BasicLocalClientRenderer "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/renderer/impl/BasicLocalClientRenderer.java"

    %% Click Events for Logging Module
    click AbstractLogger "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/logger/AbstractLogger.java"
    click LoggerProvider "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/logger/LoggerProvider.java"
    click JsonLogger "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/logger/impl/JsonLogger.java"
    click MultiLogger "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/logger/impl/MultiLogger.java"
    click NopLogger "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/logger/impl/NopLogger.java"
    click PrettyLogger "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/logger/impl/PrettyLogger.java"

    %% Click Events for Configuration/Settings
    click SettingKey "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/settings/SettingKey.java"
    click Settings "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/settings/Settings.java"
    click ConfigFile "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/resources/config.example.properties"

    %% Click Events for Utilities & Resources
    click ConsoleColors "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/java/parade/utils/ConsoleColors.java"
    click AsciiArt "https://github.com/kkar1503/smu-cs102-project/blob/main/src/main/resources/parade_ascii_art.txt"
```
