aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorChance Ivey <[email protected]>2020-06-24 10:02:44 -0700
committerChance Ivey <[email protected]>2020-06-24 10:02:44 -0700
commitdaed45f596f7bdf4b2c712f73b6a2ee07bfb0193 (patch)
tree7eb1dd16ec06a8aff44ea31c11aa5f600e1a063c /Documentation
parentAdded step for building project in Development confituration. Necessary for U... (diff)
downloadugcexample-daed45f596f7bdf4b2c712f73b6a2ee07bfb0193.tar.xz
ugcexample-daed45f596f7bdf4b2c712f73b6a2ee07bfb0193.zip
Doc updates to directory requirements for game and automation projects
Diffstat (limited to 'Documentation')
-rwxr-xr-xDocumentation/Images/AddToUE4ProjectDirs.PNGbin16798 -> 19971 bytes
-rw-r--r--Documentation/Images/PathToProject.PNGbin0 -> 8463 bytes
-rw-r--r--Documentation/QuickStart.md11
3 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/Images/AddToUE4ProjectDirs.PNG b/Documentation/Images/AddToUE4ProjectDirs.PNG
index a564064..cc3954b 100755
--- a/Documentation/Images/AddToUE4ProjectDirs.PNG
+++ b/Documentation/Images/AddToUE4ProjectDirs.PNG
Binary files differ
diff --git a/Documentation/Images/PathToProject.PNG b/Documentation/Images/PathToProject.PNG
new file mode 100644
index 0000000..d0ec7ca
--- /dev/null
+++ b/Documentation/Images/PathToProject.PNG
Binary files differ
diff --git a/Documentation/QuickStart.md b/Documentation/QuickStart.md
index 35b918d..b85ce0f 100644
--- a/Documentation/QuickStart.md
+++ b/Documentation/QuickStart.md
@@ -9,14 +9,16 @@ To follow along with this overview, you’ll need the following installed on you
### Building the UGC Example Project
Before opening the UGC Example project, follow these steps to ensure everything is generated and built for the project:
-1. In your UE4 root directory, open **UE4Games.uprojectdirs** in your favorite text editor and add the directory where you've saved the **UGCExample project** at the end of the file. Save this file.
+1. Place the UGCExample project in a directory under your UE4 root directory (such as /Games or /Projects) and add the directory to **UE4Games.uprojectdirs** using your favorite text editor. Save this file.
+
+![image](/Documentation/Images/PathToProject.PNG)
![image](/Documentation/Images/UE4ProjectDirsFile.PNG)
![image](/Documentation/Images/AddToUE4ProjectDirs.PNG)
2. Run **GenerateProjectFiles.bat** in your UE4 root directory.
-3. Open the **Visual Studio solution**, UE4.sln.
+3. Open **UE4.sln**.
4. Verify that the build scripts are listed in the **Programs/Automation** directory
![image](/Documentation/Images/image13.png)
@@ -176,9 +178,10 @@ Alternatively, you can refactor the names in these build scripts to match your p
Take these steps for your project (just like above):
-1. In your UE4 root directory, open **UE4Games.uprojectdirs** and add the directory where **your project** lives at the end of the file. Save this file.
+1. Place your project in a directory under your UE4 root directory (such as /Games or /Projects) and add the directory to **UE4Games.uprojectdirs** using your favorite text editor. Save this file.
+NOTE: If you cannot move your project's location for one reason or another, skip this step and move the SimpleUGC.Automation project and scripts to your Engine directory as oulined in the [Adding Automation Projects documentation](https://docs.unrealengine.com/en-US/Programming/BuildTools/AutomationTool/HowTo/AddingAutomationProjects/index.html).
2. Run **GenerateProjectFiles.bat** in your UE4 root directory.
-3. Open the **Visual Studio solution**, UE4.sln.
+3. Open the **Visual Studio solution**.
4. Verify that the build scripts are listed in the **Programs/Automation** directory
5. **Build** the **AutomationTool** project.
6. **Build** the **your project** in the **Development** configuration.