# webtorrent/webtorrent-desktop architecture

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

- Interactive diagram: https://gitdiagram.com/webtorrent/webtorrent-desktop
- Repository: https://github.com/webtorrent/webtorrent-desktop

## Overview

##### Main Components

a. Application Layer (Electron Framework)
- Main Process (src/main)
- Renderer Process (src/renderer)
- IPC Communication Channel

b. Core Features
- Torrent Management System
- Media Player
- File System Integration
- User Interface Components

##### Detailed Component Breakdown

- Window Management (src/main/windows)
- System Integration (Dock, Tray, Shortcuts)
- Update System
- External Players
- Crash Reporter
- Configuration Management

- Controllers Layer
- Media Controller
- Torrent Controller
- Playback Controller
- Preferences Controller
- UI Components Layer
- Pages (Player, Preferences, Torrent List)
- Modals
- Header Components
- Library Layer
- State Management
- Torrent Operations
- Media Handling
- Telemetry

**┌─────────────────────────────────────────────────────┐**
- Electron App                       │
- ┐         ┌─────────────────────┐
- Main Process    │◄─────►  │  Renderer Process   │
- IPC   │                     │
- ┤         ├─────────────────────┤
- Window Manager  │         │ - Controllers       │
- System Services │         │ - UI Components     │
- Update System   │         │ - Library/Utils     │
- ┘         └─────────────────────┘

##### Key Interactions to Highlight

a. Data Flow:
- Torrent download/upload streams
- Media playback pipeline
- Configuration changes
- System events

b. External Interactions:
- File system access
- Network connections
- System integration points

##### Implementation Details

- Clear separation between main and renderer processes
- How the torrent streaming integrates with the media player
- System tray and notification integration
- Configuration and state management flow

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Electron["Electron Desktop App"]
        subgraph MainProcess["Main Process"]
            WM["Window Management"]:::main
            SI["System Integration"]:::main
            US["Update System"]:::main
            EP["External Players"]:::main
            CR["Crash Reporter"]:::main
            CM["Configuration Management"]:::main
            FSI["File System Integration"]:::main
            IPC["IPC Communication"]:::main
            
            subgraph SysInt["System Integration Components"]
                Dock["Dock"]:::main
                Tray["Tray"]:::main
                Short["Shortcuts"]:::main
            end
        end

        subgraph RendererProcess["Renderer Process"]
            subgraph Controllers["Controllers Layer"]
                MC["Media Controller"]:::renderer
                TC["Torrent Controller"]:::renderer
                PC["Playback Controller"]:::renderer
                PrefC["Preferences Controller"]:::renderer
                ATC["Audio Tracks Controller"]:::renderer
            end

            subgraph UI["UI Components Layer"]
                Pages["Pages"]:::renderer
                Comps["Components"]:::renderer
                Header["Header"]:::renderer
            end

            subgraph Library["Library Layer"]
                SM["State Management"]:::renderer
                TO["Torrent Operations"]:::renderer
                MH["Media Handling"]:::renderer
                TM["Telemetry"]:::renderer
                WTI["WebTorrent Integration"]:::renderer
                ME["Media Extensions"]:::renderer
            end
        end
    end

    %% Connections
    MainProcess <--> |IPC| RendererProcess
    SysInt --> SI
    Controllers --> UI
    Controllers --> Library
    
    %% Click Events
    click WM "https://github.com/webtorrent/webtorrent-desktop/tree/master/src/main/windows/"
    click Dock "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/main/dock.js"
    click Tray "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/main/tray.js"
    click Short "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/main/shortcuts.js"
    click US "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/main/updater.js"
    click EP "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/main/external-player.js"
    click CR "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/crash-reporter.js"
    click FSI "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/main/folder-watcher.js"
    click IPC "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/main/ipc.js"
    click CM "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/config.js"
    
    click MC "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/controllers/media-controller.js"
    click TC "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/controllers/torrent-controller.js"
    click PC "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/controllers/playback-controller.js"
    click PrefC "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/controllers/prefs-controller.js"
    click ATC "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/controllers/audio-tracks-controller.js"
    
    click Pages "https://github.com/webtorrent/webtorrent-desktop/tree/master/src/renderer/pages/"
    click Comps "https://github.com/webtorrent/webtorrent-desktop/tree/master/src/renderer/components/"
    click Header "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/components/header.js"
    
    click SM "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/lib/state.js"
    click TO "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/lib/torrent-summary.js"
    click MH "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/lib/torrent-player.js"
    click TM "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/lib/telemetry.js"
    click WTI "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/webtorrent.js"
    click ME "https://github.com/webtorrent/webtorrent-desktop/blob/master/src/renderer/lib/media-extensions.js"

    %% Styles
    classDef main fill:#2374ab
    classDef renderer fill:#2a9d8f
    classDef external fill:#e76f51

    %% Legend
    subgraph Legend
        Main["Main Process Component"]:::main
        Rend["Renderer Process Component"]:::renderer
        Ext["External Component"]:::external
    end
```
