Unreal Engine Plugin

Installation

The uVersion plugin ships as a precompiled binary, managed by the desktop client. No compilation on your end, no source files to handle.

Supported Unreal versions: 5.6 and later.

Procedure

1. Install the uVersion desktop client
2. Add the workspace containing your Unreal project to the client
3. The Unreal panel automatically detects your .uproject
4. The client installs the plugin matching your Unreal version and platform
5. Open the project in Unreal, the plugin is active right away

Updates

The desktop client checks for new versions when you open the project and every 6 hours. When a newer version is available for your Unreal, an « Update ready » badge appears in the client's Unreal panel. Close the Unreal editor, then click it to apply the update (the plugin cannot be replaced while it is loaded).

First connection

In the Unreal editor: Tools → Source Control → Connect to Source Control, choose uVersion in the Provider dropdown.

Your credentials are retrieved automatically from the desktop client. You have nothing to re-enter. If for any reason the desktop client is not installed, the editor shows a form to enter the server address and your credentials.

What the plugin does in Unreal

Native Source Control

Checkout, checkin, revert, history: everything is available from the right-click menu in the Content Browser, just like with any other Unreal Source Control Provider. Artists have nothing new to learn.

Automatic locking on edit

When you modify an asset, the plugin automatically places a server-side lock, without you having to do a manual checkout. You work, the plugin handles the locking silently.

Visual Blueprint diff

Compare two revisions of a Blueprint directly in Unreal, using the editor's standard visual diff tool. Works on any commit in the history.

Pre-checkin validation

Before every submission, the plugin runs a series of checks on the modified files: Blueprint compilation, naming convention, texture size, missing dependencies, circular dependencies, and more. Errors block the checkin, warnings are shown as advisories. Rules can be toggled and configured per project from the Admin panel of the desktop client.

Redirector cleanup

When you rename or move an asset, Unreal creates redirectors that can pile up. The plugin detects and cleans them automatically at checkin time, updating the references in all affected assets.

Startup reconciliation

When the project opens, the plugin checks the state of your assets and syncs the status with the server. Files you were editing are automatically re-locked, to prevent a teammate from mistakenly claiming something you had started.

Lock release request

If you want to modify an asset a teammate has locked, the plugin lets you send a release request. A notification arrives at the teammate's desktop client.

Common issues

« Failed to connect to source control »

Check that you are properly logged in to the desktop client. It is what holds your credentials.

The plugin does not update

Close the Unreal editor first: the plugin cannot be replaced while it is loaded. Then click the plugin's status badge in the Unreal panel of the desktop client to re-run the check and apply the update.