Install CalmUI
Install Studio, open a CalmUI project, and add its plugin to Unreal.
Use the Windows x64 release package supplied to you. Install Studio and the Unreal plugin from the same release. Check requirements first.
Install Studio
- Close any running Studio instance before an update.
- Open the setup executable in
studio/windows-x64/installers/nsis. - Complete the per-user installation and start CalmUI Studio.
- Choose New Project or Open Project….
The release also includes portable Studio if you prefer running it from a folder. Studio includes its compiler and authoring tools; you do not need the CalmUI source repository or a separate Node.js installation.
Install the Unreal plugin
- Close Unreal Editor.
- With the CalmUI project open in Studio, choose Unreal → Connection.
- Click Install or Update Plugin and select your game's
.uproject. - Wait for the installation result, then reopen Unreal.
- Enable CalmUI under Edit → Plugins if necessary, and restart when requested.
Studio links the open CalmUI project to the selected Unreal project. A replaced
plugin is backed up under the game's Saved/CalmUI/PluginBackups folder.
See Plugin installation for manual copying
or a failed installation.
Connect and create UI
In Unreal, choose Tools → CalmUI Studio. On Welcome, use Connect running Editor, or use Unreal → Connection → Connect with a project already open. Wait for Connected, then follow Quick Start.
CalmUI is not listed on the Unreal Marketplace; install it from the supplied
Windows installer and plugin build. Verify supplied release files against
their SHA256SUMS.txt before installing.
For terminal automation, see the separate CLI guide.