Getting Started
How CalmUI Works
A simple overview of the path from Studio to the game.
You do not need this page to use Studio. It explains the main ideas behind the workflow.
From Studio to Unreal
UI workflow
- Edit a screen in Studio
- Save
- CalmUI checks and prepares the package
- Unreal receives the updated package
- The game draws the UI
A package is the ready-to-load version of one or more screens. The packaged game uses that prepared data; it does not need Studio.
Gameplay data
Unreal owns gameplay information such as health, inventory, and save data. CalmUI reads the values it needs through the Store. When the player clicks a button, CalmUI sends an Action back to Unreal.
This keeps game rules in the game and presentation rules in the UI.
Advanced details
CalmUI prepares layout and drawing commands before Unreal renders them. Studio uses the same UI rules for preview, while Unreal remains the final reference for how the game looks and responds.