# pezfisk/oxidemanager architecture

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

- Interactive diagram: https://gitdiagram.com/pezfisk/oxidemanager
- Repository: https://github.com/pezfisk/oxidemanager

## Overview

##### Project Type and Purpose
- This is a desktop GUI tool written in Rust with a Slint-based front end.
- Purpose: help users extract game mod archives (.zip, .rar, .7z) from a source folder, place (via symlink or copy) the extracted files into a target game directory, and manage mod “profiles” (source/target pairs, optional SteamGridDB images).

a. User Interface Layer (Slint)
- `ui/*.slint` files define windows, dialogs, grid view, profile editor, profile images, profile state.
b. Application Core (Rust)
- `src/main.rs` – application entry point, Slint event bindings
- `src/profile_manager.rs` – handles loading/saving profiles, reading `.env` for SteamGridDB API key, fetching profile images via HTTP
- `src/extract.rs` – scans source directory, identifies archives, invokes decompression logic (via Rust crates or external tools) into `.temp/`
- `src/file_manager.rs` – moves or symlinks files from `.temp/` to target game directory, applies overwrite/direct-extract options
c. File System
- User’s source directory (compressed mods)
- Temporary directory (`.temp/`)
- Target game directory (where mods are “installed”)
- Local config/profile storage (e.g., file in user’s home folder)
d. External Service
- SteamGridDB REST API (optional; used by `profile_manager.rs` to fetch thumbnails)
- `build.rs` / `.cargo/config.toml` / `build.sh` – compile-time selection of Slint backend and style
- `.env` file – injection of `STEAMGRIDDB_API_KEY`

##### Relationships and Data Flows
- User clicks buttons in the Slint UI → events propagate to `main.rs`.
- `main.rs` calls `profile_manager` to load/save profile metadata, triggers image fetch from SteamGridDB.
- On “Extract” action:
- UI → calls `extract.rs`, which scans source dir for archives → writes to `.temp/`.
- Once extraction completes, `main.rs` invokes `file_manager.rs`.
- `file_manager` moves or symlinks files from `.temp/` → target game directory, respecting overwrite/direct flags.
- Status updates (progress, errors) flow back to the UI for display.

##### Architectural Patterns & Design Principles
- Separation of Concerns: UI (Slint) vs. business logic (Rust modules).
- Event-Driven Flow: Slint events trigger Rust functions; core modules emit status events back to UI.
- Modular Design: Each Rust file (`extract`, `file_manager`, `profile_manager`) encapsulates a single responsibility.
- Safety and Performance: Use of symlinks to minimize disk usage, optional direct extraction mode.

##### Technologies & Frameworks to Annotate
- Frontend: Slint (UI definitions in `.slint` files).
- Language: Rust, Cargo.
- Decompression: Rust crates for ZIP/RAR/7z or system utilities.
- HTTP Client: (e.g., `reqwest`) for SteamGridDB.
- Environment: dotenv for API key.
- Build Configuration: `build.rs`, `.cargo/config.toml`.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "User Interface Layer" 
        UI1["App Window\n(ui/app-window.slint)"] 
        UI2["Grid View\n(ui/grid_view.slint)"] 
        UI3["Profile Editor\n(ui/profile-edit.slint)"] 
        UI4["Profile Images\n(ui/profile-images.slint)"] 
        UI5["Profile State\n(ui/profile-state.slint)"] 
    end

    subgraph "Application Core"
        M["Main\n(src/main.rs)"]
        PM["ProfileManager\n(src/profile_manager.rs)"]
        EX["Extractor\n(src/extract.rs)"]
        FM["FileManager\n(src/file_manager.rs)"]
    end

    subgraph "File System"
        SRC["Source Directory"]
        TEMP["Temporary Directory\n(.temp/)"]
        TGT["Target Game Directory"]
        CFG["Local Profile Storage"]
    end

    subgraph "External Service"
        SGDB["SteamGridDB API"]
    end

    subgraph "Build & Configuration"
        BS["build.rs"]
        CC[".cargo/config.toml"]
        BH["build.sh"]
        CT["Cargo.toml"]
        CL["Cargo.lock"]
        AS["assets/"]
        GI[".gitignore"]
        RD["README.md"]
        LIC["LICENSE"]
    end

    %% Flows
    UI1 -->|"user event"| M
    UI2 -->|"user event"| M
    UI3 -->|"user event"| M
    UI4 -->|"user event"| M
    UI5 -->|"user event"| M

    M -->|"load/save profiles"| PM
    PM -->|"HTTP GET images"| SGDB
    M -->|"extract action"| EX
    EX -->|"extract archives"| TEMP
    TEMP -->|"files ready"| FM
    FM -->|"move/symlink files"| TGT
    FM -->|"update state"| M
    M -->|"persist profiles"| CFG
    PM -->|"read .env KEY"| CFG

    %% Click Events
    click UI1 "https://github.com/pezfisk/oxidemanager/blob/master/ui/app-window.slint"
    click UI2 "https://github.com/pezfisk/oxidemanager/blob/master/ui/grid_view.slint"
    click UI3 "https://github.com/pezfisk/oxidemanager/blob/master/ui/profile-edit.slint"
    click UI4 "https://github.com/pezfisk/oxidemanager/blob/master/ui/profile-images.slint"
    click UI5 "https://github.com/pezfisk/oxidemanager/blob/master/ui/profile-state.slint"
    click M "https://github.com/pezfisk/oxidemanager/blob/master/src/main.rs"
    click PM "https://github.com/pezfisk/oxidemanager/blob/master/src/profile_manager.rs"
    click EX "https://github.com/pezfisk/oxidemanager/blob/master/src/extract.rs"
    click FM "https://github.com/pezfisk/oxidemanager/blob/master/src/file_manager.rs"
    click BS "https://github.com/pezfisk/oxidemanager/blob/master/build.rs"
    click CC "https://github.com/pezfisk/oxidemanager/blob/master/.cargo/config.toml"
    click BH "https://github.com/pezfisk/oxidemanager/blob/master/build.sh"
    click CT "https://github.com/pezfisk/oxidemanager/blob/master/Cargo.toml"
    click CL "https://github.com/pezfisk/oxidemanager/blob/master/Cargo.lock"
    click AS "https://github.com/pezfisk/oxidemanager/tree/master/assets"
    click GI "https://github.com/pezfisk/oxidemanager/blob/master/.gitignore"
    click RD "https://github.com/pezfisk/oxidemanager/blob/master/README.md"
    click LIC "https://github.com/pezfisk/oxidemanager/tree/master/LICENSE"

    %% Styles
    classDef ui fill:#A8DADC,stroke:#457B9D,color:#1D3557
    classDef core fill:#2F9E44,stroke:#1B4332,color:#F1FAEE
    classDef fs fill:#CED4DA,stroke:#ADB5BD,color:#212529
    classDef external fill:#F4A261,stroke:#E76F51,color:#FFFFFF
    classDef config fill:#9D4EDD,stroke:#6A4C93,color:#FFFFFF

    class UI1,UI2,UI3,UI4,UI5 ui
    class M,PM,EX,FM core
    class SRC,TEMP,TGT,CFG fs
    class SGDB external
    class BS,CC,BH,CT,CL,AS,GI,RD,LIC config
```
