Skip to content

Commit 8aa30ce

Browse files
tustanivskyantonpirker
tustanivsky
authored and
antonpirker
committed
Move Unreal Engine SDK installation options to a separate page (#14056)
This PR moves the detailed description of all Sentry Unreal Engine SDK installation options to a dedicated `Installation Methods` page. This simplifies the landing page and lets us clearly highlight the recommended installation method which is downloading the SDK from the GitHub Releases page.
1 parent 868243d commit 8aa30ce

File tree

2 files changed

+93
-66
lines changed

2 files changed

+93
-66
lines changed

‎docs/platforms/unreal/index.mdx

Lines changed: 6 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unrea
1515
**Features:**
1616

1717
- Native support for automatic crash error tracking for
18-
- Android by using the [Android SDK](/platforms/android/) to support Java, Kotlin, C and C++
19-
- iOS by using the [iOS SDK](/platforms/apple/guides/ios/) to support Objective-C, Swift, C and C++
20-
- Windows (UE 5.2+) and Linux by using the [Native SDK](/platforms/native/) to support C and C++ with minidumps
21-
- macOS by using the [macOS SDK](/platforms/apple/guides/macos/) to support Objective-C, Swift, C and C++
18+
- Windows (UE 5.2+) and Linux by using the [Native SDK](/platforms/native/) to support C and C++ with minidumps
19+
- macOS by using the [macOS SDK](/platforms/apple/guides/macos/) to support Objective-C, Swift, C and C++
20+
- iOS by using the [iOS SDK](/platforms/apple/guides/ios/) to support Objective-C, Swift, C and C++
21+
- Android by using the [Android SDK](/platforms/android/) to support Java, Kotlin, C and C++
2222
- Compatible with [Crash Reporter Client](/platforms/unreal/configuration/setup-crashreporter/) provided along with Unreal Engine
2323
- [PlayStation](/platforms/playstation/), [Xbox](/platforms/xbox/) and [Nintendo Switch](/platforms/nintendo-switch/) support
2424
- [Release health](/platforms/unreal/configuration/releases/) to keep track of crash free users and sessions
@@ -39,76 +39,16 @@ Sentry captures data by using an SDK within your application’s runtime.
3939

4040
The Unreal Engine (UE) SDK is officially supported for the three latest UE versions. However, it is likely to be compatible with older engine versions as well depending on the specific features and functionality that you need.
4141

42-
There are three common ways to install an SDK to use with Unreal Engine:
43-
1. Install from the [Epic Games Fab](https://www.fab.com/) ([formerly known as the marketplace](https://www.unrealengine.com/en-US/blog/fab-epics-new-unified-content-marketplace-launches-today))
44-
2. Download a pre-built SDK that you install (for example, from a [GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases))
45-
3. Clone and build the SDK yourself and install
42+
We recommend downloading the latest plugin sources from the [GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases), but we also support [alternate installation methods](/platforms/unreal/install/).
4643

47-
While you can use any of the three methods to install Sentry, each has its own limitations, as described below.
48-
49-
### Overview of SDK Versions
50-
51-
The table below highlights some key differences between different versions of the SDK:
52-
53-
| Feature | __GitHub Releases__* | Fab | Build Yourself |
54-
|----------------------------|----------------------|---------------------|----------------|
55-
| Supported engine versions | 4.27 and newer | 5.1 and newer | 4.27 and newer |
56-
| Supported UE project types | C++ only | Blueprint and C++ | C++ only |
57-
| Backend (Windows) | Crashpad | Breakpad | Crashpad |
58-
| `on_crash` hook (Windows) | Supported | Not supported | Supported |
59-
| Sentry CLI ** | Included | Manual download | Included |
60-
| Fast-fail crash capturing | Supported | Not supported | Supported |
61-
62-
Legend:
63-
`*`: Recommended version of the SDK
64-
`**`: Sentry CLI is a standalone tool that the plugin uses under the hood to automatically upload debug information files upon game build completion.
65-
66-
### Installing from GitHub Releases (Recommended)
67-
68-
The [GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases) provides two plugin packages: `github` and `marketplace`. The key difference between the two is the crash capturing backend, which is used under the hood on Windows.
69-
70-
We recommend using the `github` version, because it uses `Crashpad`, an out-of-proc handler that sends the crash report right away. The `marketplace` version relies on `Breakpad`, an in-proc handler which requires the UE application or game to be relaunched before any crash reports can be sent to Sentry.
71-
72-
To install the SDK, download the most up-to-date sources from the [Releases page](https://github.com/getsentry/sentry-unreal/releases) and add them to your project's `Plugins` directory. On the next project launch, UE will prompt you to build the Sentry and SentryEditor modules.
44+
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 you to build the Sentry and SentryEditor modules.
7345

7446
<Alert>
7547

7648
Currently, this method is available only for C++ UE projects. Blueprint projects can be converted to a C++ one by adding an empty class using the editor.
7749

7850
</Alert>
7951

80-
<Alert>
81-
82-
To avoid warnings during the build for licensee versions of Unreal Engine, the `EngineVersion` key is not set in the `Sentry.uplugin` for the `github` package.
83-
84-
</Alert>
85-
86-
### Installing from Fab
87-
88-
Sentry SDK can be downloaded via the [standard installation process](https://dev.epicgames.com/documentation/en-us/unreal-engine/working-with-plugins-in-unreal-engine#installingpluginsfromtheunrealenginemarketplace) from its [Epic Games Fab page](https://www.fab.com/listings/eaa89d9d-8d39-450c-b75f-acee010890a2).
89-
90-
This method is recommended only for Blueprint UE projects. If you already have a C++ UE project or don't mind converting an existing Blueprint UE project to a C++ one, consider downloading the plugin from GitHub instead.
91-
92-
### Build Yourself
93-
94-
To get started, we recommend cloning the [Unreal SDK repository](https://github.com/getsentry/sentry-unreal) and running the initialization script:
95-
96-
* `./scripts/init.sh` on macOS/Linux
97-
* `./scripts/init-win.ps1` on Windows
98-
99-
<Alert>
100-
Initialization scripts require [GitHub CLI](https://cli.github.com/) to be installed.
101-
</Alert>
102-
103-
<Alert>
104-
If the initialization script fails due to errors on Windows, check your PowerShell version by printing the built-in variable `$PSVersionTable`. If the version is `5.x`, upgrading to a newer version of [PowerShell](https://github.com/powershell/powershell) may resolve these errors.
105-
</Alert>
106-
107-
This script links the checked out version of the plugin (the [plugin-dev](https://github.com/getsentry/sentry-unreal/tree/b67076ad5dc419d46b4be70a0bd6e64c2357a82d/plugin-dev) directory) to the [sample app](https://github.com/getsentry/sentry-unreal/tree/b67076ad5dc419d46b4be70a0bd6e64c2357a82d/sample) and downloads the latest builds of native SDKs from our GitHub CI.
108-
109-
After successful initialization, copy the contents of the `plugin-dev` directory to `<your_project_root>/Plugins/Sentry`. This will allow you to use Sentry in your Unreal Engine project.
110-
111-
### Confirm Installation
11252
To make sure the Sentry plugin has been enabled after installation has been completed, go to the editor and navigate to the **Settings > Plugins > Code Plugins** menu and check for the installation.
11353

11454
![Sentry window](./img/unreal_plugins_window.png)

‎docs/platforms/unreal/install/index.mdx

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: Installation Methods
3+
description: "All the installation methods for the Unreal Engine SDK."
4+
sidebar_order: 2
5+
---
6+
7+
There are three common ways to install an SDK to use with Unreal Engine:
8+
1. Download a pre-built SDK from a [GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases) and install
9+
2. Install from the [Epic Games Fab](https://www.fab.com/) ([formerly known as the marketplace](https://www.unrealengine.com/en-US/blog/fab-epics-new-unified-content-marketplace-launches-today))
10+
3. Clone and build the SDK yourself and install
11+
12+
While you can use any of the three methods to install Sentry, each has its own limitations, as described below.
13+
14+
## Overview of SDK Versions
15+
16+
The table below highlights some key differences between different versions of the SDK:
17+
18+
| Feature | __GitHub Releases__* | Fab | Build Yourself |
19+
|----------------------------|----------------------|---------------------|----------------|
20+
| Supported engine versions | 4.27 and newer | 5.1 and newer | 4.27 and newer |
21+
| Supported UE project types | C++ only | Blueprint and C++ | C++ only |
22+
| Backend (Windows) | Crashpad | Breakpad | Crashpad |
23+
| `on_crash` hook (Windows) | Supported | Not supported | Supported |
24+
| Sentry CLI ** | Included | Manual download | Included |
25+
| Fast-fail crash capturing | Supported | Not supported | Supported |
26+
27+
Legend:
28+
`*`: Recommended version of the SDK
29+
`**`: Sentry CLI is a standalone tool that the plugin uses under the hood to automatically upload debug information files upon game build completion.
30+
31+
## Installing from GitHub Releases (Recommended)
32+
33+
The [GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases) provides two plugin packages: `github` and `marketplace`. The key difference between the two is the crash capturing backend, which is used under the hood on Windows.
34+
35+
We recommend using the `github` version, because it uses `Crashpad`, an out-of-proc handler that sends the crash report right away. The `marketplace` version relies on `Breakpad`, an in-proc handler which requires the UE application or game to be relaunched before any crash reports can be sent to Sentry.
36+
37+
To install the SDK, download the most up-to-date sources from the [Releases page](https://github.com/getsentry/sentry-unreal/releases) and add them to your project's `Plugins` directory. On the next project launch, UE will prompt you to build the Sentry and SentryEditor modules.
38+
39+
<Alert>
40+
41+
Currently, this method is available only for C++ UE projects. Blueprint projects can be converted to a C++ one by adding an empty class using the editor.
42+
43+
</Alert>
44+
45+
<Alert>
46+
47+
To avoid warnings during the build for licensee versions of Unreal Engine, the `EngineVersion` key is not set in the `Sentry.uplugin` for the `github` package.
48+
49+
</Alert>
50+
51+
## Installing from Fab
52+
53+
Sentry SDK can be downloaded via the [standard installation process](https://dev.epicgames.com/documentation/en-us/unreal-engine/working-with-plugins-in-unreal-engine#installingpluginsfromtheunrealenginemarketplace) from its [Epic Games Fab page](https://www.fab.com/listings/eaa89d9d-8d39-450c-b75f-acee010890a2).
54+
55+
This method is recommended only for Blueprint UE projects. If you already have a C++ UE project or don't mind converting an existing Blueprint UE project to a C++ one, consider downloading the plugin from GitHub instead.
56+
57+
## Build Yourself
58+
59+
To get started, we recommend cloning the [Unreal SDK repository](https://github.com/getsentry/sentry-unreal) and running the initialization script:
60+
61+
* `./scripts/init.sh` on macOS/Linux
62+
* `./scripts/init-win.ps1` on Windows
63+
64+
<Alert>
65+
Initialization scripts require [GitHub CLI](https://cli.github.com/) to be installed.
66+
</Alert>
67+
68+
<Alert>
69+
If the initialization script fails due to errors on Windows, check your PowerShell version by printing the built-in variable `$PSVersionTable`. If the version is `5.x`, upgrading to a newer version of [PowerShell](https://github.com/powershell/powershell) may resolve these errors.
70+
</Alert>
71+
72+
This script links the checked out version of the plugin (the [plugin-dev](https://github.com/getsentry/sentry-unreal/tree/b67076ad5dc419d46b4be70a0bd6e64c2357a82d/plugin-dev) directory) to the [sample app](https://github.com/getsentry/sentry-unreal/tree/b67076ad5dc419d46b4be70a0bd6e64c2357a82d/sample) and downloads the latest builds of native SDKs from our GitHub CI.
73+
74+
After successful initialization, copy the contents of the `plugin-dev` directory to `<your_project_root>/Plugins/Sentry`. This will allow you to use Sentry in your Unreal Engine project.
75+
76+
## Confirm Installation
77+
78+
To make sure the Sentry plugin has been enabled after installation has been completed, go to the editor and navigate to the **Settings > Plugins > Code Plugins** menu and check for the installation.
79+
80+
![Sentry window](../img/unreal_plugins_window.png)
81+
82+
To access the plugin API from within C++,
83+
add `Sentry` support to the build script (`MyProject.build.cs`):
84+
85+
```csharp
86+
PublicDependencyModuleNames.AddRange(new string[] { ..., "Sentry" });
87+
```

0 commit comments

Comments
 (0)