-
-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Onboarding Wizard for Unreal Engine can be misleading: #82610
Comments
@tustanivsky fyi |
Would it make sense to expand on the other installation options available to users in the wizard?
We can remove mentioning this option entirely as it's not required anymore and leave only the |
This PR enhances the UE SDK onboarding wizard with the following changes: 1. Updated Installation Instructions: - Clarified which artifact users should download from the [plugin's GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases). - Added a link to [alternate installation methods](https://docs.sentry.io/platforms/unreal/#install). 2. Improved Crash Reporter guidance by adding an explicit notice that it should be used for automatic crash capturing with UE versions older than 5.2. 3. Removed the redundant info about including debug files in packaged game build. For more details, refer to [issue #82610](#82610).
This PR enhances the UE SDK onboarding wizard with the following changes: 1. Updated Installation Instructions: - Clarified which artifact users should download from the [plugin's GitHub Releases page](https://github.com/getsentry/sentry-unreal/releases). - Added a link to [alternate installation methods](https://docs.sentry.io/platforms/unreal/#install). 2. Improved Crash Reporter guidance by adding an explicit notice that it should be used for automatic crash capturing with UE versions older than 5.2. 3. Removed the redundant info about including debug files in packaged game build. For more details, refer to [issue #82610](#82610).
Not clear what artifact to download
We say in the wizard:
But going to that page I see several artifacts.
It's unclear which one I should download. I can imagine one would understand the numbers refer to the Engine's version. But
github
vsmarketplace
is quite confusing to the user.The copy in the wizard must clarify this.
Simple fix: Update the copy to say: "Select the artifact containing the version of UE you're using and
github
".Ideal fix: we should have a selector where the user specifies the version and we build the URL completely.
This way we can capture if an unsupported version is selected, for example.
Debug Information
In case of native it's not just about getting the best out of Sentry. But rather crash reports will be useless without this step. We should be clear about it.
Is the default for this option not to be enabled? I feel this should be done via build warnings (if we can detect that and print a warning) and this entry could be moved into the docs under FAQ or troubleshooting.
The wizard should be as simple as possible.
Also the last section is about Uploading Debug Symbols so it feels redundant to have this option
Crash Reporter Endpoint
Should we be adding this? I thought on Unreal 5.1 and newer we don't require this, and we prefer users don't use it (and only use our SDK instead)
If so, we can split this into a separate Wizard. As "Unreal Engine Crash Reporter Client".
And have a selector when the user selects Unreal Engine we show the options. SDK (PC/Mobile), CRC (PC only) for example.
Similar to this:
Example
The text was updated successfully, but these errors were encountered: