# marekscode/malefizer architecture

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

- Interactive diagram: https://gitdiagram.com/marekscode/malefizer
- Repository: https://github.com/marekscode/malefizer

## Overview

##### Project type and purpose
- This is a Java-based, Maven-managed board-game application (see pom.xml) that supports:
- A graphical Swing UI (FeldGUI, FeldPanel)
- A terminal/CLI interface (TerminalAusgabe)
- Human players and multiple bot implementations (Fight_Bot, Niki_Bot, Smart_Bot)
- Loading from XML (spielfeld.xml via XMLWorker) and state serialization (SERWorker)
- Unit tests covering core game logic (src/test/java)

##### File structure
- Top-level
- pom.xml – Maven build & dependency management
- spielfeld.xml – example game-map
- Test.ser – serialized game-state sample
- images/ – logo assets
- src/main/java/org/example
- Presentation layer: Main, Menu, GUIface, FeldGUI, FeldPanel, TerminalAusgabe
- Domain model: Feld, Position, Runde (turn), Wuerfel (dice), Spielstein & subclasses (Stein, Krone, Sperrstein)
- Game orchestration: SpielerObjekt, SpielfeldHeinz (game controller)
- Persistence: XMLWorker (map load), SERWorker (state save/load)
- Bot package: Bot interface + implementations + Tiefensuche (search strategy)
- src/test/java – JUnit tests for Feld and Spielstein

##### Insights from README
- The project uses external map generator (SpielfeldCreator) — treat it as a design-time tool that produces spielfeld.xml, not part of runtime.

a. Main components
1. Presentation Layer
– GUI: FeldGUI, FeldPanel
– CLI: TerminalAusgabe
2. Application/Core Engine
– SpielfeldHeinz (controller), Runde (turn manager), SpielerObjekt
– Domain classes: Feld, Position, Wuerfel, Spielstein hierarchy
3. Bot Subsystem
– Bot interface, concrete bots, Tiefensuche algorithm
4. Persistence Layer
– XMLWorker (parses spielfeld.xml)
– SERWorker (serializes/deserializes game state)
5. External Artifacts
– spielfeld.xml (map definitions)
– Test.ser (saved game snapshot)
– SpielfeldCreator (external generator)
b. Relationships & interactions
- Presentation → Core Engine: user actions (click, commands) invoke engine methods
- Core Engine ↔ Persistence: on startup load map via XMLWorker; on save use SERWorker
- Core Engine → Bot Subsystem: when a bot’s turn arrives, engine calls Bot.chooseMove()
- Bot Subsystem → Core Engine: returns move decisions back to engine
- Tests → Core Engine/Domain: invoke and verify logic in Feld, Spielstein
c. Architectural patterns/design principles
- Layered architecture: clear separation between UI, core logic, persistence, bots
- Strategy pattern: Bot interface + multiple implementations + search strategy (Tiefensuche)
- MVC‐style division: Presentation (View + Controller entrypoint Main/Menu) vs. Model (domain)
d. Key technologies/frameworks
- Java SE (Swing for GUI)
- Maven (pom.xml)
- JUnit (unit tests)
- XML parsing (likely JAXB or DOM in XMLWorker)
- Java serialization (SERWorker)

##### Elements
- Clear labels for each layer and component (e.g., “XMLWorker”, “SpielfeldHeinz Controller”)
- UI → Engine (user commands)
- Engine → Persistence (load/save)
- Engine ↔ Bot subsystem (decision requests/returns)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        Main["Main"]:::presentation
        Menu["Menu"]:::presentation
        GUIface["GUIface"]:::presentation
        FeldGUI["FeldGUI"]:::presentation
        FeldPanel["FeldPanel"]:::presentation
        TerminalAusgabe["TerminalAusgabe"]:::presentation
    end

    %% Core Engine
    subgraph "Core Engine"
        direction TB
        SpielfeldHeinz["SpielfeldHeinz (Controller)"]:::core
        Runde["Runde (Turn Manager)"]:::core
        SpielerObjekt["SpielerObjekt"]:::core
        Feld["Feld (Game Board)"]:::core
        Position["Position"]:::core
        Wuerfel["Wuerfel (Dice)"]:::core
    end

    %% Domain Model - Spielstein Hierarchy
    subgraph "Domain Model - Spielstein"
        direction TB
        Spielstein["Spielstein"]:::core
        Stein["Stein"]:::core
        Krone["Krone"]:::core
        Sperrstein["Sperrstein"]:::core
    end

    %% Bot Subsystem
    subgraph "Bot Subsystem"
        direction TB
        BotInterface((Bot)):::bot
        FightBot["Fight_Bot"]:::bot
        NikiBot["Niki_Bot"]:::bot
        SmartBot["Smart_Bot"]:::bot
        Tiefensuche["Tiefensuche"]:::bot
    end

    %% Persistence Layer
    subgraph "Persistence Layer"
        direction TB
        XMLWorker["XMLWorker"]:::persistence
        SERWorker["SERWorker"]:::persistence
    end

    %% External Artifacts
    subgraph "External Artifacts"
        direction TB
        SpielfeldXML["spielfeld.xml"]:::external
        TestSer["Test.ser"]:::external
        SpielfeldCreator["SpielfeldCreator (Design-Time Tool)"]:::external
        Maven["pom.xml (Maven)"]:::external
    end

    %% Unit Tests
    subgraph "Unit Tests"
        direction TB
        FeldTest["FeldTest"]:::test
        SpielsteinTest["SpielsteinTest"]:::test
    end

    %% Relationships
    Main -->|"invokes"| SpielfeldHeinz
    Menu -->|"commands"| SpielfeldHeinz
    GUIface -->|"renders"| FeldGUI
    GUIface -->|"manages"| FeldPanel
    TerminalAusgabe -->|"commands"| SpielfeldHeinz

    SpielfeldHeinz -->|"manages turns"| Runde
    Runde -->|"manages players"| SpielerObjekt
    SpielfeldHeinz -->|"uses board"| Feld
    Feld -->|"has positions"| Position
    SpielfeldHeinz -->|"rolls dice"| Wuerfel

    SpielfeldHeinz -->|"loads map"| XMLWorker
    XMLWorker -->|"reads"| SpielfeldXML
    SpielfeldHeinz -->|"saves state"| SERWorker
    SERWorker -->|"writes"| TestSer

    SpielfeldHeinz -->|"requests move"| BotInterface
    BotInterface -->|"implements"| FightBot
    BotInterface -->|"implements"| NikiBot
    BotInterface -->|"implements"| SmartBot
    BotInterface -->|"uses strategy"| Tiefensuche
    FightBot -->|"returns move"| SpielfeldHeinz
    NikiBot -->|"returns move"| SpielfeldHeinz
    SmartBot -->|"returns move"| SpielfeldHeinz

    FeldTest -->|"tests"| Feld
    SpielsteinTest -->|"tests"| Spielstein

    Spielstein -->|"subclass"| Stein
    Spielstein -->|"subclass"| Krone
    Spielstein -->|"subclass"| Sperrstein

    %% Click Events
    click Main "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/Main.java"
    click Menu "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/Menu.java"
    click GUIface "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/GUIface.java"
    click FeldGUI "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/FeldGUI.java"
    click FeldPanel "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/FeldPanel.java"
    click TerminalAusgabe "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/TerminalAusgabe.java"
    click SpielfeldHeinz "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/SpielfeldHeinz.java"
    click Runde "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/Runde.java"
    click SpielerObjekt "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/SpielerObjekt.java"
    click Feld "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/Feld.java"
    click Position "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/Position.java"
    click Wuerfel "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/Wuerfel.java"
    click Spielstein "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/stein/Spielstein.java"
    click Stein "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/stein/Stein.java"
    click Krone "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/stein/Krone.java"
    click Sperrstein "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/stein/Sperrstein.java"
    click BotInterface "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/bot/Bot.java"
    click FightBot "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/bot/Fight_Bot.java"
    click NikiBot "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/bot/Niki_Bot.java"
    click SmartBot "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/bot/Smart_Bot.java"
    click Tiefensuche "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/bot/Tiefensuche.java"
    click XMLWorker "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/XMLWorker.java"
    click SERWorker "https://github.com/marekscode/malefizer/blob/master/src/main/java/org/example/SERWorker.java"
    click FeldTest "https://github.com/marekscode/malefizer/blob/master/src/test/java/org/example/FeldTest.java"
    click SpielsteinTest "https://github.com/marekscode/malefizer/blob/master/src/test/java/org/example/stein/SpielsteinTest.java"

    %% Styles
    classDef presentation fill:#CFE2F3,stroke:#084298,color:#084298;
    classDef core fill:#D1E7DD,stroke:#0F5132,color:#0F5132;
    classDef bot fill:#E2D7F7,stroke:#5B2C6F,color:#5B2C6F;
    classDef persistence fill:#FCE5CD,stroke:#7F6000,color:#7F6000;
    classDef external fill:#E7E6E6,stroke:#636363,color:#636363;
    classDef test fill:#FFF2CC,stroke:#665200,color:#665200;
```
