Skip to content

Commit d1a8968

Browse files
committed
Moving GitHub releases to the top
1 parent 1dcba28 commit d1a8968

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

docs/platforms/unreal/installation/installation-recommendations.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,30 +19,31 @@ Sentry offers all three for you to be able to get the insights only Sentry can p
1919

2020
### Overview of SDK Versions
2121

22-
The table below highlights some key differences between different versions of the plugin:
22+
The table below highlights some key differences between different versions of the SDK:
2323

24-
| Feature | Fab | GitHub Releases | Build Yourself |
25-
|----------------------------|---------------------|-----------------|----------------|
26-
| Supported engine versions | 5.1 and newer | 4.27 and newer | 4.27 and newer |
27-
| Supported UE project types | Blueprint and C++ | C++ only | C++ only |
28-
| Backend (Windows) | Breakpad | Crashpad | Crashpad |
29-
| `on_crash` hook (Windows) | Not supported | Supported | Supported |
30-
| Sentry CLI * | Manual download | Included | Included |
24+
| Feature | __GitHub Releases__* | Fab | Build Yourself |
25+
|----------------------------|----------------------|---------------------|----------------|
26+
| Supported engine versions | 4.27 and newer | 5.1 and newer | 4.27 and newer |
27+
| Supported UE project types | C++ only | Blueprint and C++ | C++ only |
28+
| Backend (Windows) | Crashpad | Breakpad | Crashpad |
29+
| `on_crash` hook (Windows) | Supported | Not supported | Supported |
30+
| Sentry CLI ** | Included | Manual download | Included |
3131

3232
Legend:
33-
`*`: Sentry CLI is a standalone tool that the plugin uses under the hood to automatically upload debug information files upon game build completion.
33+
`*`: Recommended version of the SDK
34+
`**`: Sentry CLI is a standalone tool that the plugin uses under the hood to automatically upload debug information files upon game build completion.
3435

35-
### Installing from Fab
36+
### Installing from GitHub Releases (Recommended)
3637

37-
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).
38+
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.
3839

39-
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.
40+
We recommend using the `github` version which 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 in order to send the crash reports to Sentry.
4041

41-
### Installing from GitHub Releases
42+
### Installing from Fab
4243

43-
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.
44+
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).
4445

45-
We recommend using the `github` version which 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 in order to send the crash reports to Sentry.
46+
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.
4647

4748
### Build yourself
4849

0 commit comments

Comments
 (0)