Merge pull request #11172 from MicrosoftDocs/main639020414217769966sync_temp

For protected branch, push strategy should use PR and merge to target branch method to work around git push error

Author: learn-build-service-prod[bot]

gamedev/toc.yml

@@ -34,6 +34,8 @@
       href: unreal/get-started/vs-tools-unreal-quickstart.md
     - name: Open Unreal Engine projects in Visual Studio
       href: unreal/get-started/vs-tools-unreal-uproject.md
+    - name: Configure Visual Studio Tools for Unreal Engine
+      href: unreal/get-started/vs-tools-unreal-configure.md
     - name: Add Unreal Engine classes, modules, and plugins in Visual Studio
       href: unreal/get-started/vs-tools-unreal-add-class-module-plugin.md
     - name: View Unreal Engine Blueprints in Visual Studio

gamedev/unreal/get-started/vs-tools-unreal-configure.md

@@ -0,0 +1,132 @@
+---
+title: "Configure Visual Studio Tools for Unreal Engine"
+description: "Learn how to use the Unreal Engine Integration Configuration dialog to set up and manage Visual Studio Tools for Unreal Engine features"
+ms.date: 12/22/2025
+ms.topic: how-to
+ms.service: visual-studio
+ms.subservice: unreal-engine-tools
+author: TylerMSFT
+ms.author: TWhitney
+manager: Coxford
+---
+
+# Configure Visual Studio Tools for Unreal Engine
+
+Use the Unreal Engine Integration Configuration dialog to configure and manage all Visual Studio Tools for Unreal Engine. This dialog appears automatically when you open an Unreal Engine project in Visual Studio. You can also access it manually from the Visual Studio menu via **Project** > **Configure Tools for Unreal Engine**.
+
+## Prerequisites
+
+The following must be installed:
+
+- Visual Studio version 17.10 or later
+- Unreal Engine version 5 or later
+- An Unreal Engine project opened in Visual Studio
+
+## Open the configuration page
+
+Open an Unreal Engine project in Visual Studio. The UE configuration page automatically appears when you first open an Unreal Engine project in Visual Studio unless the **Show on startup** checkbox is cleared. If it doesn't appear, from the Visual Studio main menu, choose **Project** > **Configure Tools for Unreal Engine**
+
+:::image type="complex" source="../media/vs-unreal-engine-configuration-page.png" alt-text="A screenshot of the Unreal Engine project configuration page." lightbox="../media/vs-unreal-engine-configuration-page.png":::
+The configuration page has a red/green status indicator and a refresh button for options such as Overall Configuration Status, Unreal Build Tool Status, Unreal Engine Targets, Blueprint Support, Visual Studio Integration Tool Status, and so on.
+:::image-end:::
+
+## Configuration sections
+
+The Unreal Engine Integration Configuration page contains multiple sections, each responsible for configuring aspects of Visual Studio/Unreal Engine integration.
+
+### Overall Configuration Status
+
+Shows the overall status of Unreal Engine integration in Visual Studio. This section provides a quick summary of whether all components are properly configured. Icons show whether configuration is complete, needs attention, or has errors.
+
+Select the run status check button (a circular arrow) to validate your configuration:
+
+:::image type="content" source="../media/vs-unreal-engine-configuration-run-status-check-button.png" alt-text="Screenshot of the Overall Configuration Status section with the run status check button highlighted in Visual Studio.":::
+
+A green indicator next to the run status check button means that everything is properly configured. A yellow indicator means that some components need attention. Open the **Output** window in Visual Studio (**View** > **Output**) for detailed results of the status check. 
+
+### Customize Project View
+
+Customizes how Unreal Engine projects and files appear in the Visual Studio **Solution Explorer**.
+
+Use the dropdown to select project view settings optimized for your development workflow such as a game development view or an engine development view. You can change which project files and engine files to exclude from the Solution Explorer view, which shared include paths to exclude from IntelliSense, and so on. For more information, see [Edit project settings](vs-tools-unreal-uproject.md#edit-project-settings).
+
+### Unreal Build Tool Status
+
+Manages the integration with Unreal Engine's build system and workspace generation. It indicates whether the build tool integration is up to date and properly configured. Update the workspace generator from this section.
+
+### Unreal Engine Targets
+
+This section manages target-configuration-platform combinations.
+
+- **Target** dropdown: Select from available targets. For example, for the Lyra project, choose from **`LyraClient`**, **`LyraGame`**, **`LyraServer`**, or **`LyraEditor`**.
+- **Configuration** dropdown: Choose the build configuration. For example, in the Lyra project, **`DebugGame`** builds full debugging symbols, **`Development`** builds some debugging symbols but includes compiler optimizations for performance, and **`Shipping`** creates a fully optimized release build with no debugging symbols.
+- **Platform** dropdown: Select the target platform, such as **`Win64`**.
+- **Add** button: Create the target-configuration-platform combination you have selected. It appears in the list of targets.
+- **Remove selected targets** button: Deletes the selected target-configuration-platform combination from the list of targets.
+- **Generate Targets** button: Creates the selected target-configuration-platform combinations so that you can build them.
+
+:::image type="content" source="../media/vs-unreal-engine-targets-configuration.png" alt-text="Screenshot of the Unreal Engine Targets configuration section. The target dropdown is set to LyraGame. The Configuration dropdown is DebugGame. The Platform dropdown is Win64. The Add, Generate Targets, and Remove selected targets buttons are highlighted. The checkbox next to the target LyraEditor is selected.":::
+
+### Blueprint Support
+
+Enables Visual Studio integration with Unreal Engine Blueprints so you can view Blueprint information in the Visual Studio debugger. You can also find Blueprint references in the project. Select the refresh button to validate that Blueprint support is properly configured.
+
+### Visual Studio Integration Tool Status
+
+This section refers to the status of the [Unreal Engine plugin for Visual Studio](https://github.com/microsoft/vc-ue-extensions/blob/main/README.md). It shows whether it is installed and active. This plugin is required for features such as viewing Blueprint pin values in the Visual Studio debugger and running Unreal Engine tests from Visual Studio.
+
+If the plugin isn't installed, install it into your project or into the UE engine by following the instructions at [Install the Unreal Engine plugin for Visual Studio to UE](vs-tools-unreal-install.md#install-the-unreal-engine-plugin-for-visual-studio-to-ue).
+
+:::image type="content" source="../media/vs-unreal-engine-integration-tool-status.png" alt-text="Screenshot of the VS Integration Tool Status section. The status says ready to install v2.7. The Install to Project and Install to Engine buttons are highlighted. The manual installation link is at the bottom.":::
+
+### Unreal Engine Test Adapter Status
+
+Configures Unreal Engine test discovery and execution integration so you can run and debug UE tests directly from Visual Studio. When configured, UE tests appear in the Visual Studio Test Explorer.
+
+### Unreal Engine Naming Convention Checker Status
+
+Enables code analysis for Unreal Engine naming conventions and coding standards so you can ensure your code adheres to UE guidelines. It provides warnings and suggestions for naming convention violations.
+
+### HLSL Support for Unreal Engine Projects
+
+Configures High-Level Shader Language (HLSL) support for shader development. It enables HLSL-specific features for HLSL shader files like syntax coloring, IntelliSense, and error detection. This support is intended to improve the experience of writing and editing shaders in Visual Studio. 
+
+### UBA Visual configuration
+
+The Unreal Build Accelerator (UBA) virtualizes and distributes C++ compilation, allowing compilers and tools to run on remote machines while appearing local. This integration allows you to monitor the build processes for your Unreal Engine projects. It's a UBA specific diagnostic view that Visual Studio exposes when UBA is enabled for Unreal Engine builds. It allows you to:
+
+- View UBA task execution timelines
+- Display remote compilation activity
+- Visualize cache hits/misses
+- Provide diagnostics when UBA fails or slows down
+- Help you understand how UBA is accelerating (or not accelerating) your build
+
+Configure UBA Visualizer integration to automatically display the UBA Visualizer window when building Unreal Engine projects that use the Unreal Build Accelerator.
+
+## Run status checks
+
+Most sections include a status check feature:
+
+1. Look for the message "Need to run status check"
+1. Select the refresh icon to run the status check
+1. Wait for the validation to complete. A green checkmark indicates that the section is properly configured. A yellow warning icon indicates that attention is needed.
+1. Address any issues identified by the status check. High level messages appear in the section. Some tools provide additional information in the Visual Studio **Output** window.
+
+## Troubleshooting
+
+If you encounter issues with the configuration:
+
+- **Refresh status**: Use the refresh icon in the top-right corner of the dialog
+- **Run individual checks**: Validate each section separately to isolate problems
+- **Check prerequisites**: Ensure all required components are installed
+- **Restart Visual Studio**: Close and reopen Visual Studio if changes don't take effect
+- **Manual installation**: Use the manual installation links if automatic installation fails
+
+## Next steps
+
+After configuring Visual Studio Tools for Unreal Engine:
+
+- [Use Visual Studio Tools for Unreal Engine](vs-tools-unreal-quickstart.md)
+- [View Unreal Engine Blueprints in Visual Studio](vs-tools-unreal-view-blueprints.md)
+- [Debug Unreal Engine Blueprints in Visual Studio](vs-tools-unreal-blueprint-debugger.md)
+- [View Unreal Engine logging in Visual Studio](vs-tools-unreal-logging.md)

gamedev/unreal/get-started/vs-tools-unreal-install.md

@@ -1,7 +1,7 @@
 ---
 title: "Install Visual Studio Tools for Unreal Engine"
 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."
-ms.date: 06/18/2025
+ms.date: 12/17/2025
 ms.service: visual-studio
 ms.subservice: unreal-engine-tools
 ms.topic: get-started
@@ -12,14 +12,14 @@ manager: Coxford
 
 # Install Visual Studio Tools for Unreal Engine
 
-This article helps you install tools that allow you to do the following from within Visual Studio:
+This article helps you install tools that allow you to do the following Unreal Engine (UE) tasks from within Visual Studio:
 
 - View UE logging
 - View and expand UE macros
 - Add UE classes, modules, and plugins
 - Discover, run, manage, and debug Unreal Engine tests
-- Debug C++ code called by Unreal Engine Blueprints and see Blueprint information in the Visual Studio debugger
 - View and find references to UE Blueprints
+- Debug C++ code called by Unreal Engine Blueprints and see Blueprint information in the Visual Studio debugger
 
 ## Prerequisites
 
@@ -30,41 +30,40 @@ Install the following before you install Visual Studio Tools for Unreal Engine:
 
 ## Installation
 
-This article covers installing tools to enhance writing and debugging Unreal Engine (UE) code in Visual Studio. Here's an overview of the tools:
+Here's an overview of the tools you can install:
 
-| Tool | Installs into | Functionality |
+| Tool | Host | Functionality |
 |--|--|--|
-| Visual Studio Tools for Unreal Engine | Visual Studio | Add UE classes, modules, view UE logging, see UE macro expansions, find blueprint references, open UE `.uprojects` directly, and so on, from within Visual Studio. *As of Visual Studio 2022 version 17.7, you no longer need to also have the Unreal Engine Visual Studio Integration Tool plugin to view UE Blueprints in Visual Studio.* |
-| Visual Studio debugger tools for Unreal Engine Blueprints | Visual Studio | Supports debugging C++ code and Blueprints. Requires the UE plugin for Visual Studio to show Blueprint node pin values in the debugger. |
-| Unreal Engine Test Adapter | Visual Studio | Discover, run, manage, and debug your Unreal Engine tests from within Visual Studio. Requires the UE plugin for Visual Studio. |
-| Unreal Engine plugin for Visual Studio | Unreal Engine | Provides the integration between Unreal Engine and Visual Studio to run UE tests in Visual Studio and view Blueprint node pin values in the Visual Studio Local Variables window. |
+| Visual Studio Tools for Unreal Engine | Visual Studio | Add UE classes, modules, view UE logging, see UE macro expansions, find blueprint references, open UE `.uprojects` directly, and so on, from within Visual Studio.</br></br>*As of Visual Studio 2022 version 17.7, you no longer need to also have the Unreal Engine Visual Studio Integration Tool plugin to view UE Blueprints in Visual Studio.* |
+| Visual Studio debugger tools for Unreal Engine Blueprints | Visual Studio | Supports debugging C++ code and Blueprints. Requires the Unreal Engine plugin for Visual Studio to show Blueprint node pin values in the debugger. |
+| Unreal Engine Test Adapter | Visual Studio | Discover, run, manage, and debug your Unreal Engine tests from within Visual Studio. Requires the Unreal Engine plugin for Visual Studio. |
+| Unreal Engine plugin for Visual Studio | Unreal Engine | Provides integration between Unreal Engine and Visual Studio to run UE tests in Visual Studio and view Blueprint node pin values in the Visual Studio local variables window. |
 
 Follow these steps to add the tools to Visual Studio:
 
-1. In the Windows search box, type "Visual Studio Installer".
-1. Look for the installer under the Apps results and double-click it.
+1. Use the Windows search box to launch "Visual Studio Installer".
 1. When the installer appears, select the version of Visual Studio you're using and then select **Modify**.
 1. Select the **Workloads** tab, then select the **Game development with C++** workload.
 1. In the **Installations details** pane, ensure that under **Game development with C++** > **Optional** that the following are selected:
     - **Visual Studio Tools for Unreal Engine**
     - **Visual Studio debugger tools for Unreal Engine Blueprints**
     - **Unreal Engine Test Adapter**
+    - **Windows 10 SDK 10.0.18362.0**, or higher
     - If you work with High-Level Shader Language (HLSL) files, select **HLSL Tools**.
-1. Select the **Individual components** tab at the top of the dialog.
-1. Under **Installation details** on the right, expand **Game development with C++**.
-1. Ensure that under **Optional** that **Windows 10 SDK 10.0.18362.0**, or higher, is selected.
 1. Select **Modify** to complete the installation.
 
    :::image type="content" source="../media/vs-installer-unreal-engine-workload.png" alt-text="Screenshot of the Visual Studio installer. The Game development with C++ workload is selected. In the installation details pane, Visual Studio Tools for Unreal Engine, Visual Studio debugger tools for Unreal Engine Blueprints, HSL Tools, And Windows 11 SDK are selected." lightbox="../media/vs-installer-unreal-engine-workload.png":::
 
-To add the Unreal Engine plugin for Visual Studio to UE, follow these steps:
+### Install the Unreal Engine plugin for Visual Studio to UE
+
+To install the Unreal Engine plugin for Visual Studio to UE, there are two approaches:
 
 - For manual installation instructions, see [vc-ue-extensions](https://github.com/microsoft/vc-ue-extensions).
 - If you have an Unreal Engine project that you can open in Visual Studio, another way to install the plugin is in Visual Studio via the Unreal Engine Configuration window.
-  - With an Unreal Engine project opened in Visual Studio, choose **Project** > **Configure Tools for Unreal Engine** to open the **Unreal Engine Integration Configuration** window.
-  - In the **Visual Studio Integration Tool Status** section, select **Install to Project** or **Install to Engine** as meets your needs.
+  - With an Unreal Engine project opened in Visual Studio, choose **Project** > **Configure Tools for Unreal Engine** which opens the **Unreal Engine Integration Configuration** window.
+  - In the **Visual Studio Integration Tool Status** section, select the refresh button. Then choose **Install to Project** or **Install to Engine** as meets your needs.
 
-If you don't see the install buttons, choose the refresh icon in the top right corner of the window to refresh the status.
+If you don't see the install buttons, choose the refresh icon in the top right corner of the **Visual Studio Integration Tool Status** section to refresh the status.
 The **Manual installation instructions** link opens the [vc-ue-extensions](https://github.com/microsoft/vc-ue-extensions/blob/main/README.md) page, if you need to install the plugin manually.
 
 :::image type="content" source="../media/vs-unreal-engine-configuration-page-plugin.png" alt-text="Screenshot of the Unreal Engine Integration Configuration window. In the Visual Studio Integration Tool Status section, the refresh, Install to Project, Install to Engine buttons are highlighted. The Manual installation instructions link is also highlighted.":::

gamedev/unreal/get-started/vs-tools-unreal-overview.md

@@ -26,7 +26,7 @@ Visual Studio Tools for Unreal Engine makes it easier to write and debug C++ cod
 * Visual Studio performance is tuned for large projects<sup>2</sup>
 * Be more productive with High-Level Shading Language (HLSL) files via syntax highlighting and statement completion
 
-<sup>1</sup> As of Visual Studio 2022 17.10, you no longer need Visual Studio Tools for Unreal Engine to view UE Blueprints in Visual Studio.
+<sup>1</sup> As of Visual Studio 2022 17.10, you no longer need Visual Studio Tools for Unreal Engine to view UE Blueprints in Visual Studio.\
 <sup>2</sup> These features are available in Visual Studio 17.7 or later without installing Visual Studio Tools for Unreal Engine.
 
 ## Supported Visual Studio versions