- Adjusted the order of method calls in BuildModernMenu to improve readability and maintainability.
- Moved the separator method call to follow the item addition for better logical flow.
Benefits:
- Enhances code clarity and organization within the menu building logic of the EditorManager.
- Updated CMake files to conditionally link against libprotobuf based on the YAZE_PROTOBUF_TARGET variable across various modules (core, net, agent, z3ed).
- Ensured consistent use of the static MSVC runtime to align with vcpkg static triplets.
- Improved clarity in build logs by adding status messages for whole-archive linking conditions.
Benefits:
- Enhances modularity and compatibility of the build system with protobuf.
- Streamlines the build process for different platforms by ensuring appropriate linking based on configuration options.
- Modified CMake settings to ensure consistent use of the Homebrew LLVM/Clang installation on macOS.
- Added a new toolchain file to specify the correct compiler and header search paths, resolving potential conflicts.
- Updated CMake presets to enable the EMU build and set appropriate compiler flags.
Benefits:
- Enhances build reliability and compatibility on macOS by utilizing the Homebrew LLVM toolchain.
- Streamlines the build process with improved configuration management.
- Updated CMake configuration to align Windows static builds (MSVC, clang-cl) with vcpkg's /MT runtime.
- Added conditional linking for libprotobuf when YAZE_WITH_GRPC is enabled, enhancing modularity.
- Addressed potential macro conflicts by undefining SendMessage in the conversational agent service files.
Benefits:
- Improves compatibility and reliability of builds on Windows platforms.
- Enhances the flexibility of the build system by conditionally linking libraries based on configuration options.
- Updated CMake configurations across core, net, agent, and z3ed to conditionally apply /WHOLEARCHIVE linking for libprotobuf based on the compiler ID.
- Added status messages to indicate when /WHOLEARCHIVE linking is skipped for clang-cl, improving clarity in build logs.
Benefits:
- Improves compatibility and clarity in the build process for Windows environments using different compilers.
- Ensures that necessary symbols are included when using MSVC, enhancing build reliability.
- Added checks to ensure Windows SDK environment variables are set, providing warnings if they are not.
- Included a step to verify the presence of kernel32.lib, improving diagnostics for Windows builds.
Benefits:
- Increases the robustness of the CI and release workflows by ensuring necessary SDK components are available.
- Enhances build reliability on Windows by proactively identifying potential issues with the SDK setup.
- Introduced a new step to initialize the MSVC developer environment in both CI and release workflows for Windows.
- The step checks for the presence of VsDevCmd.bat and exports essential MSVC environment variables, enhancing build reliability.
- This addition improves the automation of the build process by ensuring the correct environment is set up for Visual Studio.
Benefits:
- Streamlines the setup process for Windows builds, reducing manual configuration.
- Increases the robustness of the CI and release workflows by ensuring necessary environment variables are consistently available.
- Created a comprehensive document detailing the implementation status of the Screen Editor, including sections for Title Screen, Overworld Map, and Dungeon Map editors.
- Document outlines current statuses, functionalities, issues, and next steps for each editor, providing clarity on ongoing development efforts.
- Highlights critical issues with vanilla ROM tilemap loading and outlines priorities for future work.
Benefits:
- Enhances project documentation, aiding developers in understanding the current state and challenges of the Screen Editor.
- Serves as a reference for future development and troubleshooting efforts.
- Implemented a new step to compute the MSVC linker path using vswhere in both CI and release workflows.
- Enhanced the build process by dynamically setting the linker path based on the detected Visual Studio installation.
- Updated CMake configuration to utilize the computed linker path, improving compatibility and reliability on Windows.
Benefits:
- Increases build reliability by ensuring the correct MSVC linker is used, addressing potential issues with fallback options.
- Streamlines the CI and release processes by automating the detection of the appropriate linker path.
- Added a new composite bitmap to render BG1 and BG2 layers with transparency.
- Enhanced the Create method to initialize the composite bitmap and set its metadata.
- Updated the LoadTitleScreen method to include the composite bitmap in texture creation.
- Introduced RenderCompositeLayer method to manage the layering of background graphics.
Benefits:
- Improves visual fidelity of the title screen by allowing both background layers to be rendered together.
- Enhances the flexibility of rendering options for the title screen, supporting dynamic visibility of layers.
- Added checks to set the vcpkgRoot variable from environment variables RUNVCPKG_VCPKG_ROOT and VCPKG_ROOT if it is not already defined.
- Enhances the reliability of vcpkg setup by ensuring the correct root path is utilized during the build process.
Benefits:
- Increases robustness in CI and release workflows by providing fallback options for vcpkg root detection, improving build consistency.
- Added a retry mechanism for vcpkg setup in both CI and release workflows to improve reliability on Windows.
- Implemented caching of the vcpkg toolchain path, ensuring that the correct toolchain file is used during the build process.
- Updated the CMake configuration to utilize the cached toolchain file, enhancing build consistency.
Benefits:
- Increases the robustness of the CI and release processes by handling vcpkg setup failures more gracefully.
- Ensures that the correct toolchain is always available, improving build reliability on Windows environments.
- Enhanced the discover_cmake_libraries function to identify decomposed libraries and handle special cases for source variables.
- Updated gui_library.cmake to utilize auto-maintenance markers, streamlining the management of source lists for GUI components.
- Commented out hardcoded CMake source blocks, allowing for dynamic discovery of source files.
Benefits:
- Simplifies the maintenance of GUI library sources by automating updates and reducing manual configuration.
- Improves clarity and efficiency in the build process for GUI components.
- Updated the discover_cmake_libraries function to support new marker comments for auto-maintenance.
- Improved variable extraction logic to handle decomposed libraries and subdirectory detection.
- Removed hardcoded CMake source blocks in favor of auto-discovery, streamlining the management of graphics library sources.
Benefits:
- Simplifies the maintenance of CMake files by automating source list updates.
- Enhances build efficiency and clarity by reducing manual configuration requirements.
- Added `-DCMAKE_LINKER=link.exe` to both CI and release workflows to ensure compatibility with MSVC, addressing issues with lld-link on protobuf resource files.
Benefits:
- Enhances build reliability on Windows by using the appropriate linker for MSVC, improving the overall CI and release process.
- Added checkboxes for toggling visibility of title screen background layers (BG1 and BG2).
- Implemented a new method for rendering the composite view of the title screen.
- Introduced functionality for loading and saving custom maps from external binary files, enhancing user flexibility in map management.
Benefits:
- Improves user experience by allowing dynamic control over layer visibility during title screen editing.
- Expands the capabilities of the ScreenEditor with custom map handling, facilitating easier map modifications and sharing.
- Changed the bitmap depth for message previews from 64 to 8 to support indexed palette mode.
- Updated logging to reflect the new depth in message preview creation.
- Enhanced Bitmap class with a new method to update surface pixels, ensuring proper pixel data handling in rendering.
Benefits:
- Improves compatibility with indexed palette formats in message rendering.
- Enhances the clarity of logging for bitmap creation processes.
- Added methods for applying palettes based on metadata, allowing for flexible palette handling in different bitmap types.
- Introduced a new BitmapMetadata struct to track source format and palette requirements.
- Enhanced ApplyStoredPalette and SetPaletteWithTransparent methods for improved palette application and transparency handling.
- Updated SDL surface pixel management with a new UpdateSurfacePixels method for better pixel data handling.
Benefits:
- Improves the rendering capabilities of the Bitmap class by supporting various palette formats.
- Enhances user experience with more intuitive palette management in graphics operations.
- Added functionality for managing the overworld map, including loading, rendering, and saving map data for both Light and Dark Worlds.
- Introduced new canvas components for overworld map editing, allowing users to select and paint tiles directly onto the map.
- Enhanced the ScreenEditor with controls for tile flipping and palette selection, improving the user interface for overworld map management.
Benefits:
- Expands the capabilities of the ScreenEditor, providing users with tools to edit and manage the overworld map effectively.
- Improves user experience by enabling intuitive tile editing and visual feedback during map modifications.
- Added yaze_core_lib to the target_link_libraries for the yaze_emulator in emu_library.cmake, ensuring proper linkage of core functionalities.
- Updated Arena constructor to initialize background layers directly, improving clarity and performance.
Benefits:
- Enhances the emulator's build configuration by ensuring all necessary libraries are linked.
- Improves the initialization process in the Arena class for better resource management.
- Implemented a new tilemap system for 8x8 tiles in the ScreenEditor, allowing for on-demand texture creation and caching of tiles.
- Combined multiple sheets into a single tilemap, improving memory efficiency and rendering performance.
- Updated tile drawing logic to extract and cache tiles from the atlas, ensuring textures are created only when needed.
Benefits:
- Enhances performance by reducing unnecessary texture creation.
- Improves user experience with faster tile rendering and management in the editor.
- Refactored multiple editor classes to ensure that ImGui::End() is always called after ImGui::Begin(), enhancing state management and preventing potential rendering issues.
- Updated the DungeonEditor, GraphicsEditor, ScreenEditor, MessageEditor, MusicEditor, and SpriteEditor to follow this pattern, improving code consistency and reliability.
Benefits:
- Improves the stability of the editor UI by ensuring proper handling of ImGui state.
- Enhances code readability and maintainability by standardizing the usage of ImGui functions across different editor components.
- Implemented title screen editing capabilities, including loading and rendering of title screen layers.
- Added inventory item icon management, allowing for the display and selection of item icons within the inventory menu.
- Updated the inventory creation process to ensure proper ROM loading and error handling.
- Introduced new canvas components for title screen and inventory item icons, improving the user interface for editing.
Benefits:
- Enhances the functionality of the screen editor, providing users with tools to edit title screens and manage inventory icons effectively.
- Improves user experience by ensuring robust error handling and visual feedback during inventory management.
- Added functionality to enable SDL audio streaming in the Emulator class, allowing for improved audio handling.
- Introduced environment variable checks to configure audio streaming on initialization.
- Updated audio backend to support native audio frame queuing and resampling, enhancing audio performance and flexibility.
Benefits:
- Enhances audio playback quality and responsiveness in the emulator.
- Provides users with the option to utilize SDL audio streaming for better audio management.
- Modified CMake configurations across multiple files to use `$<TARGET_FILE:libprotobuf>` for whole-archive linking on Windows, ensuring all symbols are included correctly.
- This change enhances compatibility and reliability of the build process when using gRPC.
Benefits:
- Improves build stability on Windows platforms by ensuring proper linking of the protobuf library.
- Updated CMake configuration in both CI and release workflows to include the preprocessor definition `/D__PRFCHWINTRIN_H` alongside the existing definition for `google_protobuf_undef_DWORD`.
- This change ensures compatibility with Windows-specific intrinsics during the build process.
Benefits:
- Improves build reliability on Windows platforms by addressing potential issues with intrinsic functions.
- Introduced detailed refactoring plans for the in-app test dashboard and the zelda3 library, addressing architectural issues and improving modularity.
- The test dashboard plan outlines a decoupled architecture, enhancing maintainability and build efficiency.
- The zelda3 library plan proposes a migration to a core shared library structure, improving incremental build times and clarifying domain boundaries.
Benefits:
- Enhances the overall structure and maintainability of the codebase.
- Facilitates future development and testing efforts by establishing clear architectural guidelines.
- Deleted the `agent.sh` script, which provided background agent functionality for YAZE, as it is no longer needed.
- Removed the `create_release.sh` script used for creating release tags, streamlining the release process.
- Eliminated the `test_apu_boot.sh` script for APU/SPC700 boot sequence testing, as it is outdated.
Benefits:
- Cleans up the scripts directory by removing unused and deprecated scripts, improving project maintainability.
- Added support for .gitignore patterns to the build_cleaner script, allowing it to respect ignored files during maintenance tasks.
- Implemented auto-discovery of CMake libraries marked for auto-maintenance, improving the automation of source list updates.
- Introduced functions for extracting includes and symbols from source files to suggest missing headers based on usage.
- Updated README to reflect new features and usage instructions.
Benefits:
- Streamlines the build process by automating maintenance tasks and ensuring proper header management.
- Enhances code organization and maintainability by integrating with existing project structures.
- Changed include paths for SNES color and palette headers to reflect new organization under the 'types' and 'util' directories.
- Ensured consistency in include paths across the graphics subsystem.
Benefits:
- Improves code organization and maintainability by adhering to the updated project structure.
- Modified CI configuration to use the D-Bus portal for file dialogs on Linux for improved reliability.
- Updated CMake commands in both CI and release workflows to include the NFD_PORTAL option.
- Removed OpenSSL from vcpkg.json to streamline dependencies.
Benefits:
- Enhances build reliability across different platforms.
- Simplifies dependency management in the project.
- Updated include paths for various GUI-related headers to improve organization and clarity.
- Introduced new components for better modularity, including PaletteEditorWidget and EditorCardManager.
- Refactored existing code to utilize the new components, ensuring consistency across the GUI subsystem.
Benefits:
- Enhances maintainability and readability of the GUI code.
- Facilitates future enhancements and optimizations within the GUI subsystem.
- Updated include paths for various graphics-related headers to improve organization and clarity.
- Introduced new types for SNES color, palette, and tile management, enhancing the structure of the graphics subsystem.
- Refactored existing code to utilize the new types, ensuring consistency across the codebase.
Benefits:
- Improves maintainability and readability of the graphics code.
- Facilitates future enhancements and optimizations within the graphics subsystem.
- Introduced PaletteManager to handle all palette-related operations, including color modifications, undo/redo functionality, and batch processing.
- Updated PaletteEditor and PaletteGroupCard to utilize PaletteManager for managing palette states and modifications, streamlining the editing process.
- Enhanced user interface with confirmation popups for discard actions and error notifications for save failures.
Benefits:
- Centralizes palette management, improving consistency and reducing code duplication across editors.
- Enhances user experience by providing clear feedback on unsaved changes and simplifying color operations.
- Implemented initialization for music-related editor cards, including Music Tracker and Instrument Editor, with appropriate registration and default visibility settings.
- Updated MusicEditor to manage card visibility dynamically and added methods for drawing specific editor views.
- Improved EditorCardManager to handle recent category tracking, enhancing user navigation through editor categories.
Benefits:
- Streamlines access to music editing tools, improving user experience and workflow efficiency within the editor environment.
- Updated EditorManager to pass visibility flags directly to memory and assembly editors, enhancing the responsiveness of the editor interface.
- Simplified visibility checks by retrieving flags from the EditorCardManager, ensuring accurate updates based on user interactions.
Benefits:
- Streamlines the editor update process, improving user experience by ensuring editors reflect their visibility state accurately.
- Updated EditorManager to support new card-based editors, including Emulator, Hex, and Assembly editors.
- Added centralized registration of editor cards with EditorCardManager, improving visibility management.
- Implemented methods to retrieve editor types from categories and manage card visibility dynamically.
- Enhanced initialization processes for various editors to ensure proper card registration and default visibility settings.
Benefits:
- Improved user experience by organizing editor cards and providing quick access to new editor functionalities.
- Streamlined editor management, making it easier to switch between different editing contexts and enhancing overall workflow efficiency.
- Simplified CMake build commands in CI and release workflows by removing the redundant `--config ${{ env.BUILD_TYPE }}` flag.
- Updated test commands to eliminate the build configuration flag, streamlining the testing process.
Benefits:
- Enhances clarity and reduces potential confusion in build and test commands, improving overall workflow efficiency.
- Implemented steps to install NASM on Windows runners, required for BoringSSL in gRPC.
- Updated PATH for NASM to ensure it is accessible during the build process.
- Enhanced dependency retry logic to include NASM installation.
Benefits:
- Ensures proper setup for Windows builds, improving compatibility with gRPC requirements.
- Updated EditorManager to handle sidebar drawing for card-based editors, improving consistency across editor types.
- Removed individual toolbar implementations from GraphicsEditor, ScreenEditor, and SpriteEditor, as sidebar functionality is now centralized.
- Enhanced EditorCardManager to manage card visibility and selection more effectively, including improved UI feedback for empty card categories.
Benefits:
- Streamlined editor interface and improved user experience by consolidating sidebar management, making it easier to navigate and manage editor cards.
- Introduced several new commands to the emulator, including:
- `emulator-set-breakpoint`: Set breakpoints for debugging.
- `emulator-clear-breakpoint`: Remove breakpoints by ID.
- `emulator-list-breakpoints`: List all active breakpoints.
- `emulator-step`: Step through CPU instructions.
- `emulator-run`: Run the emulator until a breakpoint or for a specified number of frames.
- `emulator-pause`: Pause execution for inspection.
- `emulator-reset`: Reset the emulator to its initial state.
- `emulator-get-registers`: Retrieve current CPU register values.
- `emulator-get-metrics`: Get performance metrics of the emulator.
Benefits:
- Enhances debugging capabilities and provides more control over emulator execution, improving the development experience.
- Introduced methods to determine if an editor is card-based and to retrieve its category.
- Implemented a sidebar toggle shortcut (Ctrl+B) for managing card visibility.
- Added functionality to hide current editor cards when switching editors.
- Updated editor initialization to register global shortcuts for activating specific editors.
- Enhanced the Update method to draw a sidebar for the current category editor.
Benefits:
- Improved user experience by organizing editor cards and providing quick access to editor categories.
- Streamlined editor management, making it easier to switch between different editing contexts.
- Changed the compiler configuration for Windows jobs in CI and release workflows from MSVC to Clang.
- Updated CMake commands to utilize the Ninja generator and set the C and C++ compilers dynamically based on the matrix configuration.
- Simplified artifact paths in the packaging steps to reflect the new build structure.
Benefits:
- Improved compatibility and performance by leveraging Clang for Windows builds, enhancing cross-platform consistency.
- Introduced a new document detailing the architecture of the z3ed AI agent system, covering features like learned knowledge, TODO management, and advanced routing.
- Added a debugging guide for the AI agent, outlining the gRPC-based debugging service, available tools, and practical debugging workflows.
- Updated existing documentation to reflect recent improvements in the emulator's audio system and overall debugging capabilities.
Benefits:
- Provides clear guidance for developers on the AI agent's architecture and debugging processes, enhancing usability and understanding of the system.
- Facilitates faster onboarding and better collaboration by offering structured documentation and real-world examples.
