CalmUI
Getting Started

What CalmUI Includes

The capabilities CalmUI ships today, and where the product stops.

CalmUI is a CSS-driven UI system: author Views and components in Studio, style them with a supported subset of CSS, and display them in Unreal Engine through the CalmUI plugin. The table below lists what that covers.

CapabilityAreaNotes
CalmUI StudioStudioCreate and edit Views, components, styles, assets, and packages.
Studio previewStudioPreview the selected View or component and inspect its elements.
Themes and design tokensStudioCreate CSS-backed themes, edit tokens, and switch the active Preview theme.
Animation TimelineStudioEdit CSS transitions and keyframes while keeping CSS as the source of truth.
UI Tests workspaceStudioCreate and run Unreal fixture manifests, stream progress, and inspect artifacts.
Reusable componentsComponentsCreate reusable buttons, panels, labels, and other UI parts.
Lucide iconsComponentsSearch, drag, style, and render the pinned Lucide catalog in Studio and Unreal.
Project Vector SVG assetsAssetsImport safe SVG geometry, use it through asset://, and render it at the active DPI in Studio and Unreal.
CSS stylingStylingUse supported CSS for layout, colors, interaction, and animation.
Images, vectors, and fontsAssetsAdd local raster images, Vector SVG assets, and fonts in Studio and prepare them for runtime use.
Unreal Engine pluginUnreal EngineConnect Studio and display CalmUI Views in Unreal Engine 5.7 on Windows.
Blueprint controlsBlueprintLoad packages, show Views, update Store values, and receive actions.
View layersNavigationUse HUD, Screen, Overlay, Modal, and Tooltip layers.
Game dataStoreRead game values in Views and edit safe preview values in Studio.
TranslationsLocalizationUse Unreal translations and preview available languages in Studio.
Live updatesWorkflowSave a file and update the connected Unreal screen without reopening it.
Packaged gamesUnreal EnginePrepare checked UI packages and their assets for Development and Shipping builds.
World-space UI surfacesUnreal EngineRender shared PaintFrames into Unreal render targets and project ray hits into flat world-space surfaces.
Runtime list virtualizationComponentsCore-owned fixed-height windows are shared by Studio Preview and Unreal; variable-height lists are not supported.
Safe-area layout insetsLayoutCore, Studio Preview, and Unreal share logical safe-area inset values through CalmUI CSS env() tokens.
View enter and exit transitionsNavigationManifest durations and classes drive one deterministic Core lifecycle shared by Studio Preview and Unreal.
Nine-slice imagesRenderingSource-authored margins lower to shared image UV patches in Studio Preview and Unreal.
Remappable gamepad profilesInputApply per-Local-Player Enhanced Input profiles with conflict detection, rebinding, reset, and input-method reporting.
Production updatesDistributionA production build updates by installing a newer supplied build; there is no signed public update channel.

Product boundaries

CalmUI runs on Windows x64 with Unreal Engine 5.7, validated on 5.7.4. Linux and macOS builds are exercised by automated checks only; they are not a supported target for a shipped game.

CalmUI is supplied as a Windows installer and an Unreal plugin. It is not listed on the Unreal Marketplace. A production build updates by installing a newer supplied build; there is no signed public update channel.

CSS Profile v0.4 covers flexbox layout, absolute/relative/fixed positioning, 2D transforms, transitions, keyframe animation, gradients, box and text shadows, color filters, and backdrop blur. CSS Grid, 3D transforms, and perspective/transform-style sit outside the profile: CalmUI rejects them with a diagnostic rather than approximating them. See CSS Reference for the full property-by-property breakdown.

On this page