You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,19 +3,19 @@
3
3
A basic MIT licensed Mercurial source control plugin for Unreal Engine 4.
4
4
5
5
##Overview
6
-
-------------
6
+
7
7
The Unreal Editor has built-in visual diffing for Blueprint assets, this feature relies on a **Source Control Provider** plugin to interface with the repository your assets are stored in. Currently UE4 ships with built-in source control provider plugins for SVN and Perforce. This source control provider plugin allows the Unreal Editor to interact with a Mercurial repository, thus unlocking all the built-in asset diffing goodness for those of us who prefer to use Mercurial.
8
8
9
9
##Supported Operating Systems
10
-
----------------------------------
10
+
11
11
The plugin should work on any OS the Unreal Editor can run on, however, I do all my development on Windows so if something isn't working right on another OS please let me know how to fix it :).
12
12
13
13
##Branches
14
-
----------
14
+
15
15
The **master** branch should be compatible with the latest binary release of UE4, I will be creating another branch to stay up to date with the **UE4 master** branch.
16
16
17
17
##Installation
18
-
------------
18
+
19
19
###Prerequisites
20
20
You need Mercurial installed on your system, preferably a standalone version that doesn't rely on Python (though that may work too, I just haven't tried). On Windows I'd recommend installing [TortoiseHg](http://tortoisehg.bitbucket.org/), the plugin will then auto-detect the location of the relevant Mercurial executable.
21
21
@@ -49,7 +49,7 @@ Then follow these steps on Windows (adjust as needed on other OSes):
49
49
2. Open the generated Visual Studio solution file (e.g. **MyProject.sln**) and build it.
50
50
3. Launch the Unreal Editor, open the project you've just built, and follow the instructions in the next section.
51
51
52
-
*Note that your existing project must have a **Source** subdirectory with a couple of **.Target.cs** files in it, if it doesn't you may need to follow the steps in the **Building from Scratch** section below and then copy the built plugin into your project(s).*
52
+
Note that your existing project must have a **Source** subdirectory with a couple of **.Target.cs** files in it, if it doesn't you may need to follow the steps in the **Building from Scratch** section below and then copy the built plugin into your project(s).
53
53
54
54
###Editor Configuration
55
55
Once you've got a binary version of the plugin (either by building or downloading) follow these steps:
@@ -62,8 +62,8 @@ Once you've got a binary version of the plugin (either by building or downloadin
62
62
6. If you installed [TortoiseHg](http://tortoisehg.bitbucket.org/) the **Mercurial Executable** should've been auto-detected, otherwise you need to specify the location of the Mercurial executable (hg.exe on Windows, may be just hg elsewhere).
63
63
7. Press the **Accept Settings** button to enable the Mercurial source control provider.
64
64
65
-
Building from Scratch
66
-
-------------------------
65
+
##Building from Scratch
66
+
67
67
The following steps explain how to build the plugin as part of a new (mostly) empty project, in case you hit any issues while attempting to build it as part of an existing project, or as an engine plugin.
68
68
69
69
1. Create a new **Basic Code (C++)** project from the UE4 editor, e.g. **MyProject**, close the editor.
0 commit comments