# multiguerras/unrealrenderfarmmultiguerras architecture

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

- Interactive diagram: https://gitdiagram.com/multiguerras/unrealrenderfarmmultiguerras
- Repository: https://github.com/multiguerras/unrealrenderfarmmultiguerras

## Overview

Key Components to Include:

##### Core System Components
- Request Manager (Web Server)
- Request Workers (Render Nodes)
- Client Interface (Web Frontend)
- Unreal Engine Integration
- Configuration System

##### Main Architecture Pattern
The system follows a distributed client-server architecture with these characteristics:
- Centralized manager with decoupled workers
- HTTP-based communication
- Queue-based job management
- Web-based monitoring interface

- Job Submission Flow:
- Unreal Engine → Request Submitter → Manager
- Worker Communication:
- Worker → Manager (status updates)
- Manager → Worker (job assignments)
- Web Interface:
- Browser ↔ Manager (monitoring)

Use these visual elements:

##### Connection Types

Important Architectural Notes:

##### Scalability Focus
- Worker nodes as multiple instances
- Independent nature of workers
- HTTP-based communication

##### Security Layer
- Cloudflare protection layer
- Secure communication channels

##### Configuration Management
- Config.json as central configuration
- Connection to both manager and workers

##### Monitoring System
- Web interface components
- Progress tracking system
- Real-time updates flow

Level of Detail:

- Keep high-level components visible
- Main communication paths
- Technologies (Flask, Unreal Engine)
- Scalability points
- Security layers
- Configuration dependencies

- Component types
- Connection types
- Security layers
- Scaling indicators

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Legend"
        L1[Server Component]:::server
        L2[Worker Node]:::worker
        L3[Client Interface]:::client
        L4[External System]:::external
        L5[Configuration]:::config
        L6["HTTP Communication"]
        L7["File System Access"]
        L8["Direct Communication"]
    end

    subgraph "Central Components"
        RM["Request Manager"]:::server
        click RM "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/requestManager.py"
        DB[(Job Queue/DB)]
        CF["Cloudflare Security"]:::security
        Config["Configuration System"]:::config
        click Config "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/config.json"
        ConfigTester["Config Tester"]:::config
        click ConfigTester "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/configtester.py"
    end

    subgraph "Client Components"
        WI["Web Interface"]:::client
        click WI "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/templates/index.html"
        JS["JavaScript Modules"]:::client
        click JS "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/static/createTable.js"
        CSS["CSS Styles"]:::client
        click CSS "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/static/main.css"
        UE["Unreal Engine"]:::external
        RS["Request Submitter"]:::client
        click RS "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/requestSubmitter-desdeunreal.py"
        UI["Unreal Integration"]:::client
        click UI "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/init_unreal.py"
    end

    subgraph "Worker Nodes"
        W1["Worker Node 1"]:::worker
        W2["Worker Node 2"]:::worker
        W3["Worker Node 3"]:::worker
        click W1 "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/requestWorker.py"
        click W2 "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/util/renderRequestworker.py"
        click W3 "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/util/renderRequest.py"
    end

    subgraph "Deployment"
        DS["Deployment Scripts"]:::deploy
        click DS "https://github.com/multiguerras/unrealRenderFarmMultiguerras/blob/master/setup.bat"
        Docker["Docker Container"]:::deploy
        click Docker "https://github.com/multiguerras/unrealRenderFarmMultiguerras/tree/master/Dockerfile"
    end

    %% Connections
    UE --> RS
    RS -.->|HTTP| CF
    CF -.->|HTTP| RM
    RM <--> DB
    RM --> Config
    Config --> ConfigTester
    WI -.->|HTTP| CF
    JS --> WI
    CSS --> WI
    RM -.->|Job Assignment| W1
    RM -.->|Job Assignment| W2
    RM -.->|Job Assignment| W3
    W1 -.->|Status Updates| RM
    W2 -.->|Status Updates| RM
    W3 -.->|Status Updates| RM
    DS --> Docker

    %% Styles
    classDef server fill:#3498db
    classDef worker fill:#2ecc71
    classDef client fill:#e67e22
    classDef external fill:#95a5a6
    classDef config fill:#9b59b6
    classDef security fill:#f1c40f
    classDef deploy fill:#34495e
    classDef legend fill:#ffffff,stroke:#000000
```
