sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Add Unreal Engine platform

Open marandaneto opened this issue 4 years ago • 10 comments

We support the Unreal engine via the Native platform, see https://docs.sentry.io/platforms/native/guides/ue4/

It's missing which platforms are supported though, probably Win and Linux only? @jan-auer

It's also possible to develop mobile games with Unreal but it's unclear if we whether support it or not, this raised this issue: https://github.com/getsentry/sentry-java/issues/1210

Ideally, we'd have its own Unreal platform under the docs that links to the desired platform, for example, redirecting Win/Linux to the Native platform, but if Android or iOS, link to the Android or iOS platform, so people could add them directly as we don't support as a 1st class citizen SDK like Flutter for example (Add one SDK and works for all platforms), yet.

marandaneto avatar Feb 01 '21 08:02 marandaneto

The crashreporter works on Windows, Linux and macOS.

We could lift Unreal Engine to be a top level platform (like Unity) with a fallback to native (like Android->Java). Platform icon is already: https://github.com/getsentry/platformicons/blob/7a81291d4216172066c794beb8448a638658e577/svg_80x80/unreal.svg But missing the mapping: https://github.com/getsentry/platformicons/pull/33/files

Then we can also add docs for Android and iOS under Unreal Engine (per getsentry/sentry-java#1210)

bruno-garcia avatar Feb 02 '21 01:02 bruno-garcia

Then we can also add docs for Android and iOS under Unreal Engine (per #1210)

wrong #ID?

marandaneto avatar Feb 02 '21 08:02 marandaneto

Then we can also add docs for Android and iOS under Unreal Engine (per #1210)

wrong #ID?

Fixed. Tks

bruno-garcia avatar Feb 02 '21 22:02 bruno-garcia

I merged this: https://github.com/getsentry/sentry-docs/pull/3005 but the platform now under native is called ue4.

Ideally when moving it to top-level, and naming the platform, call it unreal.

bruno-garcia avatar Feb 02 '21 23:02 bruno-garcia

The key to be: unrealengine: https://github.com/getsentry/platformicons/pull/34

Didn't add a - because it's what's used to nest platforms.

bruno-garcia avatar Feb 05 '21 22:02 bruno-garcia

Moving Unreal Engine to a top-level platform aligns with our platform delineation guides. As for what we call it, I'm uncertain. unreal is shorter for the URL and slub, but in the UI we should probably spell out the full "Unreal Engine".

We support all three platforms: Windows, Linux, and macOS. The latter is slightly different internally as it sends AppleCrashReports, but regardless we do offer the same level of support on all platforms. We have never tested mobile platforms.

jan-auer avatar Feb 08 '21 09:02 jan-auer

I suggest we call it unreal-engine. We called unreal in the UE4 endpoint because it was shorter but I believe for a URL it'll be better to be more descriptive.

Also UE5 was announced so we don't want to use ue4 as version info will be sub pages.

bruno-garcia avatar Feb 10 '21 00:02 bruno-garcia

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Accepted, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

github-actions[bot] avatar Mar 03 '21 00:03 github-actions[bot]

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

github-actions[bot] avatar Sep 10 '21 12:09 github-actions[bot]

Changing my mind here and agree with @jma that unreal is best

bruno-garcia avatar Feb 02 '22 17:02 bruno-garcia

Seems like this is obsolete, unreal docs exist now: https://docs.sentry.io/platforms/unreal/

The docs also mention the required information regarding supported operating systems ✌️

stephanie-anderson avatar Jun 14 '23 16:06 stephanie-anderson