Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update UE SDK onboarding wizard #82995

Merged
merged 5 commits into from
Jan 8, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 11 additions & 22 deletions static/app/gettingStartedDocs/unreal/unreal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,14 @@ const onboarding: OnboardingConfig = {
<Fragment>
<p>
{tct(
"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.",
"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.",
{
link: (
releasesPage: (
<ExternalLink href="https://github.com/getsentry/sentry-unreal/releases" />
),
installMethods: (
<ExternalLink href="https://docs.sentry.io/platforms/unreal/#install" />
),
}
)}
</p>
Expand Down Expand Up @@ -103,7 +106,7 @@ const onboarding: OnboardingConfig = {
{
title: t('Crash Reporter Client'),
description: tct(
'For Windows and Mac, [link:Crash Reporter Client] provided along with Unreal Engine has to be configured in order to capture errors automatically.',
'In Unreal Engine versions prior to UE 5.2 to automatically capture errors on desktop platforms [link:Crash Reporter Client] has to be configured.',
{
link: (
<ExternalLink href="https://docs.sentry.io/platforms/unreal/setup-crashreporter/" />
Expand All @@ -130,29 +133,13 @@ const onboarding: OnboardingConfig = {
</Fragment>
),
},
{
description: (
<Fragment>
<h5>{t('Debug Information')}</h5>
{t(
'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.'
)}
<p>
{tct(
"The option is also located under [strong:Project > Packaging]; select 'show advanced' followed by checking the box for 'Include Debug Files'.",
{strong: <strong />}
)}
</p>
</Fragment>
),
},
{
description: (
<Fragment>
<h5>{t('Configure the Crash Reporter Endpoint')}</h5>
<p>
{tct(
"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:",
"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:",
{
code: <code />,
italic: <i />,
Expand Down Expand Up @@ -188,9 +175,11 @@ const onboarding: OnboardingConfig = {
<Fragment>
<p>
{tct(
'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.',
'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.',
{
italic: <i />,
link: (
<ExternalLink href="https://docs.sentry.io/platforms/unreal/configuration/debug-symbols/" />
),
}
)}
</p>
Expand Down
Loading