# dmitrii-sokolov/ksp-gravity-calculator architecture

> Architecture diagram of the GitHub repository dmitrii-sokolov/ksp-gravity-calculator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dmitrii-sokolov/ksp-gravity-calculator
- Repository: https://github.com/dmitrii-sokolov/ksp-gravity-calculator

## Overview

##### Project’s Major Components
a. Data/Asset Repository:
- Assets (and its subdirectories): Contains all in-game parts (Engines, Decouplers, Fuel Tanks, Technologies) as well as sprites, UI prefabs, and WebGL templates.
- These assets provide the raw data (game objects, engine/fuel definitions, technology progressions) that the tool uses for computations and user display.
b. Core Calculation Logic:
- Scripts/Core, Scripts/Assemblies, and Scripts/Parts contain the main logic. This is where interfaces (like IEngineAssembly) and classes (LiquidEngineAssembly, SolidFuelEngine, etc.) determine how fuel consumption, engine performance, and deltaV are computed.
- The Iterators modules (LiquidIterator, LiquidSolidIterator) indicate systematic traversal or computation across engine setups.
c. User Interface (UI) Module:
- Scripts/UI and prefabs under Assets/UI define the user-facing elements. They include custom drawers (EngineDrawer, TechDrawer, MainUI, etc.) that render the output of the computations.
- In addition, Editor scripts exist (in Scripts/Editor) to enhance the development or customization experience.
d. Helpers & Utilities:
- Scripts/Helpers provide annotations (like LabelAttribute) and locale-specific helpers ensuring the tool is user friendly and easily extensible.
e. Integration & Build Configuration:
- The Unity-specific project folders (ProjectSettings, Packages, WebGLTemplates) ensure that project configuration and build pipelines are correctly maintained (for example, enabling browser-based deployments through the WebGL settings).

##### Interactions and Data Flow
a. User Input → UI Module:
- Users interact with the tool via UI elements (buttons, input fields) presented by UI prefabs.
b. UI Module → Core Calculation Logic:
- The UI communicates user selections (part assemblies, fuel tanks, engine combinations) to the core scripts which perform deltaV and efficiency calculations.
c. Core Calculation Logic ↔ Data/Asset Repository:
- The computation logic retrieves necessary data (e.g., engine specifications, fuel types, decoupler characteristics) from the data assets.
d. Output Rendering & Feedback:
- The results of the computations are passed back to the UI Module, which updates the display (like views for technologies, engine performance, deltaV stats).

##### Architectural Patterns and Design Principles
a. Separation of Concerns:
- The project clearly separates resource management (Assets folder), computation/assembly logic (Scripts/Assemblies, Scripts/Core, Scripts/Parts), and the presentation layer (Scripts/UI).
- You might illustrate these as isolated “modules” with defined responsibilities.
b. MVC or Similar Patterns:
- The UI acts as the “View,” the core calculation scripts play the role of the “Controller,” and the Data/Asset repository serves as the “Model.”
- This pattern explicitly if desired.
c. Modularity:
- The presence of iterators, a helpers folder, and separate assemblies indicates modular design. Label these modules to show how they can be independently maintained or extended.
d. Unity-Specific Structure:
- Unity concepts such as Prefabs, ScriptableObjects (asset files), and scene management (likely driven by Assets/Main.unity).

##### Suggested Components
- User Interface (UI) Module:
– UI Prefabs (Assembly.prefab, Engine.prefab, etc.)
– UI Scripts (MainUI, EngineDrawer, etc.)
- Calculation Engine Module:
– Core Scripts (fuel/deltaV calculations in Scripts/Core and Scripts/Assemblies)
– Part Assemblies (LiquidEngineAssembly, SolidFuelEngine, etc.)
– Iterators (LiquidIterator, LiquidSolidIterator)
- Data Assets Repository:
– Engine, Decoupler, Fuel Tank, and Technology assets (under Assets/Parts and Assets/Technologies)
– Sprites used for visual representation
- Configuration & Build Settings:
– Unity project settings, Editor preferences, and WebGL templates for browser deployment (Assets/WebGLTemplates)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Main entry point
    UInput("User Input"):::user

    %% User Interface Module
    subgraph "User Interface (UI) Module"
        UI_Prefabs("UI Prefabs"):::ui
        UI_Scripts("UI Scripts"):::ui
        Editor_Scripts("Editor Scripts"):::ui
        UI_Prefabs --> UI_Scripts
        UI_Scripts --> Editor_Scripts
    end

    %% Core Calculation Logic
    subgraph "Core Calculation Logic"
        Core_Scripts("Core Scripts"):::logic
        Assemblies("Assemblies"):::logic
        Parts_Logic("Parts Logic"):::logic
        Iterators("Iterators"):::logic
        Core_Scripts --> Assemblies
        Assemblies --> Parts_Logic
        Parts_Logic --> Iterators
    end

    %% Data/Asset Repository
    subgraph "Data/Asset Repository"
        InGame_Parts("In-game Parts"):::data
        UI_Assets("UI Assets"):::data
        Technologies("Technologies"):::data
        Sprites("Sprites"):::data
        InGame_Parts --> UI_Assets
        UI_Assets --> Technologies
        Technologies --> Sprites
    end

    %% Helpers & Utilities
    subgraph "Helpers & Utilities"
        Helpers("Helpers"):::helper
    end

    %% Integration & Build Configuration
    subgraph "Integration & Build Configuration"
        Project_Settings("Project Settings"):::integ
        Packages("Packages"):::integ
        WebGL("WebGL Build Settings"):::integ
        Project_Settings --> Packages
        Packages --> WebGL
    end

    %% Data flow connections
    UInput -->|"initiates"| UI_Prefabs
    UI_Scripts -->|"sendsUserSelections"| Core_Scripts
    Core_Scripts <-->|"dataFetch"| InGame_Parts
    Iterators -->|"rendersResults"| UI_Scripts

    %% Support connections (dashed arrows)
    Core_Scripts -.->|"utilitySupport"| Helpers
    Core_Scripts -.->|"configDependency"| Project_Settings
    Core_Scripts -.->|"configDependency"| Packages
    Core_Scripts -.->|"configDependency"| WebGL

    %% Click Events for Data/Asset Repository
    click InGame_Parts "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Parts"
    click UI_Assets "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/UI"
    click Technologies "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Technologies"
    click Sprites "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Sprites/Technologies"

    %% Click Events for Core Calculation Logic
    click Core_Scripts "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Scripts/Core"
    click Assemblies "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Scripts/Assemblies"
    click Parts_Logic "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Scripts/Parts"
    click Iterators "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Scripts/Iterators"

    %% Click Events for UI Module
    click UI_Scripts "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Scripts/UI"
    click UI_Prefabs "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/UI"
    click Editor_Scripts "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Scripts/Editor"

    %% Click Event for Helpers & Utilities
    click Helpers "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/Scripts/Helpers"

    %% Click Events for Integration & Build Configuration
    click Project_Settings "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/ProjectSettings"
    click Packages "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Packages"
    click WebGL "https://github.com/dmitrii-sokolov/ksp-gravity-calculator/tree/main/Assets/WebGLTemplates"

    %% Styles
    classDef user fill:#ffcccb,stroke:#ff0000,stroke-width:2px;
    classDef ui fill:#add8e6,stroke:#0000ff,stroke-width:2px;
    classDef logic fill:#90ee90,stroke:#008000,stroke-width:2px;
    classDef data fill:#ffdAB9,stroke:#ffa500,stroke-width:2px;
    classDef helper fill:#d3d3d3,stroke:#696969,stroke-width:2px;
    classDef integ fill:#dda0dd,stroke:#9400d3,stroke-width:2px;
```
