# kitswas/virtualgamepad-mobile architecture

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

- Interactive diagram: https://gitdiagram.com/kitswas/virtualgamepad-mobile
- Repository: https://github.com/kitswas/virtualgamepad-mobile

## Overview

##### Project type and purpose
- This is an Android mobile client app (“VirtualGamePad Mobile”) that turns your phone into a gamepad for your computer.
- It is part of the larger VirtualGamePad system; this repo contains only the Android front-end.

##### File structure
- Top-level files: gradle build scripts, fastlane metadata, GitHub CI workflows.
- “app/” module: standard Android Studio project with Kotlin source under “src/main/java” and tests under “src/test/java” and “src/androidTest/java”.
- Subpackages under app/src/main/java/io/github/kitswas/virtualgamepadmobile:
- data (models, Defaults, SettingsRepository)
- network (ConnectionViewModel, ConnectionState, NetworkCommand)
- ui (Jetpack Compose components and screens)
- ui/theme and ui/utils
- AndroidManifest, resources (res/), ProGuard rules, and build.gradle.kts confirm a single-module Android app.
- No backend code here; it communicates with an external PC-side server.

##### README
- Confirms purpose: “use your Android phone as a gamepad for your computer.”
- Links to broader VirtualGamePad project (server code lives elsewhere).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        ConnectScreen["ConnectScreen"]:::ui
        GamepadScreen["Gamepad Screen"]:::ui
        SettingsScreen["Settings Screen"]:::ui
        QRCodeScanner["QR Code Scanner"]:::ui
        AnalogStick["Analog Stick"]:::ui
        FaceButtons["Face Buttons"]:::ui
        Theme["Theme & Color"]:::ui
        Utils["Haptic & Activity Utils"]:::ui
    end

    %% ViewModel Layer
    subgraph "ViewModel Layer"
        direction TB
        ConnectionViewModel["ConnectionViewModel"]:::viewmodel
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        SettingsRepository["SettingsRepository"]:::data
        Defaults["Defaults"]:::data
        ColorScheme["ColorScheme Model"]:::data
    end

    %% Network Layer
    subgraph "Network Layer"
        direction TB
        NetworkCommand["NetworkCommand"]:::network
        ConnectionState["ConnectionState"]:::network
    end

    %% External Server
    VirtualGamepadServer["VirtualGamePad Server (PC)"]:::external

    %% Interactions
    ConnectScreen -->|user input| ConnectionViewModel
    GamepadScreen -->|user actions| ConnectionViewModel
    SettingsScreen -->|adjust settings| ConnectionViewModel
    QRCodeScanner -->|scan IP| ConnectionViewModel
    AnalogStick -->|touch events| ConnectionViewModel
    FaceButtons -->|touch events| ConnectionViewModel
    Theme -->|provides style| ConnectScreen
    Theme -->|provides style| GamepadScreen
    Theme -->|provides style| SettingsScreen
    Utils -->|helpers| ConnectScreen

    ConnectionViewModel -->|reads/writes| SettingsRepository
    ConnectionViewModel -->|reads defaults| Defaults
    ConnectionViewModel -->|reads schemes| ColorScheme
    ConnectionViewModel -->|sends commands| NetworkCommand
    NetworkCommand -->|to server| VirtualGamepadServer
    VirtualGamepadServer -->|responses| ConnectionState
    ConnectionState -->|updates| ConnectionViewModel
    ConnectionViewModel -->|state updates| ConnectScreen
    ConnectionViewModel -->|state updates| GamepadScreen

    %% Click Events
    click ConnectScreen "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/screens/ConnectScreen.kt"
    click GamepadScreen "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/screens/Gamepad.kt"
    click SettingsScreen "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/screens/SettingsScreen.kt"
    click QRCodeScanner "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/components/QRCodeScanner.kt"
    click AnalogStick "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/composables/AnalogStick.kt"
    click FaceButtons "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/composables/FaceButtons.kt"
    click Theme "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/theme/Theme.kt"
    click Theme_Color "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/theme/Color.kt"
    click Utils "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/utils/HapticUtils.kt"
    click Utils "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/ui/utils/FindActivity.kt"
    click ConnectionViewModel "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/network/ConnectionViewModel.kt"
    click NetworkCommand "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/network/NetworkCommand.kt"
    click ConnectionState "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/network/ConnectionState.kt"
    click SettingsRepository "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/data/SettingsRepository.kt"
    click Defaults "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/data/Defaults.kt"
    click ColorScheme "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/data/ColorScheme.kt"
    click MainActivity "https://github.com/kitswas/virtualgamepad-mobile/blob/main/app/src/main/java/io/github/kitswas/virtualgamepadmobile/MainActivity.kt"

    %% Styles
    classDef ui fill:#add8e6,stroke:#0366d6,stroke-width:1px
    classDef viewmodel fill:#dda0dd,stroke:#8b008b,stroke-width:1px
    classDef data fill:#90ee90,stroke:#006400,stroke-width:1px
    classDef network fill:#ffdead,stroke:#cd8500,stroke-width:1px
    classDef external fill:#d3d3d3,stroke:#696969,stroke-width:1px
```
