# eauploader/eauploader-for-vrchat architecture

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

- Interactive diagram: https://gitdiagram.com/eauploader/eauploader-for-vrchat
- Repository: https://github.com/eauploader/eauploader-for-vrchat

## Overview

##### Main Components
- Editor Extension Module:
- This is the heart of the integration. It includes folders such as “Editor,” which itself is subdivided into API definitions (under “Public EAUploader API”), UI Components (under “Resources/UI” and its subdirectories for Windows, Components, ImportSettings, etc.), and core scripts (in “Scripts”) that manage functionalities such as asset processing, configuration, logging, and uploading.
- Runtime Library:
- Located under the “Runtime” directory. This part includes components that will be compiled into the final build and may provide runtime support for features or metadata used by avatars.
- Configuration & Build Tools:
- The “vpm” folder, configuration files (.toml, package.json, build.js, etc.), and GitHub workflows are used for managing package versions, linting (ESLint with .eslintrc.yaml), and automatic deployment.
- External Dependencies:
- There is an explicit dependency on external systems such as VRChat Creator Companion or ALCOM, as stated in the README. It also interacts with VRChat SDK components (note the VRCSDK folder inside Editor/Scripts) and might rely on external services for updates, integration (such as Discord for feedback), and translations.

##### Relationships and Interactions
- The Unity Editor acts as the “front-end” for developers/users:
- The Editor UI interacts with the API modules which are responsible for calling the core upload functionalities.
- When a user triggers an action in the custom Unity window (displayed automatically on project startup), the UI components (UXML, USS) forward events to attached scripts (for example, scripts within Editor/Scripts like EAUploaderCore and EAUploaderEditorManager).
- The Core Module:
- Processes assets using scripts in the Editor folder (AssetProcessor, Prefab utilities, etc.).
- Communicates with Runtime components if needed.
- External Integration:
- The uploader communicates with systems provided by VRChat Creator Companion (or ALCOM) and possibly leverages the VRCSDK to perform avatar uploads.
- The configuration is managed using the provided build and package files so that every component is versioned and built automatically (via the GitHub workflows and vpm configuration).

##### Architectural Patterns and Design Principles
- Separation of Concerns:
- Editor code (UI and processing) is clearly separated from Runtime code.
- Modularization:
- The “Public EAUploader API” exposes a set of functionalities for plug-in developers and ensures extensibility.
- Resource Organization:
- Automated Build & Deployment:

## Diagram (Mermaid)

```mermaid
graph TD
    user("User"):::userStyle

    subgraph "Unity Editor - Editor Extension"
        pubAPI("Public API Module"):::editorStyle
        uiModule("UI Resources"):::editorStyle
        coreProc("Core Scripts & Asset Processing"):::editorStyle
    end

    runtimeLib("Runtime Library"):::runtimeStyle
    buildConfig("CI/CD & Build System"):::buildStyle

    subgraph "External Dependencies"
        vrchatInt("VRChat Creator Companion/ALCOM"):::externalStyle
        discordFeed("Discord/Feedback"):::externalStyle
    end

    user -->|"triggers"| uiModule
    uiModule -->|"calls"| pubAPI
    uiModule -->|"activates"| coreProc
    pubAPI -->|"invokes"| coreProc
    coreProc -->|"communicates_with"| runtimeLib
    coreProc -->|"uploads_to"| vrchatInt
    coreProc -->|"logs_to"| discordFeed
    buildConfig -->|"builds"| pubAPI
    buildConfig -->|"builds"| coreProc
    buildConfig -->|"builds"| runtimeLib

    click pubAPI "https://github.com/eauploader/eauploader-for-vrchat/tree/main/Editor/Public EAUploader API"
    click uiModule "https://github.com/eauploader/eauploader-for-vrchat/tree/main/Editor/Resources/UI"
    click coreProc "https://github.com/eauploader/eauploader-for-vrchat/tree/main/Editor/Scripts"
    click runtimeLib "https://github.com/eauploader/eauploader-for-vrchat/tree/main/Runtime"
    click buildConfig "https://github.com/eauploader/eauploader-for-vrchat/blob/main/.vpm"

    classDef userStyle fill:#E8DAEF,stroke:#8E44AD,stroke-width:2px;
    classDef editorStyle fill:#AED6F1,stroke:#2980B9,stroke-width:2px;
    classDef runtimeStyle fill:#A9DFBF,stroke:#27AE60,stroke-width:2px;
    classDef buildStyle fill:#F9E79F,stroke:#F1C40F,stroke-width:2px;
    classDef externalStyle fill:#F5B7B1,stroke:#E74C3C,stroke-width:2px;
```
