View on GitHub

UE4PlasticPlugin

Unreal Engine 4.16 Plastic SCM Plugin

Unreal Engine 4 Plastic SCM Source Control Plugin

release Join the chat at https://gitter.im/SRombauts/UE4PlasticPlugin

UE4PlasticPlugin is a simple Plastic SCM Source Control Plugin for Unreal Engine 4 (UE 4.11 to 4.16)

It is not intended to replace Plastic SCM GUI or command line interface “cm”. It is a complementary tool improving efficiency in your daily workflow.

It automates tracking of assets, brings common SCM tasks inside the Editor, and provides visual diffing of Blueprints. It also helps importing an existing UE4 Project into source contorl, with appropriate ignore.conf file.

Source Control Login screen to create a new workspace/a new repository :

History menu entry to look a the changelog of an asset :

Visual Diffing of different revision of a Blueprint :

References

Quick setup from binary release

  1. Download the latest binary release UE4PlasticPlugin-x.x.x.zip targeting your UE4 version.
  2. Either:
    1. Unzip the content of the ZIP in the root of the Unreal Engine 4.x project folder. That should create a “Plugins/” folder into your project. This is the way to go to use Platic SCM only on a specific projetc.
    2. Unzip the content of the ZIP in the Engine/ directory of UE4.x directly for all your projects (for instance “C:\Program Files\Epic Games\4.16\Engine") That should create a “UE4PlasticPlugin” forlder into the “Plugins/” subidrectory. This is the way to enable Plastic SCM for all Unreal Engine projects.
  3. Then, launch Unreal Engine 4.x, click on the Source Control icon “Connect to Source”, select “Plastic SCM”.

How to build from sources

If your project is already a C++ project, you only have to re-generate Visual Studio projet files (step 4 bellow) and the plugin will get rebuild the next time you compile your project.

Else, if you want to rebuild the plugin for a Blueprint project:

  1. You need Visual Studio 2015 or 2017 with C++ language support (free Community Edition is fine).
  2. Launch the Unreal Engine 4 Editor, create a new C++ Basic Code Project (No Starter Content), for instance UE4PlasticSCM. This should launch Visual Studio, build the game project, and open it into the Editor.
  3. Close the Editor, then using the file explorer, create a new Plugins directory at the root of your project.
  4. Clone the source code of the plugin into this Plugins directory (for instance Plugins\UE4PlasticPlugin).
  5. Right-click on your project’s .uproject file, Generate Visual Studio project files.
  6. 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\UE4PlasticPlugin\Binaries\Win64).

To release the plugin, zip the Plugins folder. But before that, remove the Intermediate, Screenshots and .git folders, and also the big *.pdb files in Plugins\UE4PlasticPlugin\Binaries\Win64.

Status

Version 1.0.3 2017/07/09 for UE4.16 :

Feature Requests

Known issues

Features reserved for internal use by Epic Games with Perforce only

Support

You can always ask questions in Unreal Engine forums.

Report an issue

To report an issue, please use the Github issue-tracker.

  1. Have a look at existing issues (Open and Closed ones)
  2. Specify your Engine & Plugin versions, and if either are built from sources
  3. Describe precisely your issue
  4. Add reproduction steps, if possible on a basic template project
  5. Post a Log file when applicable (or the corresponding redacted section)
    1. enable UTC Timestamp in Logs : menu Preferences -> General -> Appearance -> Log Timestamp Mode
    2. Grab the file ProjectName/Saved/Logs/ProjectName.log

Use merge requests

If you want to help, Merge Requests are very welcome!

Copyright (c) 2016-2017 Codice Software - Sébastien Rombauts (sebastien.rombauts@gmail.com)