# matrixchung/edautopilot-v2 architecture

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

- Interactive diagram: https://gitdiagram.com/matrixchung/edautopilot-v2
- Repository: https://github.com/matrixchung/edautopilot-v2

## Overview

##### Project type and purpose
- EDAutopilot is a desktop automation tool (an “autopilot bot”) written in Python.
- It uses OpenCV for computer‐vision, DirectInput for sending keystrokes/mouse events, and PyQt‐style .ui files for its GUI.
- Its primary domain is automating Elite:Dangerous Horizons gameplay, especially the Robigo sightseeing mission, with a plugin script architecture.

##### File structure
- Top‐level entry points:
- gameui.py – loads the GUI, hosts the Script Loader, start/stop buttons.
- scripts/ – a plugin directory of mission scripts (ScriptBase.py, robigo.py, autojumper.py, example.py).
- assets/ – Qt Designer .ui files (main.ui, sub.ui) defining the GUI layout.
- utils/ – core libraries providing services:
- config.py – app and script configuration loading.
- session.py, status.py, journal.py – game session state & persistence.
- directinputs.py – keyboard/mouse injection.
- image.py – OpenCV wrappers (screenshot capture, template matching).
- keybinds.py – parsing game keybind settings.
- utils.py – misc helpers.
- templates/robigo/ – reference images for navigation map matching.
- requirements.txt – Python dependencies (OpenCV, PyQt5, etc.).
- scripts/__init__.py, utils/__init__.py – Python packages.

##### README for architectural insights
- Mentions a “gameSession API” accessible to scripts.
- Shows a high‐level structure image (GUI → Script Loader → Script → gameSession → utils → DirectInput/OpenCV).
- Emphasizes plugin extensibility via the scripts folder.

##### Components & their relationships
a. Main components:
1. GUI Layer (gameui.py + assets/*.ui)
2. Script Loader & Plugin Manager (in gameui.py, uses scripts/ScriptBase.py)
3. Script Plugins (scripts/*.py)
4. Core Engine (gameSession API + utils modules)
5. CV Engine (utils/image + templates/…)
6. Input Emulation (utils/directinputs.py)
7. External System: Elite:Dangerous game window

b. Interactions & data flow:
- User clicks “Load Script” in GUI → Script Loader instantiates a ScriptBase subclass.
- Script invokes gameSession API to query current state (session.py, status.py).
- gameSession uses utils/image to grab screenshots and template‐match against templates/ to detect UI elements.
- Based on CV output, gameSession calls directinputs to send keystrokes/mouse.
- The cycle repeats in the script’s main loop; status updates bubble back to the GUI.

c. Architectural patterns & design principles:
- Plugin architecture: ScriptBase interface + dynamic loading of scripts.
- Layered separation: Presentation (GUI), Application (Script Logic), Service (gameSession/utils), Infrastructure (CV, Input).
- Single Responsibility: each utils/*.py module encapsulates one concern (config, image, input).

d. Key technologies & libraries:
- Python 3.x
- OpenCV (cv2) for image processing
- PyQt5 (or PySide2) for GUI, with .ui files designed in Qt Designer
- DirectInput (via custom Python wrapper) for input injection
- Standard libs: threading, logging, configparser, etc.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer (Blue)
    subgraph "Presentation Layer"
        direction TB
        GUI["GUI Layer"]:::presentation
        MainUI["Main UI (.ui)"]:::presentation
        SubUI["Sub UI (.ui)"]:::presentation
    end

    %% Application Layer (Green)
    subgraph "Application / Plugins" 
        direction TB
        PluginMgr["Script Loader & Plugin Manager"]:::application
        subgraph "Script Plugins"
            direction TB
            ScriptBase["ScriptBase Interface"]:::application
            Robigo["Robigo Script"]:::application
            Autojumper["Autojumper Script"]:::application
            ExampleScript["Example Script"]:::application
        end
    end

    %% Services Layer (Orange)
    subgraph "Core Engine" 
        direction TB
        Config["Config Service"]:::service
        Session["Session Management"]:::service
        Status["Status Tracking"]:::service
        Journal["Journal Persistence"]:::service
        Keybinds["Keybinds Parsing"]:::service
    end

    %% Infrastructure Layer (Purple)
    subgraph "Infrastructure"
        direction TB
        subgraph "CV Engine"
            direction TB
            ImageProc["Image Processing"]:::infrastructure
            Templates["Template Assets"]:::infrastructure
        end
        DirectInput["DirectInput Wrapper"]:::infrastructure
        Helpers["Misc Helpers"]:::infrastructure
    end

    %% External System (Gray)
    External["Elite:Dangerous Game Window"]:::external

    %% Data Flows
    GUI -->|"start/stop"| PluginMgr
    PluginMgr -->|"instantiate"| ScriptBase
    ScriptBase -->|"executes"| Robigo
    ScriptBase -->|"executes"| Autojumper
    ScriptBase -->|"executes"| ExampleScript

    Robigo -->|"queryState() / updateStatus()"| Session
    Autojumper -->|"queryState() / updateStatus()"| Session
    ExampleScript -->|"queryState() / updateStatus()"| Session

    Session -->|"loadConfig()"| Config
    Session -->|"track()"| Status
    Session -->|"persist()"| Journal
    Session -->|"parseKeybinds()"| Keybinds

    Session -->|"captureFrame()"| ImageProc
    ImageProc -->|"matchTemplate()"| Templates
    ImageProc -->|"detectionResult"| Session

    Session -->|"sendKey() / sendMouse()"| DirectInput

    DirectInput -->|"input events"| External
    External -->|"screen/frame"| ImageProc

    Session -->|"updateStatus()"| GUI

    %% Click Events
    click GUI "https://github.com/matrixchung/edautopilot-v2/blob/master/gameui.py"
    click MainUI "https://github.com/matrixchung/edautopilot-v2/blob/master/assets/main.ui"
    click SubUI "https://github.com/matrixchung/edautopilot-v2/blob/master/assets/sub.ui"
    click PluginMgr "https://github.com/matrixchung/edautopilot-v2/blob/master/gameui.py"
    click ScriptBase "https://github.com/matrixchung/edautopilot-v2/blob/master/scripts/ScriptBase.py"
    click Robigo "https://github.com/matrixchung/edautopilot-v2/blob/master/scripts/robigo.py"
    click Autojumper "https://github.com/matrixchung/edautopilot-v2/blob/master/scripts/autojumper.py"
    click ExampleScript "https://github.com/matrixchung/edautopilot-v2/blob/master/scripts/example.py"
    click Config "https://github.com/matrixchung/edautopilot-v2/blob/master/utils/config.py"
    click Session "https://github.com/matrixchung/edautopilot-v2/blob/master/utils/session.py"
    click Status "https://github.com/matrixchung/edautopilot-v2/blob/master/utils/status.py"
    click Journal "https://github.com/matrixchung/edautopilot-v2/blob/master/utils/journal.py"
    click Keybinds "https://github.com/matrixchung/edautopilot-v2/blob/master/utils/keybinds.py"
    click ImageProc "https://github.com/matrixchung/edautopilot-v2/blob/master/utils/image.py"
    click Templates "https://github.com/matrixchung/edautopilot-v2/tree/master/templates/robigo"
    click DirectInput "https://github.com/matrixchung/edautopilot-v2/blob/master/utils/directinputs.py"
    click Helpers "https://github.com/matrixchung/edautopilot-v2/blob/master/utils/utils.py"
    click Requirements "https://github.com/matrixchung/edautopilot-v2/blob/master/requirements.txt"

    %% Styles
    classDef presentation fill:#AED6F1,stroke:#2E86C1,color:#1B2631
    classDef application fill:#ABEBC6,stroke:#239B56,color:#1B2631
    classDef service fill:#F9E79F,stroke:#B7950B,color:#1B2631
    classDef infrastructure fill:#D2B4DE,stroke:#7D3C98,color:#1B2631
    classDef external fill:#D5D8DC,stroke:#707B7C,color:#1B2631
    class Requirements external
```
