|
| 1 | +--- |
| 2 | +title: "Install Visual Studio Tools for Unreal Engine" |
| 3 | +description: "Learn how to connect Unreal Engine and Visual Studio. Visual Studio Tools for Unreal Engine offers support for writing and debugging C++ Unreal Engine games." |
| 4 | +ms.date: 08/02/2023 |
| 5 | +ms.prod: visual-studio |
| 6 | +ms.topic: get-started |
| 7 | +author: "TylerMSFT" |
| 8 | +ms.author: "twhitney" |
| 9 | +manager: Markl |
| 10 | +--- |
| 11 | + |
| 12 | +# Install Visual Studio Tools for Unreal Engine |
| 13 | + |
| 14 | +This article helps you install Visual Studio Tools for Unreal Engine. These tools allow you to do the following from within Visual Studio: |
| 15 | +- view Unreal Engine (UE) Blueprints |
| 16 | +- add UE classes |
| 17 | +- view UE logging |
| 18 | +- view and expand UE macros |
| 19 | + |
| 20 | +## Prerequisites |
| 21 | + |
| 22 | +You should have the following installed before you install Visual Studio Tools for Unreal Engine: |
| 23 | + |
| 24 | +- Visual Studio version 17.7 or later. To install, see [Visual Studio downloads](https://visualstudio.microsoft.com/downloads/) |
| 25 | +- Unreal Engine version 4.27 or 5.0 or later. To install, see [Download instructions](https://www.unrealengine.com/download) |
| 26 | + |
| 27 | +## Install Visual Studio Tools for Unreal Engine |
| 28 | + |
| 29 | +This article covers installing two tools for connecting Visual Studio and Unreal Engine: |
| 30 | + |
| 31 | +- **Visual Studio Tools for Unreal Engine** are installed with the Visual Studio installer. They enable you to add UE classes, view UE logging, and more, all from within Visual Studio. |
| 32 | +- **Unreal Engine Visual Studio Integration Tool plugin** is installed in Unreal Engine and works with Visual Studio to display information about Blueprint assets in C++ code. |
| 33 | + |
| 34 | +To install Visual Studio Tools for Unreal Engine, follow these steps: |
| 35 | + |
| 36 | +1. Type "Visual Studio Installer" in the Windows search box. |
| 37 | +1. Look for the installer under the Apps results and double-click it. |
| 38 | +1. When the installer appears, select the version of Visual Studio you are using (if you have multiple versions installed) and then select **Modify**. |
| 39 | +1. Select the **Workloads** tab, then select the **Game development with C++** workload. |
| 40 | +1. In the **Installations details** pane, ensure that under **Game development with C++** > **Optional** that **IDE support for Unreal Engine** is selected. This installs what this article refers to as the Visual Studio Tools for Unreal Engine. If you work with the High-Level Shader Language, ensure that **HLSL Tools** is also selected. |
| 41 | +1. Select the **Individual components** tab at the top of the dialog. |
| 42 | +1. Under **Installation details**, expand **Desktop development with C++**. |
| 43 | +1. Ensure that under **Optional** that **Windows 10 SDK 10.0.18362.0**, or higher, is selected. |
| 44 | +1. Select **Modify** to complete the installation. |
| 45 | + |
| 46 | + :::image type="content" source="../media/unreal-workload.png" alt-text="Screenshot of the game development with C++ workload selected in the installer. In the installation details pane, IDE support for Unreal Engine and HLSL Tools are checked." lightbox="../media/unreal-workload.png"::: |
| 47 | + |
| 48 | +## Configure Unreal Engine to use Visual Studio |
| 49 | + |
| 50 | +Epic Games provides the UnrealVS extension for Visual Studio. The extension makes it easier to build UE projects, set command line arguments, batch build projects, and so on. You don't need to install this plugin to use Visual Studio Tools for Unreal Engine, but it does provide some convenience features. For more information, see [UnrealVS Extension](https://docs.unrealengine.com/using-the-unrealvs-extension-for-unreal-engine-cplusplus-projects/). |
| 51 | + |
| 52 | +Install the Unreal Engine Visual Studio Integration Tool plugin via the [Unreal Engine Marketplace](https://aka.ms/VSUEMarketplace) website. It allows you to see Blueprints assets in Visual Studio. The Unreal Engine Marketplace provides instructions for installing the plugin. |
| 53 | + |
| 54 | + :::image type="content" source="../media/unreal-engine-marketplace.png" alt-text="Screenshot of the Unreal Engine Marketplace with the Visual Studio Integration Tool plugin." lightbox="../media/unreal-engine-marketplace.png"::: |
| 55 | + |
| 56 | +If your project isn't compatible with Unreal Engine Marketplace plugins, install the plugin manually by cloning and installing the plugin from the [GitHub vc-ue-extensions repo](https://aka.ms/VSUEGitHub). See the [README](https://github.com/microsoft/vc-ue-extensions#unreal-engine-plugin-for-visual-studio) in the repo for instructions to install the plugin. If you have difficulty with the UE plugin, see the [Troubleshooting guide](https://github.com/microsoft/vc-ue-extensions/blob/main/Docs/Troubleshooting.md) |
| 57 | + |
| 58 | +For more information about customizations you can make to the Visual Studio IDE to work well with Unreal Engine, see the **Recommended Settings** section at [Setting Up Visual Studio for Unreal Engine](https://docs.unrealengine.com/en-US/setting-up-visual-studio-development-environment-for-cplusplus-projects-in-unreal-engine/). |
| 59 | + |
| 60 | +## Check for updates |
| 61 | + |
| 62 | +We recommend that you keep Visual Studio updated for the latest bug fixes, features, and Unreal Engine support. Updating Visual Studio doesn't require an update of Unreal Engine. |
| 63 | + |
| 64 | +1. From the Visual Studio main menu, select **Help** > **Check for Updates**. |
| 65 | + |
| 66 | + :::image type="content" source="../../unity/media/vs/check-for-updates.png" alt-text="Screenshot of the Check for Updates menu in Visual Studio Help menu."::: |
| 67 | + |
| 68 | +1. If an update is available, the Visual Studio Installer shows a new version. Select **Update**. |
| 69 | + |
| 70 | + :::image type="content" source="../../unity/media/vs/click-to-update.png" alt-text="Screenshot of Visual Studio Installer with the Updates."::: |
| 71 | + |
| 72 | +## Next steps |
| 73 | + |
| 74 | +Try out some of the features of the Visual Studio Tools for Unreal Engine: [Quickstart: Use Visual Studio Tools for Unreal Engine](vs-tools-unreal-quickstart.md) |
0 commit comments