Skip to main content

Installation and project setup

Enable the plugin​

  1. Install the UE 5.5 package. For a project installation, put DesktopGameToolkit/ inside <YourProject>/Plugins/, with DesktopGameToolkit.uplugin directly inside it.
  2. Open Edit > Plugins, enable Desktop Game Window Toolkit, and restart the Editor.

Keep one installation: engine-level or project-level. A source installation requires building your project's Editor target before reopening it.

Configure the project​

Enable Project Settings > Plugins > Desktop Game Window Toolkit > Enable Packaged Desktop Mode. This prepares offscreen rendering and automatic startup. Hotkeys and Always On Top are runtime controls.

Under the plugin's Startup section, choose Desktop Display Mode: Selected Display (default) opens on one monitor; All Displays opens one window across all connected monitors and renders at their combined physical bounds. A saved player preference overrides this default. See Display selection for next-launch controls and monitor changes.

Under Project Settings > Engine > Rendering, set:

SettingRequired value
Alpha OutputEnabled (r.PostProcessing.PropagateAlpha=True)
Frame Buffer Pixel Format8bit RGBA (r.DefaultBackBufferPixelFormat=0)

Under Project Settings > Platforms > Windows, choose your graphics API and include its targeted shader format:

APIShader format
DirectX 11SM5 (PCD3D_SM5)
DirectX 12SM6 (PCD3D_SM6)

Cook both formats if your game supports both APIs. The plugin does not select the RHI or add shaders automatically.

Restart when requested, finish shader compilation, and repackage after configuration changes. Get Project Configuration Issues reports missing requirements; it does not fix them or validate your scene.

Make sky, clouds, and fog transparent​

Use Holdout for sky and clouds when you want to keep them in your level without covering the desktop:

  1. Under Project Settings > Engine > Rendering, enable Alpha Output. For the Deferred Renderer, also enable Support Primitive Alpha Holdout (Deferred) and restart the Editor.
  2. Select SkyAtmosphere and its component. In Details, search for Holdout and enable it.
  3. Repeat for VolumetricCloud if present.

ExponentialHeightFog: In UE 5.5, Fog Holdout can also reduce the alpha of Opaque objects seen through the fog. Disable the fog if you need a clear desktop background with fully solid objects. Turning Holdout off restores their opacity, but the fog can cover the background again.

After switching to Transparent, the desktop should show through the clear background areas. Opaque meshes and full-screen widgets can still cover them.

Test in a separate Standalone process​

  1. Open Editor Preferences > Level Editor > Play.
  2. Under Play in Standalone Game, add -DGTStandalonePreview to Additional Launch Parameters.
  3. Run Standalone Game as a separate process.

Keep the desktop and rendering settings enabled. Without the flag, Standalone uses a regular game window. In-viewport PIE cannot create a desktop host. Append -d3d11 or -d3d12 to test an API whose shaders are available.

The host starts Opaque. Complete Quick Start to register a hotkey and enable Transparent. Leave clear space around your object: skies, floors, post-process effects, and full-screen widgets can cover the desktop.

Package and verify​

Package a Windows / Win64 client with the plugin enabled. Keep all three runtime modules and the Content folder, including the alpha-correction material.

Launch the executable normally; no preview flag is required. Verify transparency, hotkey recovery, widgets, map changes, and your display controls in the final Shipping package. Standalone uses Editor binaries and does not replace this check.

If startup fails, see Troubleshooting.