# mitskiyu/capycut architecture

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

- Interactive diagram: https://gitdiagram.com/mitskiyu/capycut
- Repository: https://github.com/mitskiyu/capycut

## Overview

##### Project type and purpose
- It is not a client-server or multi-tier web app; it’s a desktop command-line/GUI tool that interacts with the Steam installation and the Windows file system.

##### File structure
- Top-level files:
- build.lua – build script
- src/main.cpp – entry point
- src/shortcut.cpp/.hpp – shortcut-generation logic
- src/steam.cpp/.hpp – Steam-integration logic
- No frontend/backend split: everything lives in one codebase.
- No database, no web APIs, no microservices.

##### README for additional insights
- Confirms Windows-only support.
- Outputs to Start Menu\Programs\Capycut.

a. Main components:
- User Interface (CLI or minimal GUI wrapper in main.cpp)
- Core Application Logic
- Steam Integration Module (steam.cpp/.hpp)
- Shortcut Generation Module (shortcut.cpp/.hpp)
- Windows File System / Start Menu Target
- Build System (Lua script, optional)
b. Relationships and interactions:
1. User invokes capycut.exe (UI) →
2. UI calls Core Logic →
3. Core Logic queries Steam Integration Module for installed games →
4. Core Logic passes game metadata to Shortcut Generation Module →
5. Shortcut Module writes .lnk files into the Windows Start Menu folder via Windows Shell API →
6. UI reports success/failure to the user.
c. Architectural patterns or design principles:
- Single executable; layered within: presentation (main.cpp) → domain (steam + shortcut modules) → infrastructure (Windows API).
- Separation of concerns: Steam data retrieval separated from .lnk file creation.
d. Key technologies/frameworks/libraries:
- C++17 (or later)
- Windows Shell COM interfaces for link creation
- Steam’s local config files or registry for game enumeration
- Lua build script (build.lua)

##### Detailed breakdown
- Middle tier: “Core Application” package containing two sub-packages: Steam Integration and Shortcut Generation
- Right side: two external targets:
- “Local Steam Installation / Registry”
- “Windows Start Menu Folder”

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User
    U["User Terminal"]:::external

    %% Application boundary
    subgraph "Application"
        direction TB
        UI["UI (main.cpp)"]:::app
        Core["Core Logic (main.cpp)"]:::app
        Steam["Steam Integration Module"]:::app
        Shortcut["Shortcut Generation Module"]:::app
    end

    %% External systems
    subgraph "External Systems"
        direction TB
        SteamSys["Local Steam Installation/Registry"]:::external
        WinFS["Windows Start Menu Folder"]:::external
    end

    %% Build system
    Build["Build System (build.lua)"]:::build

    %% Data flows
    U -->|"invokes"| UI
    UI -->|"calls"| Core
    Core -->|"queries"| Steam
    Steam -->|"reads data from"| SteamSys
    SteamSys -->|"returns game list"| Steam
    Steam -->|"provides metadata to"| Core
    Core -->|"passes metadata to"| Shortcut
    Shortcut -->|"creates .lnk files in"| WinFS
    WinFS -->|"confirmation"| Shortcut
    Shortcut -->|"reports status to"| UI
    Build -->|"builds executable"| UI

    %% Click events
    click UI "https://github.com/mitskiyu/capycut/blob/main/src/main.cpp"
    click Core "https://github.com/mitskiyu/capycut/blob/main/src/main.cpp"
    click Steam "https://github.com/mitskiyu/capycut/blob/main/src/steam.cpp"
    click Steam "https://github.com/mitskiyu/capycut/blob/main/src/steam.hpp"
    click Shortcut "https://github.com/mitskiyu/capycut/blob/main/src/shortcut.cpp"
    click Shortcut "https://github.com/mitskiyu/capycut/blob/main/src/shortcut.hpp"
    click Build "https://github.com/mitskiyu/capycut/blob/main/build.lua"

    %% Styles
    classDef app fill:#D0E8FF,stroke:#0366D6,color:#0366D6;
    classDef external fill:#DFFFE0,stroke:#28A745,color:#28A745;
    classDef build fill:#FFF4D0,stroke:#E69500,color:#E69500;
```
