Install the Unreal Plugin

Install from Studio

1. Close Unreal Editor so plugin files can be replaced.
2. Open or create the CalmUI project you want to use in Studio.
3. Open Unreal → Connection and choose Install or Update Plugin.
4. Select the game's .uproject and wait for the result.
5. Reopen Unreal and restart if the result requests it.

Studio installs the bundled plugin into Plugins/CalmUI, enables it in the game project, and links the open CalmUI source folder. The result reports each step. A replaced plugin is kept under Saved/CalmUI/PluginBackups. Installing again reuses a matching copy and preserves unrelated game settings.

If installation fails, read the reported reason: check that the selected project exists, the folder is writable, and the bundled plugin matches Studio. A failed replacement restores the previous plugin and configuration.

Install manually

1. Close Unreal Editor.
2. Open unreal/CalmUI in the release folder.
3. Copy its contents into your game's Plugins/CalmUI folder.
4. Confirm that Plugins/CalmUI/CalmUI.uplugin exists.
5. Open the Unreal project and accept a plugin rebuild if Unreal asks.
6. Enable CalmUI under Edit → Plugins and restart when requested.

After restart, Tools → CalmUI Studio should be available.

Check the source folder

Open Project Settings → Plugins → CalmUI in Unreal. CalmUI Source Workspace should point to the CalmUI project you edit in Studio. The settings also show connection status and the resolved folder.

If you relink the source folder while Unreal is open, restart when Studio reports Restart required. Updating plugin binaries always requires closing Unreal.

For connection errors or duplicate plugin copies, see installation troubleshooting.