Unity provides several options for debugging on Windows for forensic or live debugging of game and Editor processes. Unity allows two types of debugging: native C++ debugging and C# managed debugging.
You can use Unity’s Symbol Store for accessing the Unity server URL in Windows Debugger (WinDbg), or Visual Studio 2019 and later for automatic symbol resolution and downloading.
To add a symbol store on WinDbg, use the .sympath
command:
.sympath+ SRV*c:\symbols-cache*http://symbolserver.unity3d.com/
Where:
.sympath+
The + addition, leaves the existing symbol path alone, and appends this symbol store lookup.
SRV*c:\symbols-cache
The SRV indicates a remote server to fetch from, while thec:\symbols
is a local path to cache the downloaded symbols and to look there first before downloading again.
*http://symbolserver.unity3d.com/
The path to the symbol store to fetch from.
To configure Visual Studio for debugging, follow these steps: 1. Go to Tools > Options. 2. Expand the Debugging section and then select Symbols. 3. Specify a cache directory if not already specified. 4. Add a Symbol file (.pdb) location, such as Unity’s Symbol Store.
Live debugging is the scenario of attaching a debugger to a process that’s already running, or to a process where an exception has been caught. For the debugger to spot the issue, you must include the symbols in the build using the steps described in the Visual Studio setup section. In addtion, if the game executable has the same name as your game name, the debugger might have issues finding the correct .pdb
file, espectially if it doesn’t have access to the renamed executable.
On Windows, Microsoft automatically sets up application crashes to send to Dr Watson/Error Reporting to Microsoft. However, if you have Visual Studio or WinDbg installed, Microsoft provides an option to instead opt to debug the crashes.
Follow this registry file contents to install:
Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\AeDebug]
"Auto"="1"
[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows NT\CurrentVersion\AeDebug]
"Auto"="1"
Additional content for Editor debugging:
Unity.exe -dbgbreak
Will launch Unity and promptly offer a debugger to connect if the automatic crash handling is set up.
Windows provides facilities to investigate crash dump files (.dmp or .mdmp). Depending on the crash dump, you might either see stack information or the entire process memory. The contents of the dump file determine the cause of the crash, which typically has at least a stack to investigate (as long as it’s a valid stack).
To investigate a dump file, you can load it up via Visual Studio or WinDbg. While Visual Studio is easy to use, WinDbg provids additional features, which makes it a preferred debugging tool.
When running Visual Studio, you can use the UnityMixedCallstack extension for VS Code by Unity that makes debugging even easier.
A NullReferenceException
typically looks like this:
1b45558c()
> mono-2.0-bdwgc.dll!malloc(unsigned int size=12) Line 163 + 0x5f bytes C
mono-2.0-bdwgc.dll!g_hash_table_insert_replace(_GHashTable * hash=0x065c3960, void * key=0x0018cba4, void * value=0x0018cb8c, int replace=457528232) Line 204 + 0x7 bytes C
mono-2.0-bdwgc.dll!mono_jit_runtime_invoke(_MonoMethod * method=0x242bf8b0, void * obj=0x065c3960, void ** params=0x0018cba4, MonoObject * * exc=0x0018cb8c) Line 4889 + 0xc bytes C
Managed stack frames typically resemble this:
1b45558c()
> mono-2.0-bdwgc.dll!malloc(unsigned int size=12) Line 163 + 0x5f bytes C
mono-2.0-bdwgc.dll!g_hash_table_insert_replace(_GHashTable * hash=0x065c3960, void * key=0x0018cba4, void * value=0x0018cb8c, int replace=457528232) Line 204 + 0x7 bytes C
mono-2.0-bdwgc.dll!mono_jit_runtime_invoke(_MonoMethod * method=0x242bf8b0, void * obj=0x065c3960, void ** params=0x0018cba4, MonoObject * * exc=0x0018cb8c) Line 4889 + 0xc bytes C
The lines without any information are managed frames. You can get the managed stack information in mono using its built-in function called mono_pmip
, which accepts the address of a stack frame and returns a char* with information. You can invoke mono_pmip
in the Visual Studio Immediate window for debugging.
?(char*){,,mono-2.0-bdwgc.dll}mono_pmip((void*)0x1b45558c)
0x26a296c0 “ Tiles:OnPostRender () + 0x1e4 (1B4553A8 1B4555DC) [065C6BD0 - Unity Child Domain]”`
Note: This only works where mono-2.0-bdwgc.dll
symbols are loaded properly.
Ocassionally, an application doesn’t crash despite having the debugger attached, or it crashes on a remote device where the debugger isn’t available. In such cases, you can get useful information from the dump file using the following steps:
Note: These instructions apply to both Windows Standalone and Universal Windows platforms when running on desktop.
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting
.LocalDumps
folder if it’s not there.“DumpFolder”=<FolderPath goes here> , e.g., C:\Temp
“DumpCount”=dword:00000010
“DumpType”=dword:00000002
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.