You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
3dbae5f3b4
Capitalized 'NVIDIA' to conform to their trademark standard. #UE4doc [CL 3077657 by Robert Gervais in Main branch]
237 lines
6.0 KiB
Plaintext
237 lines
6.0 KiB
Plaintext
Availability:Public
|
|
Title:Building Unreal Engine from Source
|
|
Crumbs: %ROOT%, Programming, Programming/Development
|
|
Description:Compiling Unreal Engine from source.
|
|
Prereq: GettingStarted/DownloadingUnrealEngine
|
|
Related: GettingStarted
|
|
Related: Engine/Content/QuickStart
|
|
Related: Programming/QuickStart
|
|
Related: Engine/QuickStart
|
|
Related: Support/Builds
|
|
Version: 4.11
|
|
SkillLevel: Advanced
|
|
|
|
%Globals:osselect_linux%
|
|
|
|
[TOC (start:2 end:3)]
|
|
|
|
## Building Unreal Engine from Source
|
|
|
|
[EXCERPT:Main]
|
|
[OBJECT:ToggleButtonContent]
|
|
[PARAMLITERAL:category]
|
|
OS
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:id]
|
|
windows
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:active]
|
|
active_button_content
|
|
[/PARAMLITERAL]
|
|
[PARAM:content]
|
|
[INCLUDE:#windowscompile]
|
|
[/PARAM]
|
|
[/OBJECT]
|
|
[OBJECT:ToggleButtonContent]
|
|
[PARAMLITERAL:category]
|
|
OS
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:id]
|
|
mac
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:active]
|
|
[/PARAMLITERAL]
|
|
[PARAM:content]
|
|
[INCLUDE:#maccompile]
|
|
[/PARAM]
|
|
[/OBJECT]
|
|
[OBJECT:ToggleButtonContent]
|
|
[PARAMLITERAL:category]
|
|
OS
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:id]
|
|
linux
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:active]
|
|
[/PARAMLITERAL]
|
|
[PARAM:content]
|
|
[INCLUDE:#linuxcompile]
|
|
[/PARAM]
|
|
[/OBJECT]
|
|
|
|
## Running the Editor
|
|
|
|
[OBJECT:ToggleButtonContent]
|
|
[PARAMLITERAL:category]
|
|
OS
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:id]
|
|
windows
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:active]
|
|
active_button_content
|
|
[/PARAMLITERAL]
|
|
[PARAM:content]
|
|
[INCLUDE:#windowsrun]
|
|
[/PARAM]
|
|
[/OBJECT]
|
|
[OBJECT:ToggleButtonContent]
|
|
[PARAMLITERAL:category]
|
|
OS
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:id]
|
|
mac
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:active]
|
|
[/PARAMLITERAL]
|
|
[PARAM:content]
|
|
[INCLUDE:#macrun]
|
|
[/PARAM]
|
|
[/OBJECT]
|
|
[OBJECT:ToggleButtonContent]
|
|
[PARAMLITERAL:category]
|
|
OS
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:id]
|
|
linux
|
|
[/PARAMLITERAL]
|
|
[PARAMLITERAL:active]
|
|
[/PARAMLITERAL]
|
|
[PARAM:content]
|
|
[INCLUDE:#linuxrun]
|
|
[/PARAM]
|
|
[/OBJECT]
|
|
|
|
<!--
|
|
[EXCERPT:windowscompile]
|
|
|
|
Make sure that Microsoft Visual Studio 2015 is installed prior to building Unreal Engine from source. Also, depending on your system's specifications, it may take between 10 and 40 minutes to compile the engine.
|
|
|
|
1. Inside the root directory, run **GenerateProjectFiles.bat** to set-up your project files.
|
|
|
|
[REGION:warning]
|
|
All project files are intermediate (`[UE4Root]\Engine\Intermediate\ProjectFiles`). You must generate project files each time you sync a new build to ensure they are up to date. If you delete your `Intermediate` folder, you must regenerate project files using the 'GenerateProjectFiles' batch file.
|
|
[/REGION]
|
|
|
|
1. Load the project into Visual Studio by **Double-clicking UE4.sln**.
|
|
|
|
1. Set your solution configuration to **Development Editor**.
|
|
|
|
|
|
|
|
1. Set your solution platform to **Win64**.
|
|
|
|
|
|
|
|
1. **Right-click** the UE4 target and select **Build**.
|
|
|
|
|
|
|
|
[/EXCERPT:windowscompile]
|
|
|
|
[EXCERPT:maccompile]
|
|
|
|
Make sure that the latest version of XCode is installed prior to building Unreal Engine from Source. Also, depending on your system's specifications, it may take between 10 and 40 minutes to compile the engine.
|
|
|
|
1. Inside the root directory, run **GenerateProjectFiles.command** to set-up your project files.
|
|
|
|
1. Load the project into XCode by **Double-clicking UE4.xcodeproj**.
|
|
|
|
1. To set your build target, select **UE4Editor - Mac** for **My Mac** in the title bar.
|
|
|
|
|
|
|
|
1. To build the project, select **Product > Build**.
|
|
|
|
|
|
|
|
[/EXCERPT:maccompile]
|
|
|
|
[EXCERPT:linuxcompile]
|
|
|
|
[REGION:note]
|
|
Our development and support teams currently use the latest version of Ubuntu; as a result, we may not be able to provide support for other Linux distributions (including other versions of Ubuntu). Also, depending on your system's specifications, it may take anywhere from ten minutes to over an hour to compile the engine.
|
|
[/REGION]
|
|
|
|
1. Inside the root directory, run **Setup.sh** from the terminal to setup the files needed to generate the project files.
|
|
|
|
|
|
|
|
1. Now, run **GenerateProjectFiles.sh** from the terminal to generate your project files.
|
|
|
|
|
|
|
|
1. To build the project, run **make** from the terminal.
|
|
|
|
|
|
|
|
[/EXCERPT:linuxcompile]
|
|
-->
|
|
|
|
<!--
|
|
[EXCERPT:windowsrun]
|
|
|
|
1. Set your startup project to **UE4**.
|
|
|
|
|
|
|
|
1. **Right-click** the **UE4** project, **hover over 'Debug'** and **click 'Start New Instance'** to launch the editor.
|
|
|
|
|
|
|
|
[REGION:tip]
|
|
Alternatively, you can **press the F5 key** on your keyboard to start a new instance of the editor.
|
|
[/REGION]
|
|
|
|
1. Congratulations! You've compiled and launched the engine from source.
|
|
|
|
|
|
|
|
[/EXCERPT:windowsrun]
|
|
|
|
[EXCERPT:macrun]
|
|
|
|
1. Select **Product > Run** to launch the editor.
|
|
|
|
|
|
|
|
1. Congratulations! You've compiled and launched the engine from source.
|
|
|
|
|
|
[/EXCERPT:macrun]
|
|
|
|
[EXCERPT:linuxrun]
|
|
|
|
[REGION:note]
|
|
If you're unable to create an OpenGL context as you're working through these steps, you may need to update your graphics drivers (refer to Ubuntu's documentation<!-- and our list of [](Platforms/Linux/BeginnerLinuxDeveloper/SupportedGfxDrivers) -->).
|
|
For an optimal experience, we recommend using NVIDIA binary drivers (versions equal to or greater than 343.xx).
|
|
[/REGION]
|
|
|
|
1. Navigate to the editor's binary path by entering `cd Engine/Binaries/Linux/` into the terminal.
|
|
|
|
1. Run **UE4Editor** to launch the editor.
|
|
|
|
|
|
|
|
1. Congratulations! You've compiled and launched the engine from source.
|
|
|
|
|
|
[/EXCERPT:linuxrun]
|
|
-->
|
|
|
|
## Getting Started with Unreal Engine
|
|
|
|
Learn how to use Unreal Engine by referring to the [](GettingStarted) documentation!
|
|
|
|
If you're looking to quickly get started with UE4, refer to the following tutorials:
|
|
* [](Engine/Content/QuickStart)
|
|
* [](Programming/QuickStart)
|
|
* [](Engine/QuickStart)
|
|
|
|
|
|
[REGION:note]
|
|
UE4's in-editor help features are a great way to get your questions answered.
|
|
[/REGION]
|
|
|
|
[/EXCERPT:Main]
|