Setting Up Visual Studio for Unreal Engine

Tips, tricks, and techniques for setting up Visual Studio to work with Unreal Engine.

Windows
MacOS
Linux

Unreal Engine (UE) is designed to integrate smoothly with Visual Studio (VS), allowing you to make code changes quickly and easily in your projects and immediately see results upon compilation. Setting up VS to work with UE can help improve efficiency and the overall user experience for developers using UE.

In this document, we will cover the basics for setting up your Unreal Engine-to-Visual Studio workflow. While this document focuses on using the most recent versions of UE and VS, you can look at our Visual Studio Legacy Reference Page for help using older versions of UE and VS.

Before Setting-up your Unreal Engine-to-Visual Studio Workflow

The following table lists which versions of VS are integrated with the binary version of UE.

Unreal Engine Version

Visual Studio Version

4.25 or Later

VS 2019 (Default)

4.22 or Later

VS 2017 / VS 2019

4.15 or Later

VS 2017

4.10 to 4.14

VS 2015

4.2 to 4.9

VS 2013

Run the Unreal Engine Prerequisite Installer

When installing UE from the Epic Launcher–or if you clone it from GitHub–the UE prerequisite installer runs automatically. However, if you install or sync UE from Perforce you will need to manually run the prerequisite installer. You need to do that before running any UE tools you have built locally. This installer is located at [UERootLocation]\Engine\Extras\Redist\en-us] in the code base.

Options for a New Visual Studio Installation

If you are installing VS for the first time, you will want to make sure that you have the following options enabled.

C++ Tools

To add C++ tools to your VS installation, make sure you select Game development with C++ under Workloads, as well as these additional options.

  • C++ profiling tools

  • C++ AddressSanitizer (optional)

  • Windows 10 SDK (10.0.18362 or Newer)

Include the UE Installer

To include the UE installer when installing VS, locate the Summary sidebar on the right, expand Game Development with C++, and under Optional make sure the check box for Unreal Engine installer is enabled.

VS2017_SettingsInstaller.png

Recommended Settings

The following are recommended settings for developers using VS with UE.

If our version of VS looks a little different, it's because we have changed the theme to Dark. You can do this by going to Tools > Options > Environment > General > Color theme.

Increase the Width of Solution Configurations Dropdown Menu

  1. Right-click on the toolbar and select Customize at the bottom of the menu that appears.
    SelectingCustomize.png

  2. Click on the Commands tab and select the Toolbar radio button.
    SelectToolbarRadioButton.png

  3. In the dropdown next to the Toolbar, choose Standard.
    SelectStandard.png

  4. In the Preview list, select the Solution Configurations control (you may need to scroll down) and then click Modify Selection.
    SelectModifySelection.png

  5. Set the Width to 200. Then click OK.
    SetWidth_200.png

  6. Click Close on the Customization . Your toolbar should update immediately.

Add the Solution Platforms Dropdown

  1. Locate the far right button on the Standard toolbar (if you hover the mouse over it, it's labeled Standard Toolbar Options). SetUpVisualStudio-RecommendSettings-SolutionPlatformsStep01.png

  2. Click the dropdown button, choose Add or Remove Buttons, and then click on Solution Platforms to add the menu to the toolbar (this may be enabled by default). SetUpVisualStudio-RecommendSettings-SolutionPlatformsStep02.png

Turn Off the Error List Window

Typically, the Error List window pops up automatically when you have an error in your code. However, when working with UE, the Error List window can display false error information. It's best to disable the Error List window, and use the Output window to see real code errors when working with UE. The following steps show you how to turn off the Error List window.

  1. Close the Error List window if it is open.

  2. From the Tools menu, open the Options dialog.
    SetUpVisualStudio-RecommendSettings-ErrorListOffStep02.png

  3. Select Projects and Solutions and disable Always show Error List if build finishes with error.
    SetUpVisualStudio-RecommendSettings-ErrorListOffStep03.png

  4. Click OK.

Here are some other configuration settings you may find useful:

  • Turn off Show Inactive Blocks. If you don't, many chunks of code may appear grayed out in the text editor. Go to Tools > Options > Text Editor > C/C++ > View to turn off this setting

  • Set Disable External Dependencies Folders to True to hide unneeded folders in the Solution Explorer. Find Disable External Dependencies Folder in Tools > Options > Text Editor > C/C++ > Advanced.

  • Turn off Edit & Continue features, you do not need them.  Go to Tools > Options > Debugging > Edit and Continue.

  • Turn on IntelliSense.

Debugging

For more information about Debug Support, check out the debugging section of our Visual Studio Legacy Page.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback