# zackaryw/pyldplayer2 architecture

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

- Interactive diagram: https://gitdiagram.com/zackaryw/pyldplayer2
- Repository: https://github.com/zackaryw/pyldplayer2

## Overview

##### Project type and purpose
- This is a Python library and CLI tool (“pyldplayer2”) for automating and managing LDPlayer emulator instances.
- It exposes a programmatic API (Console, BatchConsole, Query classes) and command-line interfaces (`ldplay`, `reldplay`).
- It also handles LDPlayer configuration files (LeidianFile, RecordFile, SMPFile, KMPFile).

##### File structure
- Top-level: `src/pyldplayer2/` contains three main packages:
- `base/` – core domain models, enums, objects, utilities
- `coms/` – communication layer: console control, file readers/writers, CLI commands
- `utils/` – discovery routines, window layout helpers
- Root files: `pyproject.toml`, `requirements*.lock`, GitHub Actions workflow for publishing.
- Tests in `tests/` validate communication and file handling.
- No separate “frontend” or “backend,” but the CLI acts as the “user interface” and `coms`+`base` form the “service layer.”

##### README for additional insights
- Core features: console management, file operations, instance querying, CLI tools.
- Optional install extras group features by capability: shell, discover, auto, wnd.
- Usage examples show the flow: `discover()` → instantiate Console → `launch()`/`quit()`, or batch methods.

## Diagram (Mermaid)

```mermaid
graph TB
    %% CLI & Dispatcher Layer
    subgraph "CLI & Dispatcher"
        direction TB
        consoleCmds["consoleCmds.py\nCLI Commands"]:::blue
        layout["layout.py\nCLI Layout"]:::blue
        cliCompat["cliCompat.py\nCompatibility"]:::blue
    end

    %% Communication Layer
    subgraph "Communication Layer"
        direction TB
        Console["Console Class"]:::green
        BatchConsole["BatchConsole Class"]:::green
        Query["Query Class"]:::green
        wndInstance["wndInstance\nWindow Control"]:::green
    end

    %% File Format Parsers
    subgraph "File Format Parsers"
        direction TB
        leidianFile["LeidianFile Parser"]:::green
        recordFile["RecordFile Parser"]:::green
        smpFile["SMPFile Parser"]:::green
        kmpFile["KMPFile Parser"]:::green
    end

    %% Core Domain Models
    subgraph "Core Domain Models"
        direction TB
        enums["Enums\nconsole.py"]:::orange
        model_kmp["kmp Model"]:::orange
        model_leidian_config["leidian_config Model"]:::orange
        model_leidians_config["leidians_config Model"]:::orange
        model_list2meta["list2meta Model"]:::orange
        model_record["record Model"]:::orange
        model_smp["smp Model"]:::orange
        obj_appattr["appattr Object"]:::orange
        obj_iconsole["iconsole Object"]:::orange
        obj_pathcache["pathcache Object"]:::orange
    end

    %% Utilities
    subgraph "Utilities"
        direction TB
        discover["discover Utility"]:::purple
        wnd_base["wnd Utility"]:::purple
        wndlayout_base["wndlayout Utility"]:::purple
        wndlayout_util["wndlayout Utility (utils)"]:::purple
        subproc["subproc Wrapper"]:::purple
    end

    %% External Systems
    subgraph "External Systems"
        direction TB
        LDPlayer["LDPlayer Emulator"]:::grey
        HostFS["Host File System"]:::grey
    end

    %% Connections
    consoleCmds -->|calls| Console
    consoleCmds -->|calls| BatchConsole
    layout -->|invokes| Console
    cliCompat -->|adapts| consoleCmds

    Console -->|uses| subproc
    BatchConsole -->|uses| subproc
    wndInstance -->|uses| wnd_base
    wndInstance -->|uses| wndlayout_base

    Console -->|loads/saves| leidianFile
    Console -->|loads/saves| recordFile
    Console -->|loads/saves| smpFile
    Console -->|loads/saves| kmpFile

    leidianFile -->|defines| model_leidian_config
    recordFile -->|defines| model_record
    smpFile -->|defines| model_smp
    kmpFile -->|defines| model_kmp

    BatchConsole -->|manages| model_list2meta
    BatchConsole -->|updates| model_leidians_config

    Query -->|uses| discover
    Query -->|builds| obj_iconsole
    Query -->|builds| obj_appattr
    Query -->|uses| obj_pathcache

    Console -->|reads/writes| HostFS
    leidianFile -->|reads/writes| HostFS
    recordFile -->|reads/writes| HostFS
    smpFile -->|reads/writes| HostFS
    kmpFile -->|reads/writes| HostFS
    subproc -->|executes| LDPlayer

    %% Click Events
    click consoleCmds "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/cli/consoleCmds.py"
    click layout "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/cli/layout.py"
    click cliCompat "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/cliCompat.py"
    click Console "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/console.py"
    click BatchConsole "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/batchConsole.py"
    click Query "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/instanceQuery.py"
    click wndInstance "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/wndInstance.py"
    click leidianFile "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/leidianFile.py"
    click recordFile "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/recordFile.py"
    click smpFile "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/smpFile.py"
    click kmpFile "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/coms/kmpFile.py"
    click enums "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/enums/console.py"
    click model_kmp "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/models/kmp.py"
    click model_leidian_config "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/models/leidian_config.py"
    click model_leidians_config "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/models/leidians_config.py"
    click model_list2meta "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/models/list2meta.py"
    click model_record "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/models/record.py"
    click model_smp "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/models/smp.py"
    click obj_appattr "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/objects/appattr.py"
    click obj_iconsole "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/objects/iconsole.py"
    click obj_pathcache "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/objects/pathcache.py"
    click discover "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/utils/discover.py"
    click wnd_base "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/utils/wnd.py"
    click wndlayout_base "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/utils/wndlayout.py"
    click wndlayout_util "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/utils/wndlayout.py"
    click subproc "https://github.com/zackaryw/pyldplayer2/blob/main/src/pyldplayer2/base/utils/subproc.py"

    %% Styles
    classDef blue fill:#cce5ff,stroke:#0366d6,color:#0366d6
    classDef green fill:#d4edda,stroke:#155724,color:#155724
    classDef orange fill:#fff3cd,stroke:#856404,color:#856404
    classDef purple fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef grey fill:#f8f9fa,stroke:#6c757d,color:#6c757d
```
