Skip to content

Commit 793d7dd

Browse files
authored
Update installation-recommendations.md
1 parent 4fb87c7 commit 793d7dd

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

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

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,48 @@ While Unreal Engine uses "plugins", we will refer to the Sentry support we offer
1212

1313
There are three common ways to install an SDK to use with Unreal Engine:
1414
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))
15-
2. Download a pre-built SDK that you install (e.g. from a GitHub Releases page)
15+
2. Download a pre-built SDK that you install (e.g. from a [GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases))
1616
3. Clone and build the SDK yourself and install
1717

18-
Being Fair Source, Sentry offers all three for you to be able to get the insights only Sentry can provide. However, each has it's own limitations.
18+
Being [Fair Source](https://fair.io/), Sentry offers all three for you to be able to get the insights only Sentry can provide. However, each has it's own limitations.
1919

2020
### Overview of SDK Versions
2121

22-
| Feature | Fab | GitHub Releases | Build Yourself |
23-
|---------|-----|-----------------|----------------|
24-
| sentry.cli | | X | X |
22+
| Feature | Fab | GitHub Releases | Build Yourself |
23+
|----------------------------|---------------------|-----------------|----------------|
24+
| Supported engine versions | 5.1 and newer | 4.27 and newer | 4.27 and newer |
25+
| Supported UE project types | Blueprint and C++ | C++ only | C++ only |
26+
| Backend (Windows) | Breakpad | Crashpad | Crashpad |
27+
| `on_crash` hook (Windows) | Not supported | Supported | Supported |
28+
| Sentry CLI | Manual download | Included | Included |
2529

2630
### Installing from Fab
2731

32+
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).
33+
34+
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.
2835

2936
### Installing from GitHub Releases
3037

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.
39+
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.
3141

3242
### Build yourself
3343

44+
To get started, we recommend cloning the [Unreal SDK repository](https://github.com/getsentry/sentry-unreal) and running the initialization script:
45+
46+
* `./scripts/init.sh` on macOS/Linux
47+
* `./scripts/init-win.ps1` on Windows
48+
49+
<Note>
50+
Initialization scripts require [GitHub CLI](https://cli.github.com/) to be installed.
51+
</Note>
52+
53+
<Note>
54+
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.
55+
</Note>
56+
57+
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.
58+
59+
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.

0 commit comments

Comments
 (0)