# the-paid-actor/dcs-dtc architecture

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

- Interactive diagram: https://gitdiagram.com/the-paid-actor/dcs-dtc
- Repository: https://github.com/the-paid-actor/dcs-dtc

## Overview

##### Project Type and Purpose
- This is a Windows desktop application built in .NET 7.0 (WinForms) that emulates a Data Cartridge (DTC) for various aircraft in DCS World (F-16, F/A-18, F-15E, Apache).
- It provides UI for creating, loading, sharing and uploading mission presets, coordinate capture via in-game Lua scripts, and a CLI for automation.
- Secondary projects include:
- DTCCodeGenerator: a Roslyn source generator tool producing strongly-typed preset classes at build time.
- installer: Visual Studio deployment project producing an MSI.

##### Key Architectural Components
A. Build & Deployment
- DTCCodeGenerator.csproj runs during build to generate/mutate code (via SourceGenerator.cs).
- dcs-dtc.sln builds the Desktop App (dcs-dtc) and CodeGenerator.
- installer.vdproj packages the compiled desktop app, Lua scripts, and installer components.

B. Desktop Client (dcs-dtc)
1. Program.cs (entrypoint)
- Parses command-line args (--load, --upload, --exit).
- Instantiates MainForm (WinForms).
2. UI Layer
- UI/Base: core forms, controls (buttons, grids, dialogs).
- UI/Aircraft-specific pages under New/UI/Aircrafts (AH64D, F15E, F16, FA18) generated by the source generator and powered by Preset models.
- UI/Base/Systems: reusable system panels (RadioControl, WaypointEdit, KneeboardPage).
3. Preset Model & Config
- New/Presets/V1 and V2: domain model for each aircraft’s configuration.
- Base/ConfigLoader, Configuration, Preset classes handle JSON<–>C# mapping.
- Utilities/FileStorage reads/writes presets and settings in Documents\DCS-DTC.
4. Uploader Engine
- New/Uploader defines per-aircraft uploader classes (e.g. F16Uploader, AH64DUploader).
- Base/Uploader abstracts command sequences, conditions, devices.
- Utilities/CockpitUploadHelper & Network (UDPSocket, KneeboardSender, PresetDataSender) manage the handshake with DCS Lua.
5. Utilities
- Coordinate conversion, INI management (IniFile), NamedPipeServer for IPC.
- Network receivers (CockpitInfoReceiver, WaypointCaptureReceiver) listen for DCS-side events.
6. Embedded DCS Scripts
- Under dcs-dtc/DCS: Lua scripts (DCSDTC.lua, hook.lua) and Skins deliver in-cockpit UI and capture dialogs.
- DCS/Hooks/DCSDTCHook.lua injects the main Lua script into the simulation.

C. DCS Integration
- Lua scripts run inside DCS and communicate over UDP and Named Pipes back to the Windows client.
- Keyboard shortcuts (Ctrl+Shift+D/K) trigger dialogs and data exchange.

##### Relationships & Data Flow
- Build: → [DTCCodeGenerator] → generates C# model code → compiled into Desktop Client.
- Installer: bundles Desktop Client + DCS Scripts → end user installation.
- Runtime:
a. User invokes Desktop Client (WinForms).
b. UI loads Presets from FileStorage.
c. Selecting “Upload” calls Uploader Engine → sends commands via UDP/Named Pipes to DCS scripts → configures in-game jet.
d. User presses cockpit button in DCS → Lua scripts capture event → send data back to Desktop Client via NamedPipe/UDP → UI updates.
- CLI mode: Program.cs processes args → loads preset → triggers upload → exits.

##### Architectural Patterns & Design Principles
- Modular “Plugin” style for aircraft: each aircraft has its own Preset, UI, and Uploader under New/…
- Factory pattern: AircraftPageFactory creates the correct UI page based on selected aircraft.
- Command pattern: Base/Uploader chains commands and conditions for each device.
- Separation of concerns:
- UI vs. Model (Presets) vs. Uploader vs. Utilities (storage, network).
- Build-time code generation for strong typing (SourceGenerator).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Build & Deployment
    subgraph "Build & Deployment"
        SLN["dcs-dtc.sln"]:::net
        CodeGen["DTCCodeGenerator"]:::net
        Install["Installer"]:::net
    end

    %% Desktop Client
    subgraph "Desktop Client"
        direction TB
        subgraph "UI Layer"
            direction TB
            Program["Program.cs"]:::net
            CLIProc["CommandLineProcessor.cs"]:::net
            MainForm["MainForm.cs"]:::net
            Factory["AircraftPageFactory.cs"]:::net
            Controls["Base Controls"]:::net
            SharedPages["Shared Base Pages"]:::net
            subgraph "Aircraft Pages"
                direction TB
                AH64DPage["AH64DPage.cs"]:::net
                F15EPage["F15EPage.cs"]:::net
                F16Page["F16Page.cs"]:::net
                FA18Page["FA18Page.cs"]:::net
            end
        end

        subgraph "Preset Model & Config"
            direction TB
            V1["V1 Models"]:::net
            V2["V2 Models"]:::net
            BaseConfig["ConfigLoader/Configuration/Preset"]:::net
        end

        subgraph "Uploader Engine"
            direction TB
            UploaderBase["Base Uploader"]:::net
            UploaderCmds["Command & Condition"]:::net
            subgraph "Aircraft Uploaders"
                direction TB
                AH64DU["AH64DUploader"]:::net
                F15EU["F15EUploader"]:::net
                F16U["F16Uploader"]:::net
                FA18U["FA18Uploader"]:::net
            end
        end

        subgraph "Utilities"
            direction TB
            FileStorage["FileStorage"]:::storage
            CockpitHelper["CockpitUploadHelper"]:::net
            UDP["UDPSocket"]:::network
            NamedPipe["NamedPipeServer"]:::network
            Receivers["Receivers/Senders"]:::network
            Ini["IniFile"]:::net
            Coord["Coordinate"]:::net
        end
    end

    %% DCS Environment
    subgraph "DCS Environment"
        direction TB
        Scripts["DCSDTC.lua & Dialogs"]:::lua
        Hook["DCSDTCHook.lua"]:::lua
        AircraftLua["Aircraft Functions"]:::lua
        Skins["Skins"]:::lua
    end

    %% External Systems
    subgraph "External Systems"
        direction TB
        FS["File System (Documents\\DCS-DTC)"]:::storage
        DCSWorld["DCS World"]:::net
        Discord["Discord/Online"]:::net
    end

    %% Relationships
    SLN -->|builds| CodeGen
    SLN -->|builds| Program
    CodeGen -->|generates models| V1
    CodeGen -->|generates models| V2

    Program --> CLIProc
    Program --> MainForm
    MainForm --> Factory
    MainForm --> Controls
    MainForm --> SharedPages
    Factory --> AH64DPage
    Factory --> F15EPage
    Factory --> F16Page
    Factory --> FA18Page

    MainForm --> FileStorage
    FileStorage --> FS

    MainForm -->|uses| UploaderBase
    UploaderBase --> UploaderCmds
    UploaderBase --> AH64DU
    UploaderBase --> F15EU
    UploaderBase --> F16U
    UploaderBase --> FA18U

    AH64DU --> UDP
    F15EU --> UDP
    F16U --> UDP
    FA18U --> UDP

    AH64DU --> NamedPipe
    F15EU --> NamedPipe
    F16U --> NamedPipe
    FA18U --> NamedPipe

    UDP --> Scripts
    NamedPipe --> Scripts

    Scripts --> Receivers
    Receivers --> MainForm

    MainForm --> CockpitHelper
    CockpitHelper --> NamedPipe

    MainForm --> Ini
    MainForm --> Coord

    Install --> Program
    Install --> Scripts
    Install --> Skins

    Discord --> FS

    DCSWorld --> Scripts

    %% Click Events
    click SLN "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc.sln"
    click CodeGen "https://github.com/the-paid-actor/dcs-dtc/blob/main/DTCCodeGenerator/SourceGenerator.cs"
    click Install "https://github.com/the-paid-actor/dcs-dtc/blob/main/installer/installer.vdproj"
    click Program "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/Program.cs"
    click CLIProc "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/UI/Base/CommandLineProcessor.cs"
    click MainForm "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/UI/Base/MainForm.cs"
    click Factory "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/UI/Base/Pages/AircraftPageFactory.cs"
    click Controls "https://github.com/the-paid-actor/dcs-dtc/tree/main/dcs-dtc/UI/Base/Controls"
    click SharedPages "https://github.com/the-paid-actor/dcs-dtc/tree/main/dcs-dtc/New/UI/Base/Pages"
    click AH64DPage "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/UI/Aircrafts/AH64D/AH64DPage.cs"
    click F15EPage "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/UI/Aircrafts/F15E/F15EPage.cs"
    click F16Page "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/UI/Aircrafts/F16/F16Page.cs"
    click FA18Page "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/UI/Aircrafts/FA18/FA18Page.cs"
    click V1 "https://github.com/the-paid-actor/dcs-dtc/tree/main/dcs-dtc/New/Presets/V1/Aircrafts"
    click V2 "https://github.com/the-paid-actor/dcs-dtc/tree/main/dcs-dtc/New/Presets/V2/Aircrafts"
    click BaseConfig "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/Presets/V2/Base/ConfigLoader.cs"
    click UploaderBase "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/Uploader/Base/Uploader.cs"
    click AH64DU "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/Uploader/Aircrafts/AH64D/AH64DUploader.cs"
    click F15EU "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/Uploader/Aircrafts/F15E/F15EUploader.cs"
    click F16U "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/Uploader/Aircrafts/F16/F16Uploader.cs"
    click FA18U "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/New/Uploader/Aircrafts/FA18/FA18Uploader.cs"
    click FileStorage "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/Utilities/FileStorage.cs"
    click CockpitHelper "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/Utilities/CockpitUploadHelper.cs"
    click UDP "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/Utilities/Network/UDPSocket.cs"
    click NamedPipe "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/Utilities/NamedPipeServer.cs"
    click Receivers "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/Utilities/Network/CockpitInfoReceiver.cs"
    click Ini "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/Utilities/IniFile.cs"
    click Coord "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/Utilities/Coordinate.cs"
    click Scripts "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/DCS/DCSDTC.lua"
    click Hook "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/DCS/Hooks/DCSDTCHook.lua"
    click AircraftLua "https://github.com/the-paid-actor/dcs-dtc/blob/main/dcs-dtc/DCS/DCSDTC/ah64DFunctions.lua"
    click Skins "https://github.com/the-paid-actor/dcs-dtc/tree/main/dcs-dtc/DCS/DCSDTC/Skins"

    %% Styles
    classDef net fill:#D0E8FF,stroke:#3B7DDD,color:#000
    classDef storage fill:#E8E8E8,stroke:#999,color:#000
    classDef lua fill:#DFFFD0,stroke:#4F8A10,color:#000
    classDef network fill:#FFE8A0,stroke:#D17E00,color:#000
```
