Add imgui and item editor

[Mosch0512]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @Mosch0512, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant new feature: an in-game editor built with ImGui. The primary focus is on a robust Item Editor that allows real-time modification and export of game item attributes. Alongside this, a new internationalization system has been integrated to support multi-language content for both the game and the editor. The entire editor framework is designed with conditional compilation, ensuring that it is completely excluded from release builds to maintain performance and binary size. This change greatly enhances development and content creation workflows by providing powerful in-game tooling and a flexible translation system.

Highlights

• In-Game Editor Integration: Integrated ImGui to provide a powerful in-game editor, accessible via F12 or the --editor command-line flag. This editor is conditionally compiled, ensuring zero overhead in release builds.
• Comprehensive Item Editor: Introduced a new Item Editor within the ImGui framework, allowing for live editing of item attributes. It features search, filtering, configurable column visibility, and export capabilities to CSV and legacy S6E3 formats.
• Internationalization (i18n) System: Implemented a new translation system supporting multiple languages (English, Spanish, Portuguese) across different domains: Game, Editor, and Metadata. Translations are loaded from JSON files, with editor-specific translations also being conditionally compiled.
• Enhanced Console Logging: Redirected all wprintf, fwprintf, and g_ErrorReport output to a dual-panel ImGui console within the editor. This eliminates the need for a separate Windows console window and includes logging to a timestamped file.
• Robust Input Management: Developed an input blocking mechanism that prevents game mouse and keyboard input from interfering with the ImGui editor UI when it is active or being hovered over.
• Metadata-Driven Item Data Handling: Refactored item data structures and handling to use X-macros and metadata, providing a single source of truth for item field definitions. This simplifies UI generation, data loading/saving, and change tracking.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This is an impressive and extensive pull request that adds an in-game editor using ImGui, refactors item data handling into a more robust system, and introduces a well-designed translation framework. The use of data-driven design with X-Macros for item attributes is excellent for maintainability. The integration with the existing codebase, especially for input blocking and console redirection, is handled thoughtfully. My feedback focuses on further improving code quality and robustness by suggesting the use of RAII for memory management, refactoring duplicated code, making error handling less disruptive for a debug tool, and correcting a few minor issues in file paths and documentation.

[Mosch0512]

/gemini review

[gemini-code-assist]

Code Review

This is an impressive pull request that adds a significant new feature: an in-game editor using ImGui. The implementation is very thorough, covering everything from the core editor logic, a metadata-driven item editor, console redirection, and robust input blocking to integrate smoothly with the game. The refactoring of item data handling using X-Macros and the introduction of a new translation system are also major improvements to the codebase's maintainability and extensibility. My feedback is focused on a few areas to improve memory safety by using modern C++ smart pointers and to increase the robustness of the new JSON parser. Overall, this is a high-quality and very well-executed feature addition.

[Mosch0512]

/gemini review

[gemini-code-assist]

Code Review

This is an impressive pull request that adds a powerful in-game editor using ImGui and significantly refactors the item data handling system. The new architecture is well-structured, with clear separation of concerns for data handling, UI, and core logic. The use of X-Macros for item attributes is an excellent choice for maintainability. The console redirection and translation systems are also great additions.

My review focuses on improving robustness and safety, particularly around memory management and string handling in the new C++ code. I've identified a few critical areas that could lead to buffer overflows or memory leaks, and some medium-severity suggestions to improve code quality and maintainability. Overall, this is a fantastic contribution.

I am having trouble creating individual review comments. Click here to see my feedback.

Source Main 5.2/source/DataHandler/ItemData/ItemDataLoader.cpp (20-22)

This swprintf call is unsafe and can lead to a buffer overflow if the fileName is too long. It's recommended to use a safe alternative like swprintf_s or, even better, C++ string streams (std::wstringstream) to construct the error message. This vulnerability also exists on lines 63 and 72.

        std::wstringstream ss;
        ss << fileName << L" - File not exist.";
        ItemDataFileIO::ShowErrorAndExit(ss.str().c_str());

Source Main 5.2/source/DataHandler/ItemData/ItemDataSaver.cpp (59)

This function uses a raw new[] allocation for originalItems (and for Buffer on line 109), with manual delete[] calls at multiple exit points. While the current logic appears to handle cleanup correctly, this approach is error-prone and can easily lead to memory leaks if new return paths are added in the future. Using smart pointers like std::unique_ptr would make the code safer and cleaner by leveraging RAII for automatic memory management.

Source Main 5.2/source/DataHandler/ItemData/ItemDataSaverLegacy.cpp (26)

This function uses a raw new[] allocation with a manual delete[]. This pattern is risky and can lead to memory leaks, especially if the function's logic becomes more complex. It's highly recommended to use std::unique_ptr to ensure the buffer is automatically deallocated, making the code safer and more modern C++.

Source Main 5.2/source/MuEditor/Config/MuEditorConfig.cpp (24)

Saving the configuration in the destructor can be problematic. It can lead to I/O at unexpected times (e.g., during program shutdown) and can cause issues if Save() were to throw an exception (which is disallowed from destructors). It's safer to have an explicit Save() call triggered by a specific user action or during a controlled shutdown sequence. The CMuEditorCore::Shutdown function already handles saving preferences, making this destructor call redundant.

Source Main 5.2/source/MuEditor/Core/MuEditorCore.cpp (90-99)

The logic for loading translation files from multiple possible paths is duplicated for editor.json and metadata.json. This could be extracted into a helper function to reduce code duplication and improve maintainability.

Source Main 5.2/source/Translation/i18n.cpp (13-75)

This custom JSON parser is very simple and may be brittle. It doesn't account for whitespace between tokens (e.g., "key" : "value") and only handles a limited set of escape sequences. While it works for the current translation files, it could easily break with slightly different formatting. For improved robustness, consider either enhancing the parser to handle whitespace and more escape sequences, or using a lightweight, header-only JSON library.

Source Main 5.2/source/ZzzInfomation.cpp (378-457)

The removal of the old OpenItemScript function and its replacement with the new ItemDataHandler is an excellent refactoring. It greatly improves modularity, readability, and maintainability by centralizing the data loading logic. Great work on this cleanup!