Installation and downloading the dependencies

Install the plugin, download its two dependencies, and in a blank project set the CommonUI viewport. Then the sample runs.

On this page

Install
Download the dependencies
CommonUI viewport
Download failures and offline use

Install

Use Unreal Engine 5.8 on Windows 64-bit.
Install the plugin through Fab, or copy the whole plugin folder to the project's Plugins/OrionBrowser.
Open the project, enable OrionBrowser in Plugins and restart the editor when asked.
Download the dependencies; see the next section.
In a blank project, also set the CommonUI viewport. The supplied sample project already has it.
In the Content Browser, turn on Show Plugin Content, open OrionBrowser/Showcase/L_OrionBrowserOverview and click Play.

Download the dependencies

The plugin needs two programs. Download them once before first use, about 160 MB in total:

Dependency	Purpose
Helper	Displays the web interfaces, in the editor and in the packaged game
WebUIStudio	The tool for making and previewing interfaces; not shipped with the game

Click the WebUIStudio button on the Level Editor toolbar.
In the OrionBrowser Dependencies window that opens, click Download and wait for it to finish.
Click Open WebUIStudio. Interfaces in the editor refresh by themselves; no restart is needed.

The level editor's main toolbar with the WebUIStudio button outlined — Figure 1The main toolbar of Unreal's level editor. The outlined button is **WebUIStudio**, right after the Add, Blueprint and Cinematics drop-downs. Until the dependencies have been downloaded, clicking it opens the **OrionBrowser Dependencies** window first.

The first click on the WebUIStudio button: both files are missing — Figure 2The **OrionBrowser Dependencies** window: missing, downloading, ready.

After Download: the current file, the bytes transferred and the progress — Figure 2The **OrionBrowser Dependencies** window: missing, downloading, ready.

Once the files are in place, the button opens WebUIStudio directly. When a plugin update needs newer dependencies, the window appears again; click Download.

The plugin never downloads anything by itself. Until the dependencies are in place, interfaces in the editor show a one-line notice and the project cannot be packaged.

CommonUI viewport

In Project Settings, set Game Viewport Client Class to CommonGameViewportClient, then restart the editor. Or write it directly in the project's Config/DefaultEngine.ini:

INI

[/Script/Engine.Engine]
GameViewportClientClassName=/Script/CommonUI.CommonGameViewportClient

If your game already has its own viewport class, keep it and make it derive from CommonGameViewportClient. Without this setting a page still shows and takes mouse clicks, but keyboard and gamepad input go wrong.

Download failures and offline use

The download failed: the window states the reason. Check the network and click Retry.
The plugin folder is not writable (for example inside a protected engine folder): give the folder write access, or use the offline way below.
No network: on a connected computer, open the releases page, download OrionBrowserHelper.exe and WebUIStudio.exe, and put them in the plugin's Binaries/Win64. Which release each file comes from is its releaseTag in the plugin's Config/OrionBrowserDistribution.json. Then click the WebUIStudio button: when no window opens, the files are right.