You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR enhances the UE SDK onboarding wizard with the following
changes:
1. Updated Installation Instructions:
- Clarified which artifact users should download from the [plugin's
GitHub Releases
page](https://github.com/getsentry/sentry-unreal/releases).
- Added a link to [alternate installation
methods](https://docs.sentry.io/platforms/unreal/#install).
2. Improved Crash Reporter guidance by adding an explicit notice that it
should be used for automatic crash capturing with UE versions older than
5.2.
3. Removed the redundant info about including debug files in packaged
game build.
For more details, refer to [issue
#82610](#82610).
"Download the latest plugin sources from the [link:Releases] pageand place it in the project's 'Plugins' directory. On the next project launch, UE will prompt to build Sentry module.",
46
+
"We recommend downloading the latest plugin sources from the [releasesPage: GitHub Releases page], but we also support [installMethods: alternate installation methods]. To integrate Sentry into your Unreal Engine project using the GitHub package, select the artifact that matches your Unreal Engine version and includes `github` in its name. Place the extracted files in your project's 'Plugins' directory. On the next project launch, UE will prompt to build Sentry module.",
'To get the most out of Sentry, crash reports must include debug information. In order for Sentry to be able to process the crash report and translate memory addresses to meaningful information like function names, module names, and line numbers, the crash itself must include debug information. In addition, symbols need to be uploaded to Sentry.'
139
-
)}
140
-
<p>
141
-
{tct(
142
-
"The option is also located under [strong:Project > Packaging]; select 'show advanced' followed by checking the box for 'Include Debug Files'.",
143
-
{strong: <strong/>}
144
-
)}
145
-
</p>
146
-
</Fragment>
147
-
),
148
-
},
149
136
{
150
137
description: (
151
138
<Fragment>
152
139
<h5>{t('Configure the Crash Reporter Endpoint')}</h5>
153
140
<p>
154
141
{tct(
155
-
"Now that the crash reporter and debug files are included, UE needs to know where to send the crash. For that, add the Sentry 'Unreal Engine Endpoint' from the 'Client Keys' settings page to the game's configuration file. This will include which project in Sentry you want to see crashes displayed in. That's accomplished by configuring the [code:CrashReportClient] in the [italic:DefaultEngine.ini] file. Changing the engine is necessary for this to work. Edit the file:",
142
+
"Now that the crash reporter is included, UE needs to know where to send the crash. For that, add the Sentry 'Unreal Engine Endpoint' from the 'Client Keys' settings page to the game's configuration file. This will include which project in Sentry you want to see crashes displayed in. That's accomplished by configuring the [code:CrashReportClient] in the [italic:DefaultEngine.ini] file. Changing the engine is necessary for this to work. Edit the file:",
'To allow Sentry to fully process native crashes and provide you with symbolicated stack traces, you need to upload [italic:debug information files] (sometimes also referred to as [italic:debug symbols] or just [italic:symbols]). We recommend uploading debug information during your build or release process.',
178
+
'To allow Sentry to fully process native crashes and provide you with symbolicated stack traces, you need to upload [link:debug information files] (sometimes also referred to as [italic:debug symbols] or just [italic:symbols]). We recommend uploading debug information during your build or release process.',
0 commit comments