aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChance Ivey <[email protected]>2020-06-12 12:30:43 -0400
committerGitHub <[email protected]>2020-06-12 12:30:43 -0400
commit4dc649c7bf4bda063121c820c335b9d6bd1f5d18 (patch)
treea3a05a46de9b62f146cac60976e90e4d88b21552
parentInitial commit (diff)
downloadugcexample-4dc649c7bf4bda063121c820c335b9d6bd1f5d18.tar.xz
ugcexample-4dc649c7bf4bda063121c820c335b9d6bd1f5d18.zip
Update README.md
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1da7c5f..83e4537 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,11 @@
-# UGCExample \ No newline at end of file
+# UGCExample
+The **UGC** (user-generated content) **Example** project is a custom plugin and build scripts created to facilitate adding mod support to **Unreal Engine 4** titles.
+
+Loosely based on the work done for Robo Recall, It includes:
+
+- A runtime game module for game integration
+- An editor module for new toolbar buttons and commands
+- An automation tool project for packaging mods
+- An example UE4 project demonstrating all aspects working together.
+
+Follow the [**Quick Start Guide**](QuickStart.md) for a comprehensive look at the UGC Example project and for instructions to add mod support to your own projects.