Use the Unreal Engine Plugin¶
The FlexVault Unreal Engine plugin integrates FlexVault directly with Unreal Engine's built-in Revision Control system. It takes automatic draft snapshots in the background and around major operations to protect your work, and lets you check asset status, submit revisions, revert changes, and track assets without leaving the Unreal Editor. The plugin is listed on Fab.
The Unreal Engine plugin is in beta
If you run into issues, have questions, or want to share feedback, join the FlexVault Discord.
Compatibility¶
| Supported Unreal Engine |
|---|
| Unreal Engine 5.8 |
The plugin descriptor does not restrict engine versions, but 5.8 is the only version currently supported.
The plugin enforces semantic version checks against the fxv binary and blocks incompatible CLI versions to prevent wire format issues. If your installed fxv is out of range, the plugin's error message states the exact range it requires.
Before you begin¶
Confirm the following prerequisites before setting up the plugin:
- You have Unreal Engine 5.8 installed.
- Your project is capable of building C++ code, and a C++ build toolchain (such as Visual Studio on Windows) is installed on your machine. If you cannot build your project, you cannot build the FlexVault plugin. This is required for solo or local projects building from source; it is not required if your team repository already distributes precompiled plugin binaries or if you install via Fab.
- The FlexVault CLI tool is installed on your computer (see Install FlexVault). If it's incompatible with this plugin version, the plugin reports the required range when you try to use it.
- Your Unreal project directory is placed inside an initialized FlexVault workspace.
- A valid user is logged into the workspace via
fxv login <username>from a terminal. - Ideally, you have not taken a snapshot of the project yet. The plugin adds Unreal Engine's generated folders to
.fxvignore, and those rules only apply to files FlexVault is not already tracking. If you have already published the project, see Files that are already tracked.
Your project must be able to build when compiling from source
If you cannot build your project, you cannot build FlexVault from source. While hosted repositories for multi-person teams can distribute precompiled binaries and Fab provides prebuilt engine installations, solo projects and local setups installing from source must be able to build the project locally.
Install the plugin in your project¶
If your engineering lead or technical team already committed the plugin or its precompiled binaries to your project repository, you can skip this section and go straight to Enable and configure Revision Control.
Method 1: Install from Fab¶
The plugin is listed on Fab.
-
Acquire the plugin from the FlexVault listing on Fab.
-
In the Epic Games Launcher, go to your library and install the plugin to Unreal Engine 5.8.
-
Open your project in Unreal Editor and proceed to Enable and configure Revision Control.
Method 2: Install from source (GitHub Releases)¶
For projects installing the plugin directly from source:
-
Download the latest source archive
FlexVaultSourceControl.zipfrom GitHub Releases (or download a pinned version release archive). -
Navigate to your Unreal project root directory (the folder containing your
.uprojectfile). -
Create a
Pluginsfolder if one does not already exist. -
Extract the archive so that the plugin resides at
Plugins/FlexVaultSourceControl/: -
Build your project outside of Unreal Editor. Open the project solution in your C++ IDE (such as Visual Studio), or right-click your
.uprojectfile and select Generate Visual Studio project files, then build the project. You must build after placing the plugin in thePlugins/folder and before launching Unreal; if you launch Unreal Editor before compiling, Unreal will show an error that modules need to be rebuilt and will not let you open the project. -
Once the build completes, open your project in Unreal Editor.
Enable and configure Revision Control¶
After the plugin files are in place:
- Open your project in Unreal Editor.
- Go to Edit > Plugins, search for FlexVault, and verify that the plugin checkbox is enabled.
- In the lower-right corner of the Unreal Editor status bar, click the Revision Control button (or select Tools > Connect to Revision Control).
- In the Provider dropdown, choose FlexVault.
- Click Accept Settings.
A notification confirms successful connection to your FlexVault workspace.
How to work with your assets¶
Asset status badges in Content Browser¶
The Content Browser displays status icons on your asset thumbnails and in list views:
- Uncontrolled / Added: New assets created locally that are ready to be saved into your next revision.
- Checked Out: Assets you have modified locally.
- Normal / Current: Assets that match the latest synchronized state of the workspace.
Saving your local work (Snapshots)¶
A snapshot saves your current progress locally as a draft checkpoint on your machine. Your teammates do not see these snapshots until you submit your changes.
You do not need to trigger snapshots manually. The plugin takes them automatically after high-entropy operations (such as asset deletions, large level edits, or bulk reimports) and periodically in the background while you have pending changes.
Submitting changes¶
To commit your modified assets to your branch:
- In the Content Browser, right-click an asset or folder, or click the Revision Control menu in the editor toolbar.
- Select Check In Content (or Submit Content).
- In the dialogue, review the list of modified, added, or deleted files.
- Enter a descriptive changelist message explaining your changes.
- Click Submit.
The plugin saves your changes and updates the workspace revision.
Reverting changes¶
If you made modifications to an asset that you want to discard:
- Right-click the modified asset in the Content Browser.
- Choose Revision Control > Revert.
- Confirm the prompt.
The asset resets immediately back to its state from the current revision.
Diffing assets against depot¶
To visually compare your local modified asset with its base depot revision:
- Right-click the modified asset in the Content Browser.
- Choose Revision Control > Diff Against Depot.
- Unreal Editor opens its visual diff tool comparing your working copy against the published revision fetched via
fxv cat.
Viewing history and revisions¶
You can inspect version history for individual assets or for the entire repository.
Asset history¶
To inspect the history of an individual asset:
- Right-click the asset in the Content Browser.
- Select Revision Control > History.
- The history dialog displays past revisions, authors, dates, and changelist descriptions for that asset.
Repository history (FlexVault History window)¶
The FlexVault History window provides a repository-wide commit visualizer and inspection tool.
To open the window:
- In the Unreal Editor main menu, select Tools > FlexVault History.
- The tab opens as a dockable panel that you can place anywhere in your editor layout.
The top toolbar provides filtering and navigation controls:
- Branch: Switch branches using the dropdown to inspect commit history on any branch in the repository.
- Search: Filter commits in real time by revision, author, or description.
- Refresh: Reload branches, commit records, and workspace status. The tab also refreshes automatically when your workspace HEAD changes.
The commits table displays:
- Current HEAD: Marked in green bold text to identify your active workspace revision.
- Drafts: Local unpublished draft revisions appear in subdued gray text.
- Disabled rows: Appear in muted red text when a revision has code changes that cannot be safely synced while the editor is open. This protects your content from crashes and missing assets caused by binary mismatches.
Inspecting changed files and diffing¶
Selecting a commit in the upper list populates the lower pane with every file modified, added, or deleted in that revision.
Right-click a file in the list to access file actions:
- Diff Against Workspace Version: Compares the historical file directly against your current workspace version. For Unreal assets (
.uassetand.umap), Unreal Editor opens its visual asset diff tool. For source code and configuration files, the plugin opens your configured external text diff tool. Double-clicking any file also opens this diff. - Diff Against Previous Revision: Compares the file in the selected commit against its state in the preceding revision.
- Browse to Asset: For asset files, navigates directly to the asset in the Content Browser.
- Open in External Editor: For non-asset files, opens the historical version in your default external application or editor.
- Copy Relative Path: Copies the relative workspace path of the file to your clipboard.
Syncing to a revision from history¶
You can sync your entire workspace to any revision directly from the FlexVault History window:
- Right-click a commit in the list.
- Select Sync Workspace to Revision '
' . - Review the confirmation prompt. Uncommitted local modifications are protected by an automatic draft snapshot before sync starts.
- When the sync finishes, the plugin reloads modified in-memory packages in the editor.
Content protection and binary mismatches¶
Syncing inside Unreal Editor works smoothly for regular content updates such as textures, levels, materials, and blueprints. When a revision includes code changes, syncing while the editor is open can lead to editor crashes or missing classes if the running editor does not have matching compiled binaries.
To protect your project from binary mismatches:
- Non-engineering workflows (precompiled binaries): If you work on art, design, or audio and do not compile code on your computer, in-editor sync is disabled for revisions with code changes. To update safely, close Unreal Editor and pull the update through your team's launcher (such as UnrealGameSync or your build tool) or the command line, where matching binaries are downloaded along with project content.
- Engineering workflows (local compiler available): If you have a local compiler or Live Coding enabled, the plugin displays a prompt listing modified code files before syncing. After the sync finishes, a notification provides a Live Compile button to patch changes into the running editor.
Getting updates from teammates (Sync)¶
To synchronize your workspace with the latest published team revisions:
- In the Unreal Editor toolbar or status bar, open the Revision Control menu.
- Select Sync (or Sync Latest).
- The plugin pulls incoming changes via
fxv syncand updates project assets in the editor.
Handling conflicts¶
If an asset was modified concurrently on remote and locally:
- The asset displays a conflict status in Unreal Editor.
- When resolving, the plugin applies your configured Conflict Resolution Preference (
mineto keep local changes, ortheirsto accept the published remote version).
Plugin configuration options¶
You can fine-tune plugin behavior in Unreal Editor under Edit > Project Settings > Plugins > FlexVault Source Control.
Updating the plugin¶
If you installed the plugin through Fab, update it directly through the Epic Games Launcher.
If you installed the plugin from source:
- Close Unreal Editor.
- Download the latest
FlexVaultSourceControl.ziparchive from GitHub Releases. - Replace the existing
Plugins/FlexVaultSourceControl/folder with the contents of the new archive. - Build your project in your IDE outside of Unreal Editor to compile the updated plugin.
- Reopen your project in Unreal Editor.
Watch the announcements channel on the FlexVault Discord for new plugin and CLI release notices.