How marekscode/malefizer works
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)