Packaging and troubleshooting
Package the way you always do in Unreal. Before packaging, check two things: the dependencies have been downloaded, and the page has been rebuilt after any change.
Standard packaging
- Download the dependencies in the editor.
- When the page has changed, rebuild it first (have the AI build it, or run
npm run buildin the interface's folder). - Package with Unreal's normal Windows packaging or with Project Launcher.
A Blueprint-only project also needs the Visual Studio C++ toolchain and Windows SDK required by Unreal Engine 5.8 to package, because a code plugin is enabled. You write no C++.
Without the dependencies, packaging fails with this line in the log. Open the editor, click the WebUIStudio button to download them, then package again:
LogOrionBrowserPreparation: Error: OrionBrowser cannot be packaged (exit 1). OrionBrowserHelper.exe is missing. Nothing is downloaded automatically. Start Unreal Editor, click the WebUIStudio button on the toolbar and download the dependencies, then try again. See the documentation: https://orionue.com/orionbrowser/docs/en/installation/Sounds, fonts, textures and App Definitions that an interface uses must be referenced by a map or another asset that gets packaged; an asset name written only in JSON does not put the asset in the package.
Packaging from the command line
From the plugin root:
.\Scripts\Package-OrionBrowserProject.ps1 -EngineRoot $EngineRoot -ProjectFile $ProjectFile -ArchiveDirectory $ArchiveDirectory -Configuration ShippingThe sample project also includes Scripts/ and Scripts/, each taking -EngineRoot.
Shipping the game
Give players the whole packaged output folder, not only the top-level exe. Local interfaces need no internet; only places that deliberately open a remote website do.
Troubleshooting
| Symptom | Action |
|---|---|
Packaging fails and the log contains OrionBrowser cannot be packaged |
The dependencies have not been downloaded, or a plugin update needs newer ones. Open the editor, click the WebUIStudio button to download them, then package again |
| Packaging a Blueprint-only project reports a missing compiler or Visual Studio | Install the Visual Studio C++ toolchain and Windows SDK required by Unreal Engine 5.8 |
| The page is blank | Check the AppId, that the page has been built (dist/index.html exists) and the App Definition; see what On Web Error reports |
| Works in Studio, nothing happens in Unreal | Check that On Web Event / On Web Request are bound, the event names are spelled the same, the payload types and your Blueprint validation |
| Works in the editor, something is missing in the package | Make sure the assets in use are referenced by a packaged map or asset; after page changes, rebuild before packaging |