# ndzuma/wumpus-hill architecture

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

- Interactive diagram: https://gitdiagram.com/ndzuma/wumpus-hill
- Repository: https://github.com/ndzuma/wumpus-hill

## Overview

##### Project type and purpose
- This repository is a multi-language reference implementation of the classic “Hunt the Wumpus” text-based game.
- Each top-level folder (go/, java/wumpus/, python/) contains a standalone command-line version in that language.

##### File structure
- Top-level:
- go/ – contains a README for a Go implementation
- java/wumpus/ – standard Maven project with pom.xml and src/main/java/com/…/wumpus classes
- python/ – scripts (main.py, display.py) plus requirements.txt
- Common patterns in each implementation:
- Input handling (main.py, GameInput.java)
- Core game engine (Game.java, Board.java, logic in Go)
- /output components (Display.java, display.py)
- Domain models (Player, Wumpus, Position, Stats)

##### README(s)
- The top-level README.md is empty, so we infer architecture solely from file layout and class names.
- The java/wumpus/README.md likely describes build/run but does not introduce new architectural layers.

a. Main components (per language)
– User (CLI)
– Input Layer (parses commands)
– Controller/Orchestrator (Game class or equivalent)
– Domain Model (Board, Player, Wumpus, Position, Stats)
– Output Layer (Display)
b. Relationships and interactions
– User → Input Layer
– Input Layer → Controller
– Controller ↔ Domain Model (reads/writes game state)
– Controller → Output Layer (renders state)
– Output Layer → User (prints to console)
c. Architectural patterns
– Simple layered (Input → Logic → Model → View)
– MVC-style separation in Java:
- Model: Board, Player, Wumpus, Position, Stats
- View: Display
- Controller: Game, GameCommands, GameInput
d. Key technologies
– Java: Maven, Java classes under com.ndzumamalate.wumpus
– Python: main.py, display.py, any third-party libs in requirements.txt
– Go: standalone Go module (per go/README.md)

##### Elements
– Clear labels: e.g., “User CLI,” “Input Parser,” “Game Engine,” “Domain Model,” “Display”
- Input components (blue)
- Core logic (green)
- Domain entities (yellow)
- Output/Display (orange)

## Diagram (Mermaid)

```mermaid
flowchart TD
  subgraph "Wumpus Game"
    subgraph Java
      JMUSER["User CLI"]:::user
      JGI["GameInput"]:::input
      JGP["GameCommands"]:::input
      JENGINE["Game Engine"]:::logic
      subgraph "Domain Model"
        JBoard["Board"]:::domain
        JPlayer["Player"]:::domain
        JWumpus["Wumpus"]:::domain
        JPosition["Position"]:::domain
        JStats["Stats"]:::domain
        JDirection["Direction"]:::domain
      end
      JDISPLAY["Display"]:::output

      JMUSER --> JGI
      JGI --> JGP
      JGP --> JENGINE
      JENGINE --> JBoard
      JENGINE --> JPlayer
      JENGINE --> JWumpus
      JENGINE --> JPosition
      JENGINE --> JStats
      JENGINE --> JDirection
      JENGINE --> JDISPLAY
      JDISPLAY --> JMUSER

      click JGI "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/GameInput.java"
      click JGP "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/GameCommands.java"
      click JENGINE "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/Game.java"
      click JBoard "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/Board.java"
      click JPlayer "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/Player.java"
      click JWumpus "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/Wumpus.java"
      click JPosition "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/Position.java"
      click JStats "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/Stats.java"
      click JDirection "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/Direction.java"
      click JDISPLAY "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/src/main/java/com/ndzumamalate/wumpus/Display.java"
      click JPOM "https://github.com/ndzuma/wumpus-hill/blob/main/java/wumpus/pom.xml"
    end

    subgraph Python
      PMUSER["User CLI"]:::user
      PINPUT["main.py\n(Input & Engine)"]:::logic
      PDISPLAY["display.py"]:::output

      PMUSER --> PINPUT
      PINPUT --> PDISPLAY
      PDISPLAY --> PMUSER

      click PINPUT "https://github.com/ndzuma/wumpus-hill/blob/main/python/main.py"
      click PDISPLAY "https://github.com/ndzuma/wumpus-hill/blob/main/python/display.py"
      click PREQ "https://github.com/ndzuma/wumpus-hill/blob/main/python/requirements.txt"
    end

    subgraph Go
      GMUSER["User CLI"]:::user
      GCOMP["Go Module\n(parser, engine,\nmodel, display)"]:::logic

      GMUSER --> GCOMP
      GCOMP --> GMUSER

      click GREAD "https://github.com/ndzuma/wumpus-hill/blob/main/go/README.md"
    end
  end

  classDef user fill:#cccccc,stroke:#333,stroke-width:1px
  classDef input fill:#aadaff,stroke:#333,stroke-width:1px
  classDef logic fill:#aaffaa,stroke:#333,stroke-width:1px
  classDef domain fill:#ffeb99,stroke:#333,stroke-width:1px
  classDef output fill:#ffcc99,stroke:#333,stroke-width:1px
```
