- Introduced a new document detailing YAZE's dependency architecture, identifying optimization opportunities, and proposing a roadmap for reducing build times and improving maintainability.
- Included a complete dependency graph, key findings, and a detailed refactoring plan to enhance modularity and reduce circular dependencies.
- Document serves as a reference for future development and architectural decisions, aiming for 40-60% faster incremental builds.
Benefits:
- Provides a clear understanding of the current state and future direction for YAZE's architecture.
- Facilitates better decision-making for developers regarding library organization and build optimization strategies.
- Added LayoutManager to manage ImGui DockBuilder layouts for various editor types, providing professional default layouts similar to VSCode.
- Integrated layout initialization and persistence features, allowing users to save and load custom layouts.
- Updated EditorManager to initialize LayoutManager and set default layouts upon editor activation.
Benefits:
- Improves user experience by offering tailored layouts for different editing tasks.
- Enhances maintainability by centralizing layout management and initialization logic within the new LayoutManager class.
- Adjusted the indentation for logging statements in the release.yml workflow to ensure proper execution and readability.
- This change maintains consistency in the workflow configuration and enhances clarity in the script.
Benefits:
- Improves the clarity of the workflow script, reducing potential errors during CI execution.
- Enhanced the logic for displaying the welcome screen by clarifying conditions for visibility and adding error logging for null references.
- Improved state management and debugging information to provide better insights into the welcome screen's behavior during runtime.
Benefits:
- Increases clarity and maintainability of the welcome screen logic, ensuring a more intuitive user experience.
- Enhances debugging capabilities with detailed logging of state changes and conditions affecting the welcome screen display.
- Adjusted the indentation for the CMAKE_TOOLCHAIN_FILE assignment in release.yml to ensure proper execution of the script.
- This change enhances readability and maintains consistency in the workflow configuration.
Benefits:
- Improves clarity in the workflow script, reducing potential errors during CI execution.
- Updated EditorManager to streamline UI component rendering, ensuring that UI elements like the Command Palette and Global Search are properly displayed.
- Refactored MenuOrchestrator to introduce a new Debug menu, consolidating debugging tools and enhancing accessibility for users.
- Improved PopupManager to include new popups for feature flags and data integrity checks, providing better feedback and control over debugging processes.
Benefits:
- Enhances user experience by organizing UI elements and debugging tools more effectively.
- Improves maintainability by centralizing UI management and debugging functionalities within dedicated components.
- Updated multiple editor components to check visibility flags before rendering cards, ensuring that only visible cards are displayed.
- Refactored card rendering logic in GraphicsEditor, ScreenEditor, MessageEditor, MusicEditor, SpriteEditor, and Emulator to enhance user experience and performance.
- Improved maintainability by centralizing visibility checks and ensuring consistent behavior across different editor types.
Benefits:
- Streamlines the rendering process, leading to a more efficient UI experience.
- Enhances code clarity and maintainability by standardizing visibility handling across editors.
- Updated the download logic in both ci.yml and release.yml to include error handling for Invoke-WebRequest.
- Added a fallback to curl.exe for downloading packages if the initial request fails, improving reliability in package retrieval.
Benefits:
- Increases robustness of the CI and release workflows by ensuring successful downloads even in case of network issues.
- Enhances maintainability by centralizing download logic and error handling in the workflow scripts.
- Updated the sidebar UI in EditorCardRegistry to improve visibility and theming consistency using ThemeManager.
- Refactored SettingsEditor to register multiple settings cards, enhancing modularity and organization of settings.
- Improved the layout and interaction of category tabs, ensuring a more intuitive user experience.
Benefits:
- Streamlines the settings management process, leading to a more organized and efficient user interface.
- Enhances maintainability by clearly defining card registration and visibility logic within the editor framework.
- Updated EditorManager and various editor components to utilize EditorCardRegistry for card registration and visibility management, enhancing dependency injection and modularity.
- Refactored card registration logic across multiple editors, ensuring a consistent approach to managing editor cards.
- Improved UI coordination by delegating visibility checks and card management to the new registry, streamlining the user experience.
Benefits:
- Simplifies card management, leading to a more organized and efficient user experience.
- Enhances maintainability by clearly defining roles for card handling and editor operations, aligning with the overall architecture improvements.
- Updated EditorManager to initialize PopupManager in the constructor, ensuring safe access to popups during menu operations.
- Refactored MenuOrchestrator to utilize PopupID constants for popup management, improving clarity and maintainability.
- Enhanced PopupManager to register popups with structured definitions, allowing for better organization and future expansion.
Benefits:
- Streamlines the initialization process, preventing potential crashes due to uninitialized components.
- Improves the organization of popup management, leading to a more intuitive user experience and easier maintenance.
- Removed the save as menu and new project menu from EditorManager, delegating their functionality to PopupManager for better separation of concerns.
- Introduced a command palette in UICoordinator, enhancing user experience with fuzzy search capabilities for commands.
- Updated UI components to improve clarity and maintainability, ensuring a more efficient workflow for users.
Benefits:
- Enhances the organization of UI elements, leading to a more intuitive user experience.
- Improves code maintainability by consolidating UI management responsibilities within dedicated components.
- Updated EditorManager to include ShortcutManager in the UICoordinator initialization, improving UI responsiveness.
- Refactored menu handling in MenuOrchestrator to delegate more responsibilities to UICoordinator, streamlining the UI flow.
- Removed unused menu items and comments, clarifying the code structure and enhancing maintainability.
Benefits:
- Improves the organization of UI components, leading to a more efficient user experience.
- Enhances clarity in the codebase by reducing clutter and focusing on essential functionalities.
- Removed the installation step for Ninja, simplifying the setup process.
- Added a prefetch step for MSYS runtime to ensure necessary packages are available.
- Updated CMake configuration to use a more structured argument array, improving readability and maintainability.
- Enhanced build output handling to check multiple directories for the built artifacts, ensuring better feedback on the build process.
Benefits:
- Streamlines the CI and release workflows for Windows, leading to a more efficient build process.
- Improves clarity and maintainability of the configuration scripts.
- Refactored session management methods in EditorManager to enhance clarity and maintainability.
- Adjusted context handling for session switching and duplication, ensuring proper session IDs are set.
- Updated the editor dependencies to use IRenderer instead of Renderer, aligning with the new graphics interface.
Benefits:
- Streamlines session management logic, leading to a more organized codebase.
- Improves compatibility with future graphics enhancements by adopting the IRenderer interface.
- Replaced the PowerShell script for installing Ninja with a Chocolatey command, streamlining the installation process.
- This change enhances reliability and reduces complexity in the setup for Windows environments.
Benefits:
- Improves the efficiency of the build setup on Windows by ensuring a straightforward installation method for Ninja.
- Removed the SessionCardRegistry class and its associated methods, streamlining card management within the editor.
- Updated EditorManager to utilize EditorCardRegistry for card operations, enhancing session awareness and visibility control.
- Refactored related components to ensure compatibility with the new card management structure.
Benefits:
- Simplifies card management, leading to a more organized and efficient user experience.
- Improves maintainability by clearly defining roles for card handling and editor operations.
- Introduced new dependencies for SDL2, yaml-cpp, and zlib in the vcpkg.json file, enhancing the project's capability to support additional features on Windows.
- Updated the SDL2 override to specify version 2.30.9, ensuring compatibility with the latest features.
Benefits:
- Expands the project's functionality by integrating essential libraries, improving overall performance and maintainability.
- Modified the Ninja version command in both CI and release workflows to ensure the correct environment path is set before executing the version check.
- This change enhances the reliability of the Ninja installation process on Windows.
Benefits:
- Improves the setup process for Windows environments by ensuring accurate feedback on the Ninja installation, leading to more efficient builds.
- Eliminated the SDL2 dependency from the vcpkg.json file, streamlining the project's dependency management.
- Removed the associated overrides for SDL2, simplifying the configuration.
Benefits:
- Reduces complexity in the dependency setup, leading to a more maintainable project structure.
- Removed redundant window management methods from EditorManager, reducing code bloat and improving maintainability.
- Inline delegation for window management functions has been implemented in the header file, enhancing performance and clarity.
- Updated MenuOrchestrator to include new commands for showing the command palette, memory editor, and resource label manager, improving user interaction.
Benefits:
- Simplifies the EditorManager class, leading to a more organized codebase.
- Enhances user experience by providing quick access to additional functionalities through the menu system.
- Replaced the previous method of installing Ninja with a PowerShell script that downloads and extracts Ninja directly from the official release.
- This change ensures that the installation process is more reliable and provides immediate feedback if the installation fails.
Benefits:
- Enhances the setup process for Windows environments by ensuring Ninja is correctly installed, leading to improved build efficiency.
- Introduced a step to install Ninja for Windows runners in both CI and release workflows, enhancing build efficiency.
- This addition ensures that the necessary build tools are available for Windows environments, streamlining the setup process.
Benefits:
- Improves the build process on Windows by ensuring Ninja is installed, leading to faster and more reliable builds.
- Implemented methods in EditorManager to show the hex editor, AI agent, and chat history, enhancing the editor's capabilities.
- Updated MenuOrchestrator to include new menu items for accessing the hex editor, AI agent, chat history, and other UI elements.
- Improved user interaction by providing quick access to essential features through keyboard shortcuts.
Benefits:
- Streamlines the user experience by integrating additional editor functionalities.
- Enhances the overall architecture by clearly defining roles for UI and editor operations within the MenuOrchestrator.
- Expanded MenuOrchestrator to include additional UI visibility controls and editor action delegations, improving user interaction and functionality.
- Introduced methods for showing global search, performance dashboard, and ImGui metrics, along with editor actions like undo, redo, cut, copy, paste, and find.
- Updated the EditorManager to support new functionalities, including session management and layout presets.
Benefits:
- Streamlines user experience by providing quick access to essential features and enhancing the overall architecture of the editor.
- Improves maintainability by clearly defining roles for UI and editor operations within the MenuOrchestrator.
- Introduced EditorCardRegistry class to centralize card registration and management, enhancing session awareness and visibility control.
- Refactored EditorManager to delegate card-related operations to EditorCardRegistry, improving separation of concerns and maintainability.
- Updated CMake configuration to include new source files for the EditorCardRegistry component.
Benefits:
- Streamlines card management within the editor, leading to a more organized and efficient user experience.
- Enhances the overall architecture by clearly defining roles for card handling and editor operations.
- Added UICoordinator class to centralize UI drawing operations and state management, improving separation of concerns within the editor.
- Refactored EditorManager to delegate UI-related tasks to UICoordinator, enhancing maintainability and clarity.
- Updated CMake configuration to include new source files for the UICoordinator component.
Benefits:
- Streamlines UI management, leading to a more organized and efficient user experience.
- Enhances the overall architecture by clearly defining roles for UI handling and editor operations.
- Refactored the logic for appending Protobuf targets to streamline the configuration.
- Removed unnecessary checks and consolidated target handling for improved clarity and maintainability.
- Introduced YAZE_PROTOBUF_WHOLEARCHIVE_TARGETS to facilitate linking without "lite" variants.
Benefits:
- Enhances the organization of CMake configurations, leading to a more efficient build process.
- Added MenuOrchestrator class to handle menu construction and coordination, improving separation of concerns within the editor.
- Refactored EditorManager to delegate menu-related tasks to MenuOrchestrator, enhancing maintainability and clarity.
- Updated CMake configuration to include new source files for the MenuOrchestrator component.
Benefits:
- Streamlines menu management, leading to a more organized and efficient user experience.
- Enhances the overall architecture by clearly defining roles for menu handling and editor operations.
- Introduced YAZE_PROTOBUF_WHOLEARCHIVE_TARGETS to streamline linking of Protobuf targets, excluding "lite" variants.
- Updated CMake configurations across various components (yaze, yaze_core_lib, yaze_editor, yaze_net, yaze_agent, z3ed) to utilize the new whole-archive targets for MSVC builds.
- Improved test suite linking to ensure all Protobuf symbols are included during the build process.
Benefits:
- Enhances compatibility and maintainability of Protobuf linking, leading to a more robust build configuration.
- Introduced EditorRegistry, ProjectManager, and RomFileManager to streamline editor operations and improve code organization.
- Refactored EditorManager to delegate responsibilities to the new classes, enhancing maintainability and clarity.
- Updated CMake configuration to include new source files for the extracted components.
Benefits:
- Improves separation of concerns within the editor, leading to a more modular and manageable codebase.
- Enhances the overall architecture by clearly defining roles for editor management, project handling, and ROM file operations.
Benefits:
- Streamlines the build process by allowing for multiple Protobuf targets, enhancing compatibility and maintainability.
- Improves session management capabilities within the editor, leading to a more organized and efficient user experience.
- Enhance Protobuf target handling in CMake configuration
- Updated CMake files to support multiple Protobuf targets, improving flexibility in linking.
- Adjusted target link libraries across various components (yaze, yaze_core_lib, yaze_editor, etc.) to utilize the new
- Enhanced CI and release workflows by adding flags to disable RTTI and enforce copy-in swap for Protobuf, ensuring consistent C and C++ compilation settings.
- This update aims to improve build stability and compatibility across different environments.
Benefits:
- Streamlines the Protobuf configuration, leading to a more efficient and reliable CI process.
- Updated CI and release workflows to remove unnecessary Protobuf DLL flags and added gRPC plugin build options for better control over the build process.
- Ensured consistent C and C++ flags across both workflows, enhancing compatibility and reducing potential issues.
Benefits:
- Improves build clarity and stability by refining the configuration for Protobuf and gRPC, leading to a more efficient CI process.
- Updated CI and release workflows to include additional flags for static linking of Protobuf, ensuring consistent C and C++ compilation flags.
- Added Protobuf import prefix and suffix options to improve library handling.
Benefits:
- Improves build stability and compatibility by leveraging static linking for Protobuf, enhancing overall CI performance.
- Moved `app/gfx/resource/arena.cc` to the GFX_CORE_SRC section and added `app/gfx/render/background_buffer.cc` to the GFX_CORE_SRC section.
- Removed `app/gfx/render/background_buffer.cc` from the GFX_RENDER_SRC section to streamline dependencies.
- Updated target link libraries to ensure correct linking of GFX components.
Benefits:
- Improves organization of graphics source files, enhancing maintainability and clarity in the build configuration.
- Modified CI and release workflows to use static linking for Protobuf by adding flags for static libraries and MSVC static runtime.
- Ensured consistent C and C++ flags across both workflows to improve compatibility and reduce potential issues.
Benefits:
- Enhances build stability and performance by leveraging static linking for Protobuf, leading to a more reliable CI process.
- Modified the CI and release workflows to set up ccache directories for Windows, improving build performance.
- Ensured that the ccache environment variables are correctly initialized, enhancing caching efficiency.
Benefits:
- Streamlines the caching process in Windows environments, leading to faster build times and improved CI efficiency.
- Introduced a new step to prepare release metadata, generating a formatted release name using the tag name.
- Updated the artifact naming to utilize the prepared release name for improved clarity in release outputs.
Benefits:
- Enhances the release workflow by ensuring consistent and informative naming for release artifacts, improving traceability.
- Replaced references to core and additional tests with stable and experimental tests in the CI configuration.
- Adjusted the logic for summarizing test outcomes to reflect the new test categories.
- Updated the paths for test result files to ensure accurate reporting.
Benefits:
- Improves clarity and accuracy in CI test reporting, aligning with the new test structure.
- Added separate packaging steps for Windows, macOS, and Linux in the release workflow to improve clarity and maintainability.
- Implemented error handling for missing binaries and assets during the packaging process.
- Updated the macOS DMG creation to use a dynamic tag name for better versioning.
Benefits:
- Streamlines the artifact packaging process across different platforms, ensuring a more robust and user-friendly CI workflow.
- Modified the indentation of commands in the release workflow to improve readability and maintainability.
- Ensured consistent formatting for better alignment with coding standards.
Benefits:
- Enhances the clarity of the CI workflow, making it easier for contributors to understand and modify the build process.
- Added caching for ccache and CMake dependencies in CI and release workflows to improve build performance.
- Updated installation commands to include ccache across Linux, macOS, and Windows environments.
- Enhanced CMake configuration steps to utilize ccache for faster builds and added statistics reporting.
Benefits:
- Reduces build times and improves efficiency in CI processes, facilitating quicker feedback and integration.
- Enhanced the Ollama server startup process with additional logging for better diagnostics.
- Increased the maximum wait time for the server to start from 30 to 60 seconds for CI environments.
- Added checks to ensure the Ollama process remains alive during startup.
- Included a check for the availability of the curl command, which is required for health checks.
Benefits:
- Improves reliability and feedback during the Ollama server integration tests, facilitating easier troubleshooting.
- Added functionality to start and manage the Ollama server within the agent test suite.
- Implemented checks for the availability of the Ollama model and provided user feedback for setup.
- Updated usage instructions to include environment variables for configuring the Ollama model.
Benefits:
- Improves the testing framework by allowing dynamic management of the Ollama server and model, enhancing test coverage and flexibility.
- Updated CI and release workflows to enable building the emulator (YAZE_BUILD_EMU), Z3ED (YAZE_BUILD_Z3ED), and additional tools (YAZE_BUILD_TOOLS).
- Ensured consistent build configurations across different platforms to enhance testing and deployment capabilities.
Benefits:
- Improves the completeness of builds in CI and release processes, facilitating better testing and integration of all components.
