Skip to content

Commit 6c65757

Browse files
authored
Update Unreal Engine SDK installation methods page (#14481)
This PR updates Unreal SDK installation methods page after the support of two separate package versions for GitHub and FAB was removed in getsentry/sentry-unreal#1030. Related to getsentry/team-gdx#13
1 parent 07b5270 commit 6c65757

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

docs/platforms/unreal/install/index.mdx

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,19 @@ While you can use any of the three methods to install Sentry, each has its own l
1515

1616
The table below highlights some key differences between different versions of the SDK:
1717

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 |
18+
| Feature | __GitHub Releases__* | Fab | Build Yourself |
19+
|------------------------------|----------------------|----------------------|----------------|
20+
| Supported engine versions | 4.27 and newer | 5.4 and newer | 4.27 and newer |
21+
| Supported UE project types | C++ only | Blueprint and C++ | C++ only |
22+
| Cross-compiling for Linux ** | Supported | Manual configuration | Supported |
2623

2724
Legend:
2825
`*`: 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.
26+
`**`: To support cross-compilation for Linux on Windows, the Fab version of the SDK includes an editor utility that pre-builds the binaries required by UAT.
3027

3128
## Installing from GitHub Releases (Recommended)
3229

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.
30+
The [GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases) provides plugin packages for all supported engine versions.
3631

3732
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.
3833

@@ -44,7 +39,7 @@ Currently, this method is available only for C++ UE projects. Blueprint projects
4439

4540
<Alert>
4641

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.
42+
To avoid warnings during the build for licensee versions of Unreal Engine remove the `EngineVersion` key from the `Sentry.uplugin` file.
4843

4944
</Alert>
5045

0 commit comments

Comments
 (0)