Unreal marketplace limitations #12076
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
|
bruno-garcia
left a comment
bruno-garcia
left a comment
There was a problem hiding this comment.
This is great! Thank you Sarah!
docs/platforms/unreal/installation/installation-recommendations.md
Outdated
Show resolved
Hide resolved
| There are three common ways to install an SDK to use with Unreal Engine: | ||
| 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)) | ||
| 2. Download a pre-built SDK that you install (e.g. from a [GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases)) | ||
| 3. Clone and build the SDK yourself and install |
There was a problem hiding this comment.
Nice. This will come in handy soon since we're working on improving our build so users can build our SDK using U reals build system.
| | Supported UE project types | Blueprint and C++ | C++ only | C++ only | | ||
| | Backend (Windows) | Breakpad | Crashpad | Crashpad | | ||
| | `on_crash` hook (Windows) | Not supported | Supported | Supported | | ||
| | Sentry CLI | Manual download | Included | Included | |
There was a problem hiding this comment.
we should say perhaps "Sentry CLI (automatic symbol upload)" or something? not sure just Sentry CLI here will suffice for folks who just landed in and are learning about this sdk.
perhaps a * next to the title and a clarification below to what this means. Do we create releases too? perhaps we use the CLI for other stuff also. @tustanivsky ?
There was a problem hiding this comment.
I love the idea of adding * - thanks for the tip!
Currently we're using Sentry CLI solely for debug symbol upload
| | `on_crash` hook (Windows) | Not supported | Supported | Supported | | ||
| | Sentry CLI | Manual download | Included | Included | | ||
|
|
||
| ### Installing from Fab |
There was a problem hiding this comment.
I think we should put this below the GH heading. Perhaps before we describe either we have a general recommendation. like:
"We recommend the GitHub release. Main advantages are: Crash reports uploaded immediately (crashpad), automatic symbol upload and larger range of supported UE versions. If you have a Blueprint only project you'd need to convert it to C++"
|
|
||
| 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. | ||
|
|
||
| ### Build yourself |
There was a problem hiding this comment.
@PlasmaDev5 these details would be updated with your solution to build using the UÉ build system.
|
testing the preview the new link didn't show up. Not sure if a vercel issue |
lizokm
left a comment
lizokm
left a comment
There was a problem hiding this comment.
Just a few minor comments, but otherwise this looks good!
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
* Create installation-recommendations.md * Update installation-recommendations.md * Update index.mdx * Update installation-recommendations.md * Update installation-recommendations.md * Update index.mdx * Update installation-recommendations.md * Update docs/platforms/unreal/installation/installation-recommendations.md * Moving GitHub releases to the top * Moving installation to the main page * Update docs/platforms/unreal/index.mdx * Update docs/platforms/unreal/index.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/unreal/index.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/unreal/index.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> * Update docs/platforms/unreal/index.mdx Co-authored-by: Liza Mock <liza.mock@sentry.io> --------- Co-authored-by: Ivan Tustanivskyi <tustanivsky@gmail.com> Co-authored-by: Liza Mock <liza.mock@sentry.io>
DESCRIBE YOUR PR
In support of a blog post coming out, we realized we're missing a more detailed explanation of what is available for each package version of the Unreal SDK. This should add that detail.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: