https://github.com/bugsplat-git/my-unreal-crasher
⚙️👾🤯 Sample Unreal Engine 5 project integrated with BugSplat.
https://github.com/bugsplat-git/my-unreal-crasher
bugsplat cpp crash crash-reporting game-development reporting ue4 ue5 unreal unreal-engine
Last synced: 4 months ago
JSON representation
⚙️👾🤯 Sample Unreal Engine 5 project integrated with BugSplat.
- Host: GitHub
- URL: https://github.com/bugsplat-git/my-unreal-crasher
- Owner: BugSplat-Git
- Created: 2022-07-18T21:44:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-27T17:19:26.000Z (4 months ago)
- Last Synced: 2025-02-28T00:45:21.798Z (4 months ago)
- Topics: bugsplat, cpp, crash, crash-reporting, game-development, reporting, ue4, ue5, unreal, unreal-engine
- Language: C#
- Homepage: https://docs.bugsplat.com/introduction/getting-started/integrations/game-development/unreal-engine/
- Size: 130 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://bugsplat.com)
#
BugSplat
### **Crash and error reporting built for busy developers.**
## 👋 Introduction
MyUnrealCrasher is an Unreal Engine 5 project for testing BugSplat crash reporting. This repo has been pre-configured with the [BugSplat-Unreal](https://github.com/BugSplat-Git/bugsplat-unreal) editor plugin that allows you to configure crash reporting with only a few keystrokes.
Before diving into this sample, please complete the following tasks:
* [Sign Up](https://app.bugsplat.com/v2/sign-up) as a new BugSplat user
* Complete the [Welcome](https://app.bugsplat.com/v2/welcome) workflow and make a note of your BugSplat database
* Generate a Client ID and Client Secret for symbol uploads on the [Integrations](https://app.bugsplat.com/v2/settings/database/integrations?database=Fred#oauth) page
## 🥾 Steps
The following guide assumes your project is targeting Windows, but these steps are applicable to other Desktop platforms as well. On Mobile platforms the BugSplat plugin will automatically configure crash reporting and symbol uploads.
1. Before you clone this repo make sure you have [git-lfs](https://git-lfs.github.com/) installed.
2. Clone this repo and the associated submodules. It's important that this repo is cloned with the `--recurse-submodules` flag so that the [bugsplat-unreal](https://github.com/BugSplat-Git/bugsplat-unreal) plugin is also downloaded:
```sh
git clone https://github.com/BugSplat-Git/my-unreal-crasher --recurse-submodules
```
3. Double click the `MyUnrealCrasher.uproject` file to open the project in the Unreal Editor. Depending on the Unreal Engine version you have installed you may need to [Generate Visual Studio project files](https://forums.unrealengine.com/t/how-to-rebuild-my-project-for-include-a-plugin/324613) and build the plug-in from source.
4. Once the project has been opened, click `Edit > Project Settings` and scroll to the `BugSplat` section under `Plugins`.
5. Fill in the values for `Database`, `Application`, `Version`, `Client ID`, and `Client Secret`
### Windows
1. Click `Add Symbol Uploads`
2. Package your project to upload symbols to BugSplat
3. In the `BugSplat` section of `Project Settings` click `Update Game INI`
4. Select the directory that contains the `Windows` or `WindowsNoEditor` folder
### iOS & Android
1. Ensure that `Enable automatic symbol uploads` and `Enable crash reporting` are both checked
2. Package your project to upload symbols to BugSplat
Run your packaged game to generate a crash report. Navigate to the [Crashes](https://app.bugsplat.com/v2/crashes) page and click the link in the ID column to view the details of your crash
If you did everything correctly your result should look something like this
