Skip to content

Commit 193bb50

Browse files
tustanivskyandrewshie-sentry
authored andcommitted
Update UE SDK onboarding wizard (#82995)
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).
1 parent a4d0661 commit 193bb50

File tree

1 file changed

+11
-22
lines changed

1 file changed

+11
-22
lines changed

static/app/gettingStartedDocs/unreal/unreal.tsx

+11-22
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,14 @@ const onboarding: OnboardingConfig = {
4343
<Fragment>
4444
<p>
4545
{tct(
46-
"Download the latest plugin sources from the [link:Releases] page and 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.",
4747
{
48-
link: (
48+
releasesPage: (
4949
<ExternalLink href="https://github.com/getsentry/sentry-unreal/releases" />
5050
),
51+
installMethods: (
52+
<ExternalLink href="https://docs.sentry.io/platforms/unreal/#install" />
53+
),
5154
}
5255
)}
5356
</p>
@@ -103,7 +106,7 @@ const onboarding: OnboardingConfig = {
103106
{
104107
title: t('Crash Reporter Client'),
105108
description: tct(
106-
'For Windows and Mac, [link:Crash Reporter Client] provided along with Unreal Engine has to be configured in order to capture errors automatically.',
109+
'In Unreal Engine versions prior to UE 5.2 to automatically capture errors on desktop platforms [link:Crash Reporter Client] has to be configured.',
107110
{
108111
link: (
109112
<ExternalLink href="https://docs.sentry.io/platforms/unreal/setup-crashreporter/" />
@@ -130,29 +133,13 @@ const onboarding: OnboardingConfig = {
130133
</Fragment>
131134
),
132135
},
133-
{
134-
description: (
135-
<Fragment>
136-
<h5>{t('Debug Information')}</h5>
137-
{t(
138-
'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-
},
149136
{
150137
description: (
151138
<Fragment>
152139
<h5>{t('Configure the Crash Reporter Endpoint')}</h5>
153140
<p>
154141
{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:",
156143
{
157144
code: <code />,
158145
italic: <i />,
@@ -188,9 +175,11 @@ const onboarding: OnboardingConfig = {
188175
<Fragment>
189176
<p>
190177
{tct(
191-
'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.',
192179
{
193-
italic: <i />,
180+
link: (
181+
<ExternalLink href="https://docs.sentry.io/platforms/unreal/configuration/debug-symbols/" />
182+
),
194183
}
195184
)}
196185
</p>

0 commit comments

Comments
 (0)