Sentry SDK for Unreal Engine =========== This project is an SDK for Unreal Engine that wraps different Sentry's SDKs for both desktop and mobile. Also, it [has a stable support for the Unreal Engine crash reporter](https://docs.sentry.io/platforms/unreal/setup-crashreport/). ## Downloads The SDK can be downloaded from the [Releases] page, which also lists the changelog of every version. [releases]: https://github.com/getsentry/sentry-unreal/releases ## Supported Platforms and Unreal Engine version The SDK currently supports and is tested on the following platforms: - Windows - macOS - Linux - Android - iOS The SDK complies with three latest engine versions. ## Known Limitations - On all platforms captured crashes are uploaded to Sentry only after relaunching the crashed app since the in-process breakpad handler cannot do this within the same session. The only exception is Linux for which the out-of-process crashpad handler is used and crashes are uploaded immediately. - To automatically capture crashes in Windows game builds that were made using engine versions prior to UE 5.2, the [Crash Reporter has to be configured](https://docs.sentry.io/platforms/unreal/setup-crashreport/) first. - Using UGS binaries requires tagging of files to ensure the crashpad_handler.exe and sentry.dll is present. For inclusion in build graph, you'd want something like this: ``` ``` - In order to fix errors during the Android debug symbols upload in UE 5.0 or newer (Windows) the default `Android File Server` plugin has to be disabled first. - To avoid issues with running certain plugin scripts on Windows using [PowerShell 7](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?WT.mc_id=THOMASMAURER-blog-thmaure&view=powershell-7.3&viewFallbackFrom=powershell-7) is recommended. - In UE 5.2 or newer game log attached to crashes captured with `sentry-native` integration instead of [crash reporter](https://docs.sentry.io/platforms/unreal/setup-crashreport/) could be truncated. This is caused by current `crashpad` behavior which sends crashes to Sentry right away while UE is still about to write some bits of information to the log file. - Only crash events captured on Android contain the full callstack. Events that were captured manually won't have the native C++ part there. ## Development Please see the [contribution guide](https://github.com/getsentry/sentry-unreal/blob/main/CONTRIBUTING.md). ## Resources * * * [![Discord Chat](https://camo.githubusercontent.com/d01e676e4b21bbe94d9d286944290a5d1226b2f268630d77c5e06782bc8e5964/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3632313737383833313630323232313036343f6c6f676f3d646973636f7264266c6f676f436f6c6f723d66666666666626636f6c6f723d373338394438)](https://discord.gg/PXa5Apfe7K) * * [![Twitter Follow](https://camo.githubusercontent.com/bb90a499ce79cf8b723c7f156c36c872b2297c491cf22137fa4cfa14ab1d3db1/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f666f6c6c6f772f67657473656e7472793f6c6162656c3d67657473656e747279267374796c653d736f6369616c)](https://twitter.com/intent/follow?screen_name=getsentry)