ChangeLog

All notable changes to NOA Debugger will be documented in this file.

This package adheres to Semantic Versioning.

Note: When updating NOA Debugger for Unity from the Package Manager, don't forget to delete the existing old version from the project before importing the new one.

You can delete NOA Debugger in NOA Debugger Editor by selecting Window -> NOA Debugger from the Unity menu.

1.6.0

Added

• Controller
  • Added a feature for stepping through the game frame by frame.
  • Added various APIs for stepping through the game frame by frame.
  • Added a button to open the tool.
  • Added an F5 button to execute registered user-defined actions.
• Overlay
  • Added an overlay feature as a new minimized display mode.
    • The overlay does not block raycasts, but it is not interactive.
    • The display method and conditions for hiding follow the floating window.
    • The display content and position can be specified from the NOA Debugger Editor and runtime settings screen.
    • Support for Profiler, ConsoleLog, and APILog features.
• Information
  • Added a feature to display the current fullscreen mode.
• Profiler
  • Added a feature to display memory usage via the Unity API.
  • Added a feature to change the VSyncCount.
  • Added a feature to change the TargetFrameRate.
  • Added a feature to unload unused assets.
• ToolDetail
  • The list of shortcut keys has been displayed in the tool details.
• Other
  • Published documentation and demo on the web.
  • Added a button to allow closing tools from the side menu as well.
    • You can select whether to display it or not from the NOA Debugger Editor.
  • Added a function to set controller transparency in NOA Debugger Editor.
  • Added an API to copy a specified string to the clipboard.
  • Added an API to download a specified string as a file.
  • Added a workaround for screen zoom issues on iOS Safari to the manual.

Changed

• Controller
  • Changed to allow passing the initial toggle state value when registering user-defined actions.
  • Changed the spacing between buttons to block raycasts.
• Profiler
  • Adjusted the overall layout.
  • Adjusted the behavior of the GC execution button.
  • Changed so that the selected rendering item will be kept even if you restart the app.
  • Renamed the following APIs in accordance with the separation of memory measurement types. The previous versions are now deprecated.
    • NoaProfiler.TotalMemoryMB -> NoaProfiler.TotalNativeMemoryMB
    • MemoryInfo.TotalMemoryMB -> MemoryInfo.TotalNativeMemoryMB
    • MemoryInfo.CurrentMemoryMB -> MemoryInfo.CurrentNativeMemoryMB
    • MemoryInfo.MaxMemoryMB -> MemoryInfo.MaxNativeMemoryMB
    • MemoryInfo.MinMemoryMB -> MemoryInfo.MinNativeMemoryMB
    • MemoryInfo.AverageMemoryMB -> MemoryInfo.AverageNativeMemoryMB
    • MemoryUnchangingInfo.TotalMemoryMB -> MemoryUnchangingInfo.TotalNativeMemoryMB
    • MemoryUnchangingInfo.CurrentMemoryMB -> MemoryUnchangingInfo.CurrentNativeMemoryMB
    • MemoryUnchangingInfo.MaxMemoryMB -> MemoryUnchangingInfo.MaxNativeMemoryMB
    • MemoryUnchangingInfo.MinMemoryMB -> MemoryUnchangingInfo.MinNativeMemoryMB
    • MemoryUnchangingInfo.AverageMemoryMB -> MemoryUnchangingInfo.AverageNativeMemoryMB
• ConsoleLog
  • Changed so that the filter state for each log type will be kept even if you restart the app.
  • Changed to allow adding logs from background threads.
  • Changed the text color of the stack trace in the log details.
• APILog
  • Changed so that the filter state for each log type will be kept even if you restart the app.
• DebugCommand
  • Changed so that the scroll position is not reset when showing or hiding command groups.
• UI Element
  • Changed the display order to be the rearmost in NOA Debugger.
• Other
  • Adjusted the overall size of the buttons.
  • Updated the following APIs in conjunction with the addition of the overlay feature:
    • Enabled specifying the overlay hierarchy with NoaDebug.Instantiate().
    • Enabled specifying whether to include the overlay in screenshots with NoaController.OnBeforeScreenshot().
  • Added functionality to the demo scene sample.
  • Changed the default setting of the Optimize UI for portrait flag in the NOA Debugger Editor to enable.
  • Enabled specifying a menu with NoaDebug.Show() to display tools.

Deprecated

• Profiler
  • Deprecated the following APIs related to Battery and Thermal.
    • NoaProfiler.LatestBatteryInfo
    • NoaProfiler.LatestThermalInfo
    • NoaProfiler.IsBatteryProfiling
    • NoaProfiler.IsThermalProfiling
• Snapshot
  • Deprecated the following properties related to Battery and Thermal among the values obtainable with NoaSnapshot.LogList.
    • ProfilerSnapshotData.BatteryInfo
    • ProfilerSnapshotData.ThermalInfo

Removed

• Profiler
  • Omitted the floating window in conjunction with the addition of the overlay feature.
  • Omitted the Battery and Thermal features from the UI.
• ConsoleLog
  • Omitted the floating window in conjunction with the addition of the overlay feature.
  • Omitted the stack trace display for logs in the log list.
• APILog
  • Omitted the floating window in conjunction with the addition of the overlay feature.
• Other
  • Removed documentation from the package. Documentation is now available online.

Fixed

• Profiler
  • Fixed an issue where Rendering values were unstable in the editor.
• ConsoleLog
  • Reduced performance overhead when outputting logs at high frequency.
• Hierarchy
  • Fixed an issue where the object information display area was rendered too narrow horizontally.
• DebugCommand
  • Fixed an issue where the screen could not be scrolled properly from above the left and right buttons of numeric commands.
• UI Element
  • Fixed an issue where the margins when placing UI elements were not reflected correctly.
• Other
  • Fixed an issue where the scroll position was reset when selecting items in the side menu.
  • Fixed an issue where the UI animations of NOA Debugger were affected by Time.timeScale.
  • Fixed an issue where configuration files remained when executing ExcludeFromCompile in Batch mode.
  • Fixed an issue where a compile error would occur when importing NOA Debugger in an environment where the Input System is enabled.

Bugs

• ConsoleLog
  • Scrolling becomes inoperable when logs are output at high speed.
• ApiLog
  • Scrolling becomes inoperable when logs are output at high speed.

1.5.0

Released: 2025-03-10

Added

• Controller
  • Added a controller that can be displayed by long-pressing the start button, allowing the following operations:
    • Execute registered user defined actions
    • Pause/resume game
    • Change game speed
    • Transition to the start-up scene
    • Hide NOA Debugger related UI
    • Capture a screenshot
  • Added various APIs for operating the controller.
• Information
  • Added the feature to automatically update displayed content.
  • Added a feature to register and display custom data.
  • Added a feature to display the active render pipeline.
  • Added a feature to display whether the Scriptable Render Pipeline Batcher is enabled.
• ConsoleLog
  • Added a feature to execute registered send events by selecting any log.
  • Added an event that takes the selected ConsoleLogEntry as an argument when a download is executed.
• APILog
  • Added a feature to execute registered send events by selecting any log.
  • Added an event that takes the selected ApiLogEntry as an argument when a download is executed.
• DebugCommand
  • Added a feature to toggle the visibility of command groups in the floating window on and off at once.
• UI Element
  • Added the feature to configure whether UI elements should be constrained within the safe area.
  • Added the feature to set margins when placing UI elements.
  • Added an API to modify the arrangement direction of specified AnchorType.
• Other
  • Added a feature to execute some of the APIs provided by NOA Debugger using keyboard shortcuts.
  • Added a feature to create objects at the same hierarchy level as the tool's UI.
  • Added the feature to delete imported samples when executing Delete operation in NOA Debugger Editor.
  • Added the mobile browser build of Unity 6 projects to the supported environments.
  • Added the CHANGELOG file into the package.

Changed

• Information
  • Changed the following to be unsupported due to the inability to obtain correct values in a mobile browser environment:
    • System -> Device -> Device Type in the Web build
• ConsoleLog
  • Changed to allow the selection and download of any log.
• APILog
  • Changed to allow the selection and download of any log.
  • Changed the output format of request and response bodies in downloaded data from array to string.
    • Additionally, modified to output as JSON objects when values can be formatted as JSON.
  • Changed to output all logs individually, enabling users to check details of logs that differ only in the request body.
• DebugCommand
  • The auto-update state is now synchronized between the runtime and UnityEditor.
  • Enabled updating the UnityEditor display with DebugCommandRegister.RefreshProperty().
• Other
  • Changed the position of the close button in the floating window to be inside the window.
  • Changed the confirmed Unity version for the operating environment as follows:
    • 6000.0.25f1 -> 6000.0.32f1

Deprecated

• Other
  • NoaDebug.TakeScreenshot() is now deprecated with the addition of the controller functionality.

Removed

• ConsoleLog
  • Omitted the download button in the floating window due to changes in the download specifications.
• APILog
  • Omitted the download button in the floating window due to changes in the download specifications.

Fixed

• Information
  • Fixed a bug that caused tab selection to be reset when the screen was rotated.
• DebugCommand
  • Fixed a bug where value inputs could be reset when auto-update was enabled.
  • Fixed an issue where the auto-update flag was not being saved in the intended location.
    • This fix will reset the previously saved auto-update status.
• Other
  • Fixed an issue where the automatic generation of EventSystem did not work correctly when only the new Input System was enabled.
  • Fixed an issue where configuration files remained when NOA Debugger was excluded from compilation.

1.4.0

Released: 2024-11-29

Added

• APILog
  • Added the feature to register the request body and response body in types other than string.
    • This feature ensures that the conversion to string is performed only when necessary, which is effective if the conversion process is heavy.
• Hierarchy
  • Added a feature to toggle the active/inactive state of an object selected in the Hierarchy Information Display area.
• DebugCommand
  • Added the ability to execute DebugCommands from sources other than the GameView in the UnityEditor.
  • Added the feature to specify the display order of groups to the CommandGroup attribute.
• Other
  • Added a sample to the demo scene to check how to use the extensions provided by NOA Debugger.
  • Added a process to apply the addition or removal of the NOA_DEBUGGER symbol definition to BuildProfiles that override PlayerSettings.

Changed

• Hierarchy
  • Changed to expand/collapse the tree when selecting objects in the hierarchy information display area.
• DebugCommand
  • Changed the registration process for categories to allow setting a display name in addition to the traditional category name.
    • This change enables both omitting the argument in DebugCommandRegister.GetCategoryInstance() and changing the display name.
  • Modified the process to make the origin of exceptions occurring within registered commands traceable from the stack trace.
• Other
  • Changed the confirmed Unity version for the operating environment as follows:
    • 2022.3.8f1 -> 2022.3.51f1
    • 2023.2.7f1 -> 6000.0.25f1

Fixed

• DebugCommand
  • Fixed an issue where commands that return a MethodHandler were not being executed.
  • Fixed an issue where category classes inheriting from DebugCategoryBase defined within a namespace might not be available in the built client application.
• Other
  • Fixed an issue where the creation of NOA Debugger did not complete correctly when both NoaDebug.Destroy() and NoaDebug.Initialize() were executed in the same frame.
  • Fixed a bug where NoaDebug.IsInitialized would return true before NoaDebugger initialization was completed.
  • Fixed a bug where strings were not added to the graph table when using dynamic font.
  • Fixed an issue where characters were cut off when displaying more than 99,999 characters by limiting the number of characters displayed.
  • Fixed a bug where copying to the clipboard was not possible in Unity 6 Web builds.

1.3.0

Released: 2024-08-28

Added

• APILog
  • Added a feature to adjust the display area by dragging the boundary between the log list and log details.

Changed

• APILog
  • Adjusted the grouping of tabs in the log details.
  • Adjusted the process to format the request body and response body in the log details as JSON regardless of the HTTP header's Content-Type.
    • If no specification is provided, the formatting will be executed.
  • Changed the formatting of the request body and response body for copying to the clipboard and downloading to match the log details.

Fixed

• APILog
  • Improved the scroll area of the log details to make it easier to use.
• Other
  • Fixed a bug where some settings would reset to their default values when switching from a branch with an older version of NOA Debugger to a branch with a newer version of NOA Debugger in a version-controlled project.

1.2.0

Released: 2024-07-10

Added

• Information
  • Added an event that executes when download starts.
• Snapshot
  • Added an event that executes when logs are copied to the clipboard.
  • Added an event that executes when logs download starts.
• ConsoleLog
  • Added an event that executes when logs are copied to the clipboard.
  • Added an event that executes when logs download starts.
• APILog
  • Added an event that executes when logs are copied to the clipboard.
  • Added an event that executes when logs download starts.
• DebugCommand
  • Added a feature to collapse commands by groups.
  • Added buttons to increment and decrement values for numeric property types.
    • Expanded the draggable area overall to accommodate design adjustments stemming from the addition of these buttons.
• Other
  • Added a feature to dynamically display various UI elements on the screen.
    • This feature is useful when you want to easily display text, buttons, etc. on the screen.
  • Added an API to change the tool's font at runtime.
  • Added an API to execute screen captures.
  • Added settings to change the initial position, scale, movement type, and whether to save the position of the start button.
  • Added a setting to change whether the settings of the NOA Debugger Editor are saved automatically.

Changed

• ConsoleLog
  • Changed the display of characters not included in the font asset to remove the \ when trying to display them in logs.
• Other
  • Changed the name and behavior of the configuration that positions certain UI elements at the bottom of the screen for portrait orientation.
  • Made it possible to select the notification format of the start button when NOA Debugger detects an error.
  • Made it possible to set the opacity of the start button to 0.
  • Changed the behavior of the NOA Debugger Editor's font settings to display them only when necessary.
  • Adjusted the NOA Debugger Editor link to the Asset Store.

Fixed

• DebugCommand
  • Fixed a bug where the detail view could not be opened when initializing the DebugCommand screen at tool startup either through NoaDebug.Show() or by changing the order of functionalities.
  • Improved performance when displaying the detail view.
  • Fixed a bug where the value was not reflected correctly when inputting double-type properties.
• CustomMenu
  • Fixed a bug where the Prefab used in custom menus was saved as inactive.

1.1.1

Released: 2024-06-07

Fixed

• Other
  • Fixed a bug where an error would occur when executing processes involving asset updates while stopping the application.

1.1.0

Released: 2024-05-28

Added

• Snapshot
  • Added the ability to copy logs to the clipboard.
• ConsoleLog
  • Implemented functionality to output errors without showing notifications when specific errors are detected by the program.
• DebugCommand
  • Enabled the use of the following types for property commands:
    • sbyte, byte, short, ushort, uint, long, ulong, char, double, decimal
  • Made it possible to refresh the screen including the values of property commands via the UI.
  • Added the CommandTag attribute to toggle the executability and visibility of commands.
  • Added the CommandDescription attribute to set command descriptions.
  • Added a detail view feature to check command attribute settings at runtime.
    • Long command names and values that didn't fit on the screen can now be displayed in the detail view.
  • Introduced a format to display commands in a vertical arrangement.
    • This setting is the default for portrait screens.
• CustomMenu
  • Added a method to specify processes to perform when the custom menu is hidden.
• Other
  • Added a parameter to open the custom menu when displaying the tool from the program.
  • Enabled the use of the following types in NoaPrefs:
    • sbyte, byte, short, ushort, uint, long, ulong, char, double, decimal
  • Added a configuration in NOA Debugger Editor to position certain UI elements at the bottom of the screen for portrait orientation.
    • A setting aimed at improving operability on mobile devices.
  • Added a link to the Asset Store within the NOA Debugger Editor.

Changed

• ConsoleLog
  • Modified to display only the count of occurrences when the same log is output consecutively.
• APILog
  • Modified to display only the count of occurrences when the same log is output consecutively.
• DebugCommand
  • Changed the arguments of the CommandInputRange attribute and the CommandIncrement attribute from float type to object type.
    • With this change, you can specify settings in the same type as the type of the target property.
  • Ensured that commands with no specified order or the same value specified are arranged in the order they are defined.
    • As a consequence, changed the display of Get-Only properties.
• Other
  • Improved CPU load, rendering load, and memory usage.
    • Reduced the CPU load at tool initialization by 99%.
      • Distributes CPU load by creating instances of each function after the tool starts.
    • Reduced the rendering load of the GUI while the tool is running.
      • Reduced SetPass calls by up to 84%.
      • Reduced batches by up to 70%.
    • Improved the framerate during tool operation by up to 60%.
    • Reduced memory usage after removing the tool by 88%.
  • Changed the manual and NOA Debugger Editor forum links in NOA Debugger's thread.
  • Added a link to the tool installation instructions in the README.
  • Setting files to be used at runtime cannot be edited directly from the Unity Editor's inspector.

Removed

• APILog
  • Omitted the individual log deletion feature following the implementation of continuous output count display.

Fixed

• Hierarchy
  • Fixed an issue where Unity would crash when retrieving component information for a Canvas without a Camera set.
• DebugCommand
  • Fixed an issue where dragging beyond the min/max type limit of numeric property types would not cause overflow.
• Other
  • Fixed a bug where NOA Debugger would throw an exception when using the new Input System.

1.0.0

Released: 2024-03-21