Koenrad

UE4 From Source

Sep 3rd, 2014
428
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 8.87 KB | None | 0 0
  1. Welcome to the UE 4.4 source code!
  2. ==================================
  3.  
  4. This is the source code page for the **Unreal Engine on GitHub**. With the UE4 source code, you can modify the
  5. engine and tools in any way imaginable and share your changes with others!
  6.  
  7. You can build the editor for Windows and Mac, and compile games for Android, iOS, Playstation 4, Xbox
  8. One, HTML5 and Linux. Source code for all tools is included as well, such as Unreal Lightmass and Unreal Frontend.
  9.  
  10. Before continuing, check out this [wiki page](https://wiki.unrealengine.com/GitHub_Setup) about getting started
  11. with the engine code. We also have a [programming guide](https://docs.unrealengine.com/latest/INT/Programming/index.html) and
  12. full [API documentation](https://docs.unrealengine.com/latest/INT/API/index.html).
  13.  
  14. We also have a forum section where you can discuss [engine source and GitHub](https://forums.unrealengine.com/forumdisplay.php?1-Development-Discussion).
  15. Have fun - we can't wait to see what you create!
  16.  
  17. Source releases
  18. ---------------
  19.  
  20. This branch contains source code for the **4.4 release**. You'll need to download dependency files per the instructions below in order to build and run the engine.
  21.  
  22. We're also publishing bleeding edge changes from our engine team in the [master branch](https://github.com/EpicGames/UnrealEngine/tree/master) on GitHub. Here you can
  23. see [live commits](https://github.com/EpicGames/UnrealEngine/commits/master) from Epic programmers along with integrated code submissions from the community. This branch is
  24. unstable and may not even compile, though we periodically tag [preview releases](https://github.com/EpicGames/UnrealEngine/releases/tag/latest-preview) which
  25. receive basic testing and have matching dependencies attached.
  26.  
  27. We recommend you work with a versioned release such as this one. The master branch contains unstable and possibly untested code,
  28. but it should be a great reference for new developments, or for spot merging bug fixes. Use it at your own risk.
  29.  
  30.  
  31.  
  32.  
  33. Getting up and running
  34. ----------------------
  35.  
  36. Here is the fun part! This is a quick start guide to getting up and running with the source. The steps below will take you through cloning your own private fork, then compiling and
  37. running the editor yourself on Windows or Mac. Oh, and you might want to watch our [short tutorial video](http://youtu.be/usjlNHPn-jo)
  38. first. Okay, here we go!
  39.  
  40. 1. We recommend using Git in order to participate in the community, but you can **download the source** as a zip file if you prefer. See instructions for
  41. [setting up Git](http://help.github.com/articles/set-up-git), then [fork our repository](https://help.github.com/articles/fork-a-repo), clone it to your local
  42. machine, and switch to the 4.4 branch:
  43.  
  44. ```
  45. git checkout 4.4
  46. ```
  47.  
  48. 1. You should now have an _UnrealEngine_ folder on your computer. All of the source and dependencies will go into this folder. The folder name might
  49. have a branch suffix (such as _UnrealEngine-4.4_), but that's fine.
  50.  
  51. 1. Download the **required dependencies**:
  52. [Required_1of2.zip](https://github.com/EpicGames/UnrealEngine/releases/download/4.4.0-release/Required_1of2.zip) and
  53. [Required_2of2.zip](https://github.com/EpicGames/UnrealEngine/releases/download/4.4.0-release/Required_2of2.zip).
  54.  
  55. 1. Unzip the dependencies into the _UnrealEngine_ folder alongside the source. Be careful to make sure the folders are merged together
  56. correctly. On Mac, we recommend **Option + dragging** the unzipped files into the _UnrealEngine_ folder, then selecting **Keep Newer** if prompted.
  57.  
  58. 1. Okay, platform stuff comes next. Depending on whether you are on Windows or Mac, follow one of the sections below:
  59.  
  60.  
  61. ### Windows
  62.  
  63. 1. Be sure to have [Visual Studio 2013](http://www.microsoft.com/en-us/download/details.aspx?id=40787) installed. You can use any
  64. desktop version of Visual Studio 2013, including the free version: [Visual Studio 2013 Express for Windows Desktop](http://www.microsoft.com/en-us/download/details.aspx?id=40787)
  65.  
  66. 1. Make sure you have [June 2010 DirectX runtime](http://www.microsoft.com/en-us/download/details.aspx?id=8109) installed. You don't need the SDK, just the runtime.
  67.  
  68. 1. You'll need project files in order to compile. In the _UnrealEngine_ folder, double-click on **GenerateProjectFiles.bat**. It should take less than a minute to complete. On Windows 8, a warning from SmartScreen may appear. Click "More info", then "Run anyway" to continue.
  69.  
  70. 1. Load the project into Visual Studio by double-clicking on the **UE4.sln** file.
  71.  
  72. 1. It's time to **compile the editor**! In Visual Studio, make sure your solution configuration is set to **Development Editor**, and your solution
  73. platform is set to **Win64**. Right click on the **UE4** target and select **Build**. It will take between 15 and 40 minutes to finish compiling,
  74. depending on your system specs.
  75.  
  76. 1. After compiling finishes, you can **load the editor** from Visual Studio by setting your startup project to **UE4** and pressing **F5** to debug.
  77.  
  78. 1. One last thing. You'll want to setup your Windows shell so that you can interact with .uproject files. Find the file named **UnrealVersionSelector-Win64-Shippping.exe** in
  79. the _UnrealEngine/Engine/Binaries/Win64/_ folder and run it. Now, you'll be able to double-click .uproject files to load the project, or right click them to quickly update Visual Studio files.
  80.  
  81.  
  82.  
  83. ### Mac
  84.  
  85. 1. Be sure to have [Xcode 5.1](https://itunes.apple.com/us/app/xcode/id497799835) installed.
  86.  
  87. 1. You'll need project files in order to compile. In the _UnrealEngine_ folder, double-click on **GenerateProjectFiles.command**. It should take less than a minute to complete. You can close the Terminal window afterwards. If you downloaded the source in .zip format, you may see a warning about an unidentified developer. This is because because the .zip files on GitHub are not digitally signed. To work around this, right-click on GenerateProjectFiles.command, select Open, then click the Open button if you are sure you want to open it.
  88.  
  89. 1. Load the project into Xcode by double-clicking on the **UE4.xcodeproj** file.
  90.  
  91. 1. It's time to **compile the editor**! In Xcode, build the **UE4Editor - Mac** target for **My Mac** by selecting it in the target drop down
  92. in the top left, then using **Product** -> **Build For** -> **Running**. It will take between 15 and 40 minutes, depending on your system specs.
  93.  
  94. 1. After compiling finishes, you can **load the editor** from Xcode using the **Product** -> **Run** menu command!
  95.  
  96.  
  97.  
  98. ### Additional target platforms
  99.  
  100. **Android** development currently works best from a PC. See the [Android getting started guide](https://docs.unrealengine.com/latest/INT/Platforms/Android/GettingStarted/).
  101.  
  102. **iOS** programming requires a Mac. Instructions are in the [iOS getting started guide](https://docs.unrealengine.com/latest/INT/Platforms/iOS/GettingStarted/index.html).
  103.  
  104. **HTML5** is supported using Emscripten, and requires the [optional dependencies](https://github.com/EpicGames/UnrealEngine/releases/download/4.4.0-release/Optional.zip) to be unzipped into your _UnrealEngine_ folder. Please see the [HTML5 getting started guide](https://docs.unrealengine.com/latest/INT/Platforms/HTML5/GettingStarted/index.html).
  105.  
  106. **Linux** support requires the [optional dependencies](https://github.com/EpicGames/UnrealEngine/releases/download/4.4.0-release/Optional.zip) to be unzipped into your _UnrealEngine_ folder, and the [cross-compiler toolchain](http://cdn.unrealengine.com/qfe/v3_clang-3.3_ld-2.24_glibc-2.12.2.zip) to be installed. See the [Linux cross-compiling page on the wiki](https://wiki.unrealengine.com/Compiling_For_Linux).
  107.  
  108. **Playstation 4** or **XboxOne** development require additional files that can only be provided after your registered developer status is confirmed by Sony or Microsoft. See [the announcement blog post](https://www.unrealengine.com/blog/playstation-4-and-xbox-one-now-supported) for more information.
  109.  
  110.  
  111.  
  112. Additional Notes
  113. ----------------
  114.  
  115. Visual Studio 2013 and Xcode 5.1 are strongly recommended for development.
  116.  
  117. Legacy support for Visual Studio 2012 can be enabled by unzipping the [optional dependencies](https://github.com/EpicGames/UnrealEngine/releases/download/4.4.0-release/Optional.zip) into your UnrealEngine folder
  118. and changing WindowsPlatform.Compiler to VisualStudio2012 in Engine\Source\Programs\UnrealBuildTool\Windows\UEBuildWindows.cs.
  119.  
  120. The first time you start the editor from a fresh source build, you may experience long load times. This only happens on the first
  121. run as the engine optimizes content for the platform and _fills the derived data cache_.
  122.  
  123. Your private forks of the Unreal Engine code are associated with your GitHub account permissions. Just remember
  124. that if you unsubscribe or switch GitHub user names, you'll need to re-fork and upload your changes from a local copy.
Advertisement
Add Comment
Please, Sign In to add comment