https://github.com/betahub-io/unreal-plugin
In-game bug reporting for Unreal Engine with video capture, log collection, and instant BetaHub submission.
https://github.com/betahub-io/unreal-plugin
beta-testing debugging-tools gamedev gamedev-tools log-collection unreal-engine unreal-engine-5 unreal-plugin unrealegine video-recording
Last synced: 24 days ago
JSON representation
In-game bug reporting for Unreal Engine with video capture, log collection, and instant BetaHub submission.
- Host: GitHub
- URL: https://github.com/betahub-io/unreal-plugin
- Owner: betahub-io
- License: mit
- Created: 2024-06-26T19:35:22.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-02-16T16:19:29.000Z (26 days ago)
- Last Synced: 2026-02-16T22:49:29.487Z (25 days ago)
- Topics: beta-testing, debugging-tools, gamedev, gamedev-tools, log-collection, unreal-engine, unreal-engine-5, unreal-plugin, unrealegine, video-recording
- Language: C++
- Homepage: https://betahub.io
- Size: 27.9 MB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# BetaHub Unreal Plugin
## How it works
The plugin will start a *Background Service* that will record gameplay session as a video, including all the Unreal Engine logs. Then, it listens for the shortcut key (F12 by default) to open the bug reporter window. The user can then type in the bug description and submit it to the BetaHub platform.
## Installation
### From GitHub
1. Navigate to your Unreal project directory.
2. Open the `Plugins` directory, or create it if it doesn't exist.
3. Unpack the contents of the GitHub repository into the `Plugins/BetaHubBugReporter` directory.
4. Restart Unreal Editor.
5. Confirm any prompts or warnings that may appear.
## Compatibility
This plugin is fully compatible with Unreal Engine versions **5.3**, **5.4**, **5.5**, and **5.6**. If you're looking for Unreal 4 support, there's a [separate repo for that](https://github.com/betahub-io/unreal-4-plugin).
All features have been tested and verified on these versions.
## FFmpeg Installation
The plugin requires FFmpeg for video recording. Place the FFmpeg executable in the following location based on your platform:
- **Windows:** `Plugins/BetaHubBugReporter/ThirdParty/FFmpeg/Windows/ffmpeg.exe`
- **Mac:** `Plugins/BetaHubBugReporter/ThirdParty/FFmpeg/Mac/ffmpeg`
- **Linux:** `Plugins/BetaHubBugReporter/ThirdParty/FFmpeg/Linux/ffmpeg`
For packaged builds, place the executable (renamed to `bh_ffmpeg` or `bh_ffmpeg.exe`) in `Binaries//`.
## Configuration
All you need to do is to go to your *Player Settings* and in the *BetaHub Bug Reported* section under the *Plugins* category, set your Project ID. You can find your Project ID in your project *General Settings* page.
There, you can also configure your shortcut key to open the bug reporter window.
For full docs and guides, please visit the [BetaHub Documentation](https://betahub.io/docs/permalinks/unreal-plugin).
## Development Branch
This repository has an actively maintained `dev` branch which is often more up-to-date than `master`. If you encounter any issues on `master`, we recommend checking whether the problem has already been addressed in the `dev` branch:
👉 https://github.com/betahub-io/unreal-plugin/tree/dev
The `dev` branch is regularly merged into `master` after we ensure that it does not introduce regressions for users who simply clone the repository and use `master` as-is.