# timiimit/ut4uu-public architecture

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

- Interactive diagram: https://gitdiagram.com/timiimit/ut4uu-public
- Repository: https://github.com/timiimit/ut4uu-public

## Overview

##### Project type and purpose
- This is a native Unreal Engine “plugin + installer” project for Unreal Tournament 4 (“UT4UU”) that injects custom code into the game, server, and editor to add features (HUD tweaks, faster startup, pak downloading optimizations, social/friends integration, etc.).
- It consists of two logical subsystems:
- An installer application (Windows & Linux) that patches/upgrades UT4 game modules on disk
- A runtime plugin loaded by Unreal Engine at game/editor launch

##### File structure
- Top-level:
- .github/ISSUE_TEMPLATE (for community reporting)
- README.md (project description & instructions)
- (Although the public repo shows only templates, the private/published package will include:)
- Installer code (e.g. C++/Python/Node script or NSIS script)
- Plugin code (C++ modules, .uplugin descriptor, compiled binaries)
- Configuration files (INI, JSON)
- Build/deploy scripts

##### README for additional insights
- Supports Windows & Linux, and all Unreal Engine contexts (game client, dedicated server, editor).
- Features include core engine hooks (pak download, HUD rendering), social integration (friend list visibility), plus an extensible mutator/plugin framework.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% OS Layer
    subgraph "Operating System Layer"
        direction TB
        Windows["Windows"]:::os
        Linux["Linux"]:::os
    end

    %% Installer Application
    subgraph "Install-Time Phase"
        direction TB
        Installer["UT4UU Installer"]:::installer
    end

    %% Engine Host
    subgraph "Unreal Engine Host"
        direction TB
        GameProcess["UE4 Game Client Process"]:::engine
        ServerProcess["UE4 Dedicated Server Process"]:::engine
        EditorProcess["UE4 Editor Process"]:::engine
    end

    %% Runtime Plugin
    subgraph "UT4UU Runtime Plugin" 
        direction TB
        HookManager["UT4UU Hook Manager"]:::plugin
        HUDModule["HUD Manager Module"]:::plugin
        PakModule["Pak-Downloader Hook"]:::plugin
        SocialModule["Social API Client"]:::plugin
    end

    %% External Services
    subgraph "External Services"
        direction TB
        EpicOnline["Epic Online Services"]:::external
        Discord["Discord"]:::external
    end

    %% Local Storage
    subgraph "Local Storage"
        direction TB
        ConfigFiles[(Config Files)]:::storage
        Logs[(Logs & Patch Metadata)]:::storage
    end

    %% Relationships
    Windows --> Installer
    Linux --> Installer
    Installer -->|writes plugin binaries & patches| GameProcess
    Installer -->|writes plugin binaries & patches| ServerProcess
    Installer -->|writes plugin binaries & patches| EditorProcess

    GameProcess -->|loads| HookManager
    ServerProcess -->|loads| HookManager
    EditorProcess -->|loads| HookManager

    HookManager --> HUDModule
    HookManager --> PakModule
    HookManager --> SocialModule

    %% Hook Points
    HUDModule -->|intercepts UI rendering| GameProcess
    PakModule -->|intercepts startup & asset loading| GameProcess
    SocialModule -->|intercepts network client| GameProcess

    %% Network Calls
    SocialModule -->|HTTP/WebSocket| EpicOnline
    SocialModule -->|HTTP/WebSocket| Discord
    EpicOnline <--> Discord

    %% Storage interactions
    HookManager -->|writes settings| ConfigFiles
    HookManager -->|writes logs| Logs

    %% Click Events
    click CommunityReporting "https://github.com/timiimit/ut4uu-public/tree/master/.github/ISSUE_TEMPLATE/"
    click Documentation "https://github.com/timiimit/ut4uu-public/blob/master/README.md"

    %% Styling
    classDef os fill:#eeeeee,stroke:#333,stroke-width:1px
    classDef installer fill:#cee7ff,stroke:#0366d6,stroke-width:2px
    classDef engine fill:#e8daef,stroke:#8e44ad,stroke-width:1px
    classDef plugin fill:#d5f5e3,stroke:#27ae60,stroke-width:2px
    classDef external fill:#fdebd0,stroke:#d35400,stroke-width:1px
    classDef storage fill:#f2f3f4,stroke:#7f8c8d,stroke-width:1px

    %% Node-class assignments
    class CommunityReporting os
    class Documentation os
```
