UEPlasticPlugin | Plastic SCM Plugin for Unreal Engine | Code Editor library

Why?: Why is it integrated, as opposed to, eg. being shared through the Marketplace?. It helps with discoverability of the plugin, and it is the easiest way to get started with Plastic SCM in Unreal Engine. But it will always be lagging somewhat behind the latest release in Github. Why?: Why would you update to latest version in Github?. If you want the latest features, performance improvements and bug fixes that are missing from Unreal integrated plugin. Why?: Why would you build from sources? It enable you to test features before they are released, debug issues, and contribute. It's required if you have your own fork of Unreal Engine. If your project is already a C++ project, you only have to re-generate Visual Studio project files (step 4 below) and the plugin will get rebuilt the next time you compile your project.
UE4.24 to 4.27 shipped with an old version 1.4.6 of this plugin
UE5.0 shipped with the same outdated version 1.4.6, not performing well overall with UE5, especially on OFPA
UE5.1 shipped with the version 1.6.2 of the plugin with support for the new View Changelists window
UE5.2 is going to ship with the version 1.8.0 of the plugin with support for the Shelves in the renamed View Changes window
Download the latest binary release UE5PlasticPlugin-x.x.x.zip targeting your UE5 version (resp UE4).
Either: Unzip the content of the ZIP directly at the root of your project folder. This creates a "Plugins\UEPlasticPlugin" subdirectory into your project. This is the way to go to use Plastic SCM on a specific project, and to share the plugin with other team members by adding it to source control. Some users reported they also had to remove the integrated plugin from "Engine\Plugins\Developer\PlasticSourceControl" to avoid a collision. This is only needed for some specific use case I have not yet identified (eg. on CI/CD, or on Unix OSes). Unzip the content of the ZIP in the Engine\ directory of UEX.Y directly for all your projects (for instance "C:\Program Files\Epic Games\5.1\Engine") This creates a "UEPlasticPlugin" folder into the "Plugins" subdirectory. Then remove the integrated plugin from "Engine\Plugins\Developer\PlasticSourceControl" to avoid the collision. This is the way to enable Plastic SCM for all Unreal Engine projects on the machine.
Then, launch your Unreal project, click on the Source Control icon "Connect to Source", select "Plastic SCM".
You need Visual Studio 2015 or 2017 with C++ language support (free Community Edition is fine).
Launch the Unreal Engine Editor, create a new C++ Basic Code Project (No Starter Content), for instance UnrealPlasticSCM. This should launch Visual Studio, build the game project, and open it into the Editor.
Close the Editor, then using the file explorer, create a new Plugins directory at the root of your project.
Clone the source code of the plugin into this Plugins directory (for instance Plugins\UEPlasticPlugin).
Right-click on your project's .uproject file, Generate Visual Studio project files.
In Visual Studio, Reload All and Build Solution in Development Editor mode. That's it, the plugin is built (resulting dlls are located in Plugins\UEPlasticPlugin\Binaries\Win64).
Start by saving your connection credentials with the Plastic SCM GUI. Launch you Unreal project, look at the Source Control menu at the bottom-right. Launch you Unreal project, click on the Source Control icon "Connect to Source". Then select "Plastic SCM" plugin.
BinaryPath: Path to the Plastic SCM Command Line tool 'cm' binary. Default is good if the cli is in the PATH. Can be changed to an absolute path to the cm executable if needed.
UpdateStatusAtStartup: Triggers an asynchronous "Update Status" operation at Editor startup. Can take quite some time on big projects, with no source control status available in the meantime.
UpdateStatusOtherBranches: Enable Update status to detect more recent changes on other branches in order to display the "Changed In Other Branch" warnings and icon.
EnableVerboseLogs: Override LogSourceControl default verbosity level to Verbose (except if already set to VeryVerbose).
Should Delete New Files on Revert (true by default) If enabled, when you revert a file that was added to the project, it will be deleted from disk instead of being left untracked (Private). This is the expected behavior when shelving files and reverting the local changes.
Enable Uncontrolled Changelists (true by default)
User Name to Display Name For each entry in this dictionary, the Editor will replace the user name in the key with the display value you specify.
Hide Email Domain in Username (true by default) This setting toggles the visibility of domain names in user names, if the user name is an email.
Prompt for Checkout on Change (true by default) Un-checking this setting will make the Editor consider all files as already checked out. In that case, you won't get any notifications when you modify assets, and the "Checkout Assets" dialog won't show when you save those changes. This mimics how Git works, i.e. allowing the user to perform changes without worrying about checking out items. Note: Changelists don't currently support locally changed assets (ie not checked-out)
Limit Number Of Revisions in History (50 by default) If a non-null value is set, limit the maximum number of revisions requested to Plastic SCM to display in the "History" window. Requires Plastic SCM 11.0.16.7608 that added support for history --limit
Tools for diffing text Configure the external diff tool needed to compare revisions of assets that are not Blueprints (eg Materials)
Prompt for Checkout on Asset Modification Trigger a notification "N files need Checkout" with a link to checkout the asset(s) as soon as a change is made to an asset (without even saving it).
Automatically Checkout on Asset Modification Checkout an asset as soon as a change is made to it (without even saving it). Will not show the "checkout" notification.
Add New Files when Modified Automatically add "private" assets to source control when saving them.
Use Global Settings Share the Source Control Settings ini files between all projects.
The plugin works with the command line interface "cm" that currently requires your credentials to be stored. Use the Plastic SCM or Gluon GUI to enter and save your credentials before enabling Plastic SCM in Unreal. Binary assets should be locked for exclusive access to avoid merge conflicts.