-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## [1.4.4] - 2024-12-07 ### Fixes & Improvements - Default AutoScroll to Auto when there's not logcat settings saved - Fix a bug, where logcat would sometimes connect to wrong device when you have two or more devices connected to host. The fix is only available for Unity 6.1 or higher, since that's the version where the required application launch callback was introduced.
- Loading branch information
Unity Technologies
committed
Dec 7, 2024
1 parent
3f9b2d9
commit 2bc67d9
Showing
39 changed files
with
1,784 additions
and
632 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,24 @@ | ||
* [Android Logcat](index.md) | ||
* [Requirements and compatibility](requirements-and-compatibility.md) | ||
* [Getting started](getting-started.md) | ||
* [Install the Android Logcat package](install-android-logcat.md) | ||
* [Connect to a device](connect-to-a-device.md) | ||
* [Messages](messages.md) | ||
* [Android Logcat window](android-logcat-window.md) | ||
* [Android Logcat window reference](android-logcat-window-reference.md) | ||
* [Customize message log columns](android-logcat-window-message-log-customize.md) | ||
* [Filter the message log](android-logcat-window-message-log-filter.md) | ||
* [Tools](tools.md) | ||
* [Screen Capture tool](screen-capture.md) | ||
* [Device Screen Capture window reference](screen-capture-window-reference.md) | ||
* [Capture a screenshot](screen-capture-screenshot.md) | ||
* [Capture a video](screen-capture-video.md) | ||
* [Stacktace Utility](stacktrace-utility.md) | ||
* [Stacktrace Utility window reference](stacktrace-utility-window-reference.md) | ||
* [Set up Stacktrace Utility](stacktrace-utility-set-up.md) | ||
* [Resolve a stacktrace](stacktrace-utility-resolve.md) | ||
* Window | ||
* [Memory window](memory-window.md) | ||
* [Memory window reference](memory-window-reference.md) | ||
* [Input window](inputs-window.md) | ||
* [Android Logcat Settings](android-logcat-settings.md) | ||
* [Android Logcat](index.md) | ||
* [Requirements and compatibility](requirements-and-compatibility.md) | ||
* [Getting started](getting-started.md) | ||
* [Install the Android Logcat package](install-android-logcat.md) | ||
* [Connect to a device](connect-to-a-device.md) | ||
* [Messages](messages.md) | ||
* [Android Logcat window](android-logcat-window.md) | ||
* [Android Logcat window reference](android-logcat-window-reference.md) | ||
* [Customize message log columns](android-logcat-window-message-log-customize.md) | ||
* [Filter the message log](android-logcat-window-message-log-filter.md) | ||
* [Tools](tools.md) | ||
* [Screen Capture tool](screen-capture.md) | ||
* [Device Screen Capture window reference](screen-capture-window-reference.md) | ||
* [Capture a screenshot](screen-capture-screenshot.md) | ||
* [Capture a video](screen-capture-video.md) | ||
* [Stacktace Utility](stacktrace-utility.md) | ||
* [Stacktrace Utility window reference](stacktrace-utility-window-reference.md) | ||
* [Set up Stacktrace Utility](stacktrace-utility-set-up.md) | ||
* [Resolve a stacktrace](stacktrace-utility-resolve.md) | ||
* Window | ||
* [Memory window](memory-window.md) | ||
* [Memory window reference](memory-window-reference.md) | ||
* [Input window](inputs-window.md) | ||
* [Android Logcat Settings](android-logcat-settings.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,69 +1,69 @@ | ||
# Android Logcat Settings | ||
|
||
Use the Android Logcat Settings window to customize the behavior of the Android Logcat window and tools. | ||
|
||
To open the Android Logcat Settings window in the Unity Editor, go to **Edit** > **Preferences** > **Analysis** > **Android Logcat Settings** (Windows) or **Unity** > **Settings** > **Analysis** > **Android Logcat Settings** (macOS) from the main menu in Unity. The settings are grouped under the following sections: | ||
* [Messages](#messages) | ||
* [Message Colors](#message-colors) | ||
* [Memory Window](#memory-window) | ||
* [Packages](#packages) | ||
* [Stacktrace Regex](#stacktrace-regex) | ||
* [Symbol Extensions](#symbol-extensions) | ||
|
||
Use the **Reset** button at the bottom of the Settings window to restore the default settings. | ||
|
||
## Messages | ||
|
||
Use **Messages** section to customize the appearance and the number of the messages displayed on the Android Logcat window. | ||
|
||
![](images/logcat-settings-messages.png) | ||
|
||
|
||
|**Setting**|**Description**| | ||
|---|---| | ||
|**Max Cached Messages**|Specifies the maximum number of log messages Unity stores in memory that you can view later in the Logcat window. You can adjust the value as per your need such that it doesn't impact the application performance.| | ||
|**Max Displayed Messages**|Specifies the maximum number of log messages to be displayed in the Logcat window. This value cannot be greater than the value specified in the Max Cached Messages. Increase or decrease the value to make navigating messages easier during debugging.| | ||
|**Font**|Specifies the font for the messages displayed in the Logcat window. You can customize the font to improve readability of the messages.| | ||
|**Font Size**|Specifies the font size for the messages displayed in the Logcat window. You can customize the font size to read the messages conveniently on different screen sizes.| | ||
|
||
## Message Colors | ||
|
||
![](images/logcat-settings-message-colors.png) | ||
|
||
|
||
Use **Message Colors** setting to customize the color of the log messages displayed in the Android Logcat window. Customizing the colors can help you differentiate between different types of log messages, making it easier for you to identify any issues. You can assign different colors to log messages based on their priorities, such as **Verbose**, **Debug**, **Info**, **Warn**, **Error**, and **Fatal**. For more information about the priority levels, refer to Android documentation on [Filtering log output](https://developer.android.com/tools/logcat#filteringOutput). | ||
|
||
To customize the log message color, click anywhere on the swatch displayed next to the log message priority level to open the color picker. On the color picker interface, use slider or text box to set your preferred RGB or Hexadecimal color code. Alternatively, you can set the color you prefer using the **Swatches** option at the bottom of the color picker. For more information about Swatches, refer to <a href="https://docs.unity3d.com/Manual/EditingValueProperties.html#swatch-libraries">Creating swatch libraries</a>. | ||
|
||
## Memory Window | ||
|
||
![](images/logcat-settings-memory-window.png) | ||
|
||
Use the **Request Interval ms** setting to specify a time interval to request memory information for the selected application on the connected device. The minimum time interval that you can specify is 500ms. | ||
|
||
## Packages | ||
|
||
![](images/logcat-settings-packages.png) | ||
|
||
|
||
Use the **Max Exited Packages** setting to specify the maximum number for the applications selected in the Package Selector that are now closed. This allows you to restrict the number of entries in the Package Selector dropdown for closed applications to prevent overpopulating the dropdown. | ||
|
||
## Stacktrace Regex | ||
|
||
![](images/logcat-settings-stacktrace-regex.png) | ||
|
||
|
||
Use the **Stacktrace Regex** setting to configure regular expressions used for resolving function address and library names. You can add new regular expressions, remove, or disable the existing ones. | ||
|
||
From the regular expressions list, the one at the top is used for resolving the function address and library name. If it fails, the next one in the order is used as a fallback. You can modify the order as per your preference. | ||
|
||
For more information, refer to [configure stacktrace regular expressions](stacktrace-utility-set-up.md#configure-stacktrace-regular-expressions). | ||
|
||
|
||
## Symbol Extensions | ||
|
||
![](images/logcat-settings-symbol-extensions.png) | ||
|
||
Use the **Symbol Extensions** setting to specify file extensions which are appended to symbol file names during stacktrace resolving. | ||
|
||
# Android Logcat Settings | ||
|
||
Use the Android Logcat Settings window to customize the behavior of the Android Logcat window and tools. | ||
|
||
To open the Android Logcat Settings window in the Unity Editor, go to **Edit** > **Preferences** > **Analysis** > **Android Logcat Settings** (Windows) or **Unity** > **Settings** > **Analysis** > **Android Logcat Settings** (macOS) from the main menu in Unity. The settings are grouped under the following sections: | ||
* [Messages](#messages) | ||
* [Message Colors](#message-colors) | ||
* [Memory Window](#memory-window) | ||
* [Packages](#packages) | ||
* [Stacktrace Regex](#stacktrace-regex) | ||
* [Symbol Extensions](#symbol-extensions) | ||
|
||
Use the **Reset** button at the bottom of the Settings window to restore the default settings. | ||
|
||
## Messages | ||
|
||
Use **Messages** section to customize the appearance and the number of the messages displayed on the Android Logcat window. | ||
|
||
![](images/logcat-settings-messages.png) | ||
|
||
|
||
|**Setting**|**Description**| | ||
|---|---| | ||
|**Max Cached Messages**|Specifies the maximum number of log messages Unity stores in memory that you can view later in the Logcat window. You can adjust the value as per your need such that it doesn't impact the application performance.| | ||
|**Max Displayed Messages**|Specifies the maximum number of log messages to be displayed in the Logcat window. This value cannot be greater than the value specified in the Max Cached Messages. Increase or decrease the value to make navigating messages easier during debugging.| | ||
|**Font**|Specifies the font for the messages displayed in the Logcat window. You can customize the font to improve readability of the messages.| | ||
|**Font Size**|Specifies the font size for the messages displayed in the Logcat window. You can customize the font size to read the messages conveniently on different screen sizes.| | ||
|
||
## Message Colors | ||
|
||
![](images/logcat-settings-message-colors.png) | ||
|
||
|
||
Use **Message Colors** setting to customize the color of the log messages displayed in the Android Logcat window. Customizing the colors can help you differentiate between different types of log messages, making it easier for you to identify any issues. You can assign different colors to log messages based on their priorities, such as **Verbose**, **Debug**, **Info**, **Warn**, **Error**, and **Fatal**. For more information about the priority levels, refer to Android documentation on [Filtering log output](https://developer.android.com/tools/logcat#filteringOutput). | ||
|
||
To customize the log message color, click anywhere on the swatch displayed next to the log message priority level to open the color picker. On the color picker interface, use slider or text box to set your preferred RGB or Hexadecimal color code. Alternatively, you can set the color you prefer using the **Swatches** option at the bottom of the color picker. For more information about Swatches, refer to <a href="https://docs.unity3d.com/Manual/EditingValueProperties.html#swatch-libraries">Creating swatch libraries</a>. | ||
|
||
## Memory Window | ||
|
||
![](images/logcat-settings-memory-window.png) | ||
|
||
Use the **Request Interval ms** setting to specify a time interval to request memory information for the selected application on the connected device. The minimum time interval that you can specify is 500ms. | ||
|
||
## Packages | ||
|
||
![](images/logcat-settings-packages.png) | ||
|
||
|
||
Use the **Max Exited Packages** setting to specify the maximum number for the applications selected in the Package Selector that are now closed. This allows you to restrict the number of entries in the Package Selector dropdown for closed applications to prevent overpopulating the dropdown. | ||
|
||
## Stacktrace Regex | ||
|
||
![](images/logcat-settings-stacktrace-regex.png) | ||
|
||
|
||
Use the **Stacktrace Regex** setting to configure regular expressions used for resolving function address and library names. You can add new regular expressions, remove, or disable the existing ones. | ||
|
||
From the regular expressions list, the one at the top is used for resolving the function address and library name. If it fails, the next one in the order is used as a fallback. You can modify the order as per your preference. | ||
|
||
For more information, refer to [configure stacktrace regular expressions](stacktrace-utility-set-up.md#configure-stacktrace-regular-expressions). | ||
|
||
|
||
## Symbol Extensions | ||
|
||
![](images/logcat-settings-symbol-extensions.png) | ||
|
||
Use the **Symbol Extensions** setting to specify file extensions which are appended to symbol file names during stacktrace resolving. | ||
|
||
For example, if the symbol file name is `libunity` and the specified symbol extensions are `.so.sym`, `.so.dbg`, the Stacktrace Utility tool looks for `libunity.so.sym` and `libunity.so.dbg` symbols. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Android Logcat | ||
|
||
The Android Logcat Package displays messages such as stack traces and [logs](https://docs.unity3d.com/ScriptReference/Debug.Log.html) from an Android device in the Unity Editor. | ||
# Android Logcat | ||
|
||
The Android Logcat Package displays messages such as stack traces and [logs](https://docs.unity3d.com/ScriptReference/Debug.Log.html) from an Android device in the Unity Editor. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,71 @@ | ||
# Inputs window | ||
|
||
|
||
To open the Inputs window in the Unity Editor: | ||
|
||
1. Open the [Android Logcat window](android-logcat-window.md). | ||
2. In the [Toolbar](android-logcat-window-reference.md#toolbar), select **Tools** > **Window** > **Inputs**. | ||
|
||
![](images/inputswindow.png) | ||
|
||
The inputs window is divided into five sections: | ||
* Keyboard keys | ||
* Cursor keys | ||
* Numpad keys | ||
* Miscellaneous keys | ||
* TV keys | ||
* Send text window | ||
|
||
**Note:** The key events which are affected by shift modifier are sent using - adb shell input keyevent <key_code> command. | ||
|
||
**Note:** The key events which are not affected by shift modifier are sent using - adb shell input text <text> command. | ||
|
||
## Keyboard keys | ||
|
||
![](images/InputsWindow_Keyboard.png) | ||
|
||
Includes letter, number, punctuation, symbol, function, and control keys. | ||
|
||
#### Modifiers | ||
|
||
You can select **Shift** modifier to send keys as if while holding shift. | ||
|
||
## Cursor keys | ||
|
||
![](images/InputsWindow_Cursor.png) | ||
|
||
Includes navigation keys. | ||
|
||
## Numpad keys | ||
|
||
![](images/InputsWindow_Numpad.png) | ||
|
||
Includes numerical keys. | ||
|
||
## Miscellaneous keys | ||
|
||
![](images/InputsWindow_Misc.png) | ||
|
||
Includes various helper keys for Android: | ||
* Volume keys | ||
* Brightness keys | ||
* System keys: | ||
* Power | ||
* Wake Up | ||
* Camera | ||
* Call | ||
* End Call | ||
* Cut/Copy/Paste | ||
* Back/Home/Menu | ||
|
||
## TV keys | ||
![](images/InputsWindow_TV.png) | ||
|
||
Incluse basic TV keys. | ||
|
||
|
||
## Send text | ||
|
||
![](images/InputsWindow_SendText.png) | ||
|
||
# Inputs window | ||
|
||
|
||
To open the Inputs window in the Unity Editor: | ||
|
||
1. Open the [Android Logcat window](android-logcat-window.md). | ||
2. In the [Toolbar](android-logcat-window-reference.md#toolbar), select **Tools** > **Window** > **Inputs**. | ||
|
||
![](images/inputswindow.png) | ||
|
||
The inputs window is divided into five sections: | ||
* Keyboard keys | ||
* Cursor keys | ||
* Numpad keys | ||
* Miscellaneous keys | ||
* TV keys | ||
* Send text window | ||
|
||
**Note:** The key events which are affected by shift modifier are sent using - adb shell input keyevent <key_code> command. | ||
|
||
**Note:** The key events which are not affected by shift modifier are sent using - adb shell input text <text> command. | ||
|
||
## Keyboard keys | ||
|
||
![](images/InputsWindow_Keyboard.png) | ||
|
||
Includes letter, number, punctuation, symbol, function, and control keys. | ||
|
||
#### Modifiers | ||
|
||
You can select **Shift** modifier to send keys as if while holding shift. | ||
|
||
## Cursor keys | ||
|
||
![](images/InputsWindow_Cursor.png) | ||
|
||
Includes navigation keys. | ||
|
||
## Numpad keys | ||
|
||
![](images/InputsWindow_Numpad.png) | ||
|
||
Includes numerical keys. | ||
|
||
## Miscellaneous keys | ||
|
||
![](images/InputsWindow_Misc.png) | ||
|
||
Includes various helper keys for Android: | ||
* Volume keys | ||
* Brightness keys | ||
* System keys: | ||
* Power | ||
* Wake Up | ||
* Camera | ||
* Call | ||
* End Call | ||
* Cut/Copy/Paste | ||
* Back/Home/Menu | ||
|
||
## TV keys | ||
![](images/InputsWindow_TV.png) | ||
|
||
Incluse basic TV keys. | ||
|
||
|
||
## Send text | ||
|
||
![](images/InputsWindow_SendText.png) | ||
|
||
Provides functionality for send block of text to Android device. |
Oops, something went wrong.