How eauploader/eauploader-for-vrchat works
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: