How mnvrtx/cycladeui works
Main Components
• Unity Host Environment – the overall Unity project structure with Scenes, Prefabs, and ScriptableObjects (e.g., the ExampleScene, GlobalPopupSystemSettings, PopupSystemSettings, etc.).
• Core Libraries:
– GameLogger: Provides logging functionality and debugging tools.
– BaseShared: Offers shared utilities and basic helper functions.
– CycladeBase: Forms part of the core infrastructure and media management (e.g., handling Materials, Prefabs for base debugging canvas, performance analyzer, etc.).
• UI and Interaction Libraries:
– CycladeUI: Manages the UI interfaces and popup system. Key components include the PopupSystem prefab and the related settings.
– CycladeBindings: Handles state management and automatic reference binding for UI elements.
• Supporting Libraries:
– CycladeLocalization: Provides multilingual support by syncing with a Google Sheet and managing localization strings.
– CycladeStorage: Offers persistence and local storage management via a simple API.
• External Dependencies:
– DOTween (from Demigiant): Used by CycladeBindings (and possibly by CycladeUI for animations).
– NewtonsoftJson: Used for serialization and required by CycladeLocalization and CycladeStorage.
Relationships and Dependencies
• Within the Unity project, represent each plugin or library as a separate block. For instance:
– CycladeLocalization depends on both NewtonsoftJson and CycladeStorage; similarly, CycladeStorage needs NewtonsoftJson.
– CycladeUI is at the top layer for UI management and depends on CycladeBindings for state and reference setup.
• External service dependencies such as Google Sheets (for localization sync) as another block, showing that CycladeLocalization interacts with it during its setup (credential JSON, sheet_info.json).
Architectural Patterns & Integration Points
• The architecture follows a modular pattern where each library is self-contained (e.g., each has its own asmdef file) and integrated into the main Unity project using a package-based approach.
• "PopupSystem" as the entry point for UI creation, and then show how popups are created by deriving from the BasePopup class.
• That settings for different popup systems (scriptable objects) allow multiple popup system instances to coexist, representing a flexible and extendable design.
• How the StaticEntryPoint integrates initialization for localization and storage components.
Relevant Technologies, Frameworks, and Libraries
• Unity (with its specific directories such as Assets, ProjectSettings, Packages) as the host environment.
• DOTween for UI animation and asynchronous loading (for popup types like FastFollow and Preload).
• NewtonsoftJson for serialization/deserialization in localization and storage.
• Google Sheets API for data synchronization in CycladeLocalization.
• The usage of Unity’s ScriptableObjects and Prefabs to drive configuration and runtime behavior (e.g., in the popup system).
• Clearly labeled blocks for the main components: Unity Host (Scenes/Prefabs), Core Libraries (GameLogger, BaseShared, CycladeBase), UI Libraries (CycladeUI, CycladeBindings), and Supporting Libraries (CycladeLocalization, CycladeStorage).
• Annotations or sidebar notes that capture configuration aspects like the Google Sheets credential and sheet info handling.