DreamGUI

Overview

DreamGUI is a 3D UI plugin for Unreal Engine 5.8 — widgets are UObjects with a rect, a pivot and anchors in a tree, batched by a canvas, on the screen or standing in the level.

DreamGUI is a UI system for Unreal Engine 5.8. A widget here is a UObject with a rect, a pivot and anchors, arranged into a tree; a canvas (UDreamCanvas) batches the whole tree into as few draw calls as it can. That is Unity's uGUI shape rather than Slate's.

The shape buys three things UMG cannot do as directly:

  • UI in the world. A canvas can render in screen space or sit on a surface in the level, at any angle, lit or unlit, with correct hit testing either way.
  • A tree that is a class. A UI tree is authored in a widget Blueprint (UDreamWidgetBlueprint) and reused by subclassing and by nesting one widget class inside another tree — the way UMG's widget Blueprints work. The tree can also be written as text: a .dui file is the source of a widget Blueprint, and the designer writes its edits back into it.
  • Per-widget perspective. A widget can establish a perspective its subtree is foreshortened into, the way CSS perspective works.

It costs you Slate's ecosystem: none of UMG's widgets, styles or bindings apply. DreamGUI has a control library of its own whose names deliberately follow UMG's, and where a name could not be kept the reason is written down (see How it differs from UMG and from upstream).

Plugin version1.0.0, the first public release (the development builds before it were numbered 1.x, 2.0 and 2.1; see the changelog)
EngineUnreal Engine 5.8, a source build or an Epic launcher install
PlatformWin64 is the only platform built and run (see Platforms)
Runtime modulesDreamGUIRenderer, DreamGUI, DreamGUIInput, DreamGUIControls, DreamGUIExtensions, DreamGUISamples, DreamTween
Editor-side modulesDreamGUIEditor, DreamGUIK2Nodes (UncookedOnly), DreamGUITests (Editor)
Plugin dependencyEnhancedInput (the plugin enables it itself)
Source files.dui, under a project's or a plugin's DUI/ directory
Project settingsProject Settings ▸ Plugins ▸ Dream GUI and Project Settings ▸ Plugins ▸ DreamUI
LicenseMIT
OriginA fork of LGUI / LexUI by Lex Liu — not a drop-in replacement for it

At a glance

class /Game/UI/WBP_Hello

Widget Root {
    AnchorData.AnchorMin = (0, 0)
    AnchorData.AnchorMax = (1, 1)
    AnchorData.SizeDelta = (0, 0)
    + Overlay {}

    Text Greeting {
        AnchorData.SizeDelta = (600, 60)
        Text     = "Hello, DreamGUI"
        FontSize = 32
        HAlign   = Center
        @slot HorizontalAlignment = Center
        @slot VerticalAlignment   = Center
    }
}

Root is anchored to all four corners with no inset, so it fills whatever it is added to; + Overlay makes it stack its children; Greeting is a 600 × 60 text, and its two @slot lines are what it asks of the Overlay above it: centred both ways. Point a widget Blueprint's Source File at this file and compile, and it is a class you can add to the viewport or drag into a level — step by step in Your first screen.

Where to start

  • Getting started — Install, your first screen, where things live in a project, the everyday authoring loop.
  • Concepts — Widgets, canvases, world space, widget Blueprints, layout, text, rendering, input, animation.
  • The .dui language — Nodes and values, slots and components, styles, use, components, view models, bindings, if and for, rows, timelines, write-back.
  • Controls — Buttons, toggles, sliders, lists, dialogs, tab views... plus style sheets and the member-by-member UMG comparison.
  • Tools — The designer, the VS Code extension, debugging commands, the test suite, benchmarks, scripting, AI agents and the DreamMCP endpoint.
  • Migration and upgrades — Coming from LGUI, LexUI or an early build, and upgrading between development builds.
  • Networking and multiplayer — UI only where a local player sees it: dedicated and listen servers, the play-in-editor net modes, the warning a server world gives.
  • Packaging and platforms — Shipping fonts, colour emoji and ICU data with a game; which platforms have actually run.
    • Importing layered documents — A .psd or .psb as a DreamUI widget: what each layer becomes, naming conventions, fonts, importing again.
    • Common pitfalls — Things that look like bugs and are not: tweens on one property, angle conventions, raycast targets, style overrides, fonts, effects inside groups, and where UMG's names differ.
    • Property meta tags — The DreamGUI_ tags that place a property in the details panels, hide it or pick its control; how an extension's classes use them.
    • Diagnostics — Every .dui diagnostic is a DUInnnn code, in eight families by stage.
    • API reference — Per-class property and function reference printed from reflection, each page ending with its UMG comparison.
    • Changelog — What changed in each version.

On this page