# wenshen18643/fit2099 architecture

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

- Interactive diagram: https://gitdiagram.com/wenshen18643/fit2099
- Repository: https://github.com/wenshen18643/fit2099

## Overview

##### Project type and purpose
- This is a Java-based game engine library (package edu.monash.fit2099.engine) with three demo “worlds” (Conway’s Life, Forest, Mars) and a student-built game (package game).
- Its purpose is to provide a reusable framework for turn-based grid games: managing world state, actors, behaviours, actions, items, ground types, displays, etc., and then demonstrate its use via demo applications and the assignment game.

##### File structure
Top-level
- docs/ – design and demo screenshots
- src/edu/monash/fit2099/engine/… – core engine library
- src/edu/monash/fit2099/demo/… – three demo modules (conwayslife, forest, mars)
- src/game/… – student’s assignment game

Key engine subpackages (core abstractions)
- positions – World, GameMap, Location, Ground, Exit, DefaultGroundCreator, NumberRange
- actors – Actor, Behaviour, ActorAttribute, BaseAttributes, ActorLocationsIterator
- items – Item, PickUpAction, DropAction
- actions – Action, ActionList, DoNothingAction, MoveActorAction
- capabilities – Status
- weapons – Weapon, IntrinsicWeapon
- displays – Display, Menu, Printable, UpdatePageAction

##### README
- The README contains only project title ASCII art. No architectural details beyond being a FIT2099 assignment.

##### Elements
– Clear labels for: Engine Core, Demo Modules (Conway, Forest, Mars), Game Module, Application entry, Console I/O
- Engine ← Demo/Game (dependency/inheritance)
- Application → World → Display → Actors → Behaviours → Actions → World (data/control flow)
- Engine core (blue rectangles)
- Demo/Game modules (green rectangles)
- Application entry points (orange circles)

##### Dependencies and associations
– Between engine subpackages: e.g., actors use positions; actions operate on actors and positions; displays consume Printable from actors/ground/items.
– Between Demo/Game and engine: e.g., MarsDemoApplication extends nothing but uses GameMap, Actor, Behaviour, ActionList.
– Between modules: no cross-demo dependencies (demos are independent).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Engine Core
    subgraph "Engine Core"
        direction TB
        EC_Pos["positions"]:::engine
        EC_Act["actors"]:::engine
        EC_It["items"]:::engine
        EC_Ac["actions"]:::engine
        EC_Ca["capabilities"]:::engine
        EC_We["weapons"]:::engine
        EC_Di["displays"]:::engine
        EC_Pos --> EC_Act
        EC_Act --> EC_Ac
        EC_Ac --> EC_Pos
        EC_Pos --> EC_It
        EC_Act --> EC_Ca
        EC_Act --> EC_We
        EC_Di --> EC_Pos
        EC_Di --> EC_Act
        EC_Di --> EC_It
    end

    %% Demo Modules
    subgraph "Conway's Life Demo" 
        direction TB
        CLApp(("Application")):::app
    end
    subgraph "Forest Demo"
        direction TB
        FDApp(("Application")):::app
    end
    subgraph "Mars Demo"
        direction TB
        MDApp(("Application")):::app
    end

    %% Student Game Module
    subgraph "Student Game Module"
        direction TB
        SGApp(("Application")):::app
    end

    %% Console I/O
    CIO(("Console I/O")):::io

    %% Dependencies
    CLApp -->|uses| EC_Pos
    CLApp -->|uses| EC_Act
    CLApp -->|uses| EC_It
    CLApp -->|uses| EC_Ac
    FDApp -->|uses| EC_Pos
    FDApp -->|uses| EC_Act
    FDApp -->|uses| EC_Ac
    MDApp -->|uses| EC_Pos
    MDApp -->|uses| EC_Act
    MDApp -->|uses| EC_Ac
    SGApp -->|uses| EC_Pos
    SGApp -->|uses| EC_Act
    SGApp -->|uses| EC_It
    SGApp -->|uses| EC_Ac
    SGApp -->|uses| EC_We
    SGApp -->|uses| EC_Ca

    %% Runtime flow (example for any Application)
    CLApp -->|constructs World| EC_Pos
    EC_Pos -->|populated by| EC_It
    EC_Pos -->|populated by| EC_Act
    CLApp -->|starts| EC_Di
    EC_Di -->|renders| CIO
    EC_Di -->|invokes| EC_Ac
    EC_Ac -->|mutates| EC_Pos

    %% Click Events for Engine Core
    click EC_Pos "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/engine/positions"
    click EC_Act "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/engine/actors"
    click EC_It "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/engine/items"
    click EC_Ac "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/engine/actions"
    click EC_Ca "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/engine/capabilities"
    click EC_We "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/engine/weapons"
    click EC_Di "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/engine/displays"

    %% Click Events for Demos
    click CLApp "https://github.com/wenshen18643/fit2099/blob/main/src/edu/monash/fit2099/demo/conwayslife/Application.java"
    click FDApp "https://github.com/wenshen18643/fit2099/blob/main/src/edu/monash/fit2099/demo/forest/Application.java"
    click MDApp "https://github.com/wenshen18643/fit2099/blob/main/src/edu/monash/fit2099/demo/mars/Application.java"

    %% Click Events for Modules
    click CLApp "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/demo/conwayslife"
    click FDApp "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/demo/forest"
    click MDApp "https://github.com/wenshen18643/fit2099/tree/main/src/edu/monash/fit2099/demo/mars"
    click SGApp "https://github.com/wenshen18643/fit2099/blob/main/src/game/Application.java"
    click SGApp "https://github.com/wenshen18643/fit2099/tree/main/src/game"

    classDef engine fill:#cce5ff,stroke:#004085
    classDef demo fill:#d4edda,stroke:#155724
    classDef game fill:#d4edda,stroke:#155724
    classDef app fill:#ffeeba,stroke:#856404
    classDef io fill:#e2e3e5,stroke:#6c757d
```
