# thereisnousername1/comp3000-final-year-project architecture

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

- Interactive diagram: https://gitdiagram.com/thereisnousername1/comp3000-final-year-project
- Repository: https://github.com/thereisnousername1/comp3000-final-year-project

## Overview

##### Project type and purpose
- This is a Unity-based standalone game (final-year project) consisting of scenes, assets, scripts, and render pipeline settings. It has no external backend or server components—everything lives within the Unity Editor and the built player.

##### File structure
- Top-level directories:
- Assets – all game assets (scenes, scripts, graphics, input actions, render settings, tutorial data).
- Packages – Unity Package Manager dependencies (manifest.json).
- ProjectSettings – build and engine configuration (URP settings, input manager, audio, quality, XR, etc.).
- README.md – high-level description.
- Notice the “Assets/Scenes” folder indicating multiple game levels, “Assets/Scripts” for gameplay logic, “Assets/Settings” for render pipeline assets, and “Assets/TutorialInfo” for tutorial content plus an Editor extension under Scripts/Editor.

##### README for additional insights
- The README confirms it’s a Unity game in active development, with branching strategy (development → main) and no mention of external data stores or networked services. The Trello link points to feature tracking.

1. Unity Editor & Build System
2. Render Pipeline (URP)
3. Game Runtime – subdivided into:
- Scene Manager (Assets/Scenes)
- Gameplay Scripts (Assets/Scripts + TutorialInfo/Scripts/Readme.cs)
- Input System (Assets/InputSystem_Actions.inputactions)
4. Project Settings (configuration assets)
5. Packages (external libraries)
- User Input → Input System → Gameplay Scripts
- Gameplay Scripts → Scene Manager (SceneSwap.cs) → Load/Unload Scenes
- Scenes → GameObjects → Scripts & Assets
- Render Pipeline reads project settings & scene camera data → Renders frames
- Editor scripts (ReadmeEditor.cs) → Unity Editor UI (designer-time only)
c. Architectural patterns/design principles:
- Modular scene-based architecture: each level/scene encapsulates its own content.
- Separation of concerns: Input System, Scene Management, Rendering Configuration, and Tutorial Logic are kept in distinct folders.
d. Key technologies/frameworks:
- Unity Engine & Editor (C# runtime)
- Universal Render Pipeline (URP) assets in Assets/Settings & ProjectSettings/URPProjectSettings.asset
- Unity Input System package (manifest.json dependency)
- Custom Editor extension (ReadmeEditor.cs)

## Diagram (Mermaid)

```mermaid
flowchart TD
    User((User)):::external

    subgraph "Editor & Build" 
        Editor["Unity Editor"]:::editor
        Build["Build System"]:::editor
        Editor --> Build
        Build -->|uses| PS
        Build -->|packages| PK
    end

    subgraph "Configuration & Assets"
        PS["Project Settings"]:::config
        ASET["Assets/Settings"]:::config
        URPPS["URPProjectSettings.asset"]:::config
        PS --> ASET
        PS --> URPPS
        ASET --> RP
        URPPS --> RP
    end

    subgraph "Game Runtime"
        Input["Input System"]:::runtime
        GS["Gameplay Scripts"]:::runtime
        Scenes["Scenes"]:::runtime
        SM["Scene Manager"]:::runtime
        TM["Tutorial Module"]:::runtime
        RP["Render Pipeline (URP)"]:::runtime

        User -->|InputEvent| Input
        Input -->|InputEvent| GS
        GS -->|Scene load request| SM
        Scenes -->|Scene assets| SM
        SM -->|Scene data| RP
        RP -->|RenderFrame| User
        GS -->|tutorial data| TM
        TM -->|layout&icons| ASET
    end

    PK -->|dependencies| Editor
    GS -->|assets| Scenes

    %% Click Events
    click PS "https://github.com/thereisnousername1/comp3000-final-year-project/tree/main/ProjectSettings/"
    click ASET "https://github.com/thereisnousername1/comp3000-final-year-project/tree/main/Assets/Settings/"
    click URPPS "https://github.com/thereisnousername1/comp3000-final-year-project/blob/main/ProjectSettings/URPProjectSettings.asset"
    click SM "https://github.com/thereisnousername1/comp3000-final-year-project/blob/main/Assets/Scripts/SceneSwap.cs"
    click Scenes "https://github.com/thereisnousername1/comp3000-final-year-project/tree/main/Assets/Scenes/"
    click GS "https://github.com/thereisnousername1/comp3000-final-year-project/tree/main/Assets/Scripts/"
    click Input "https://github.com/thereisnousername1/comp3000-final-year-project/blob/main/Assets/InputSystem_Actions.inputactions"
    click TM "https://github.com/thereisnousername1/comp3000-final-year-project/tree/main/Assets/TutorialInfo/"
    click PK "https://github.com/thereisnousername1/comp3000-final-year-project/blob/main/Packages/manifest.json"
    click Editor "https://github.com/thereisnousername1/comp3000-final-year-project/blob/main/README.md"
    click EditorExt "https://github.com/thereisnousername1/comp3000-final-year-project/blob/main/Assets/TutorialInfo/Scripts/Editor/ReadmeEditor.cs"

    classDef editor fill:#DCEEFB,stroke:#0052CC,color:#0747A6
    classDef runtime fill:#DEFBE6,stroke:#006644,color:#004B1C
    classDef config fill:#FFF1E6,stroke:#BF2600,color:#332000
    classDef external fill:#F0F0F0,stroke:#666666,color:#333333
```
