CalmUI
Getting Started

Open the Sample Project

Explore the Views, package and Blueprint included with a release.

  1. Open samples/CalmUISample/CalmUiSandbox.uproject from the release folder.
  2. Choose Tools → CalmUI Studio.
  3. On Welcome, click Connect running Editor and select that project.
  4. Open the Gameplay package and its Views to inspect their source.

The sample carries its own copy of the CalmUI plugin under Plugins/CalmUI, so it runs without installing anything into it first.

What the Gameplay package contains

Gameplay declares four screens, imported into Unreal as /Game/CalmUI/Docs/Gameplay:

ScreenLayerSource View
MainMenuscreenscreens/TestHud.calmui
Settingsscreenscreens/Inventory.calmui
Hudhudscreens/TestHud.calmui
ConfirmModalmodalscreens/ConfirmModal.calmui

The source filenames keep their historical names; the screen names in the package, not the filenames, are what your game opens.

MainMenu is a port of a production main menu. It uses the reusable CalmariaMenuButton component and the workspace's shared theme tokens, localized text through $loc, explicit gamepad navigation between its buttons, Store fields for save state and inventory items, and typed Actions such as mainMenu.continue and mainMenu.openSettings for the game to answer.

The Blueprint side

Content/CalmUI/Docs/BP_CalmUiDocs drives that package from Blueprint: it loads and unloads it, opens the screen, HUD and modal, pushes and pops screens, listens for the menu's Actions, writes Store values in a batch, subscribes to a Store field, and reads the input policy. Open it next to the Views to see both halves of the same screen.

Use the sample to study one feature at a time. For your first Blueprint graph, follow Show your first screen and Make a button run Blueprint.

Other packages in the workspace

The same workspace also holds R4… and R9Acceptance packages with Views such as RetainedFlush…, ScrollPerf and R4BackdropBlur…. Those are engine acceptance fixtures used to test the runtime, not examples to copy into a game.

The release sample carries its own source and imported assets, so the folder can be copied elsewhere and still open.

On this page