Repository files navigation

This project contains an Unreal Editor plugin that works in conjunction with Visual Studio to help discover and run tests in C++ code.

The plugin can be installed in either the Engine or Game project sources, and it is automatically activated when an Unreal Engine project is opened in Visual Studio.

Before you begin, please make sure you have the following software and tools set up:

1. Visual Studio 2022 has the "Visual Studio Tools for Unreal Engine" component installed.
   1. The component can be found in the "Game development with C++" workload or as an individual component.
2. Unreal Engine, either installed or built from source.
   1. To learn how to install or build Unreal Engine, please refer to the following guide:Installing Unreal Engine.
   2. The source code and instructions have been tested on Unreal Engine versions 4.27 and 5.0+.

If you have Unreal Engine installed and set up through the Epic Games Launcher, and you only want to use the plugin, you can skip the steps below and install it directly from theUnreal Engine Marketplace.

The most straightforward way to use the plugin is to clone the repo under thePlugins folder of your game project or engine source. If you have multiple projects in the same Visual Studio solution, it is recommended to install the plugin at the engine level and share the binaries across the projects.

1. Clone the repo by using the following commands:

   git clone https://github.com/microsoft/vc-ue-extensions.git

2. Build the plugin from source:

   msbuild-p:UnrealEngine=<AbsolutePathToEngine>

   Note#1:<AbsolutePathToEngine> can be path to source code folder of the engine or the one installed byEpic Games Launcher (e.gC:\Program Files\Epic Games\UE_5.4)Note#2: Alternatevly you can followUnreal Engine building plugins guide.

3. Clone built plugin.

   3.1. To Project folder:

   move-item-path ./bin-destination<ProjectRoot>\Plugins\VisualStudioTools

   Note: You have to createPlugins folder in the root of the game project if it doens't exisist yet.

   3.2. To Engine folder:

   move-item-path ./bin-destination<AbsolutePathToEngine\Engine\Plugins

4. Optional: Regenerate the Solution for your game project so that the plugin source will be visible in Visual Studio.

5. Rebuild the game project, which will also build the plugin.

After completing these steps, Visual Studio should automatically recognize the plugin when you open a solution or project, and it will start processing tests in your game.

You can also use the optionRun All Tests in theTests menu to manually force Visual Studio to invoke the the plugin.

If you prefer to have the plugin's repository located separately from the engine or project sources (for example, if you want to share it between multiple engines), you can follow the instructions provided in the fileBuilding and Installing the Plugin to learn how to build and install the plugin in such a scenario.

By default, the plugin descriptor is already set with"EnabledByDefault = true", so it should function automatically without any additional steps. However, if you encounter difficulties with Unreal Engine building the plugin (e.g., UE fails to build the plugin when building the project), you can enable the plugin explicitly by using one of the following methods:

1. Navigate to the plugin manager in the Unreal Editor and selectVisualStudioTools.
2. Manually edit the game project's.uproject descriptor file by adding an entry for the plugin.

In either case, the end result should be a new entry in thePlugins array in the JSON file, as shown below:

{"FileVersion":3,"Category":"...","Description":"...","Modules": ["..."],"Plugins": [  {"Name":"VisualStudioTools","Enabled":true,  } ]}

Note: To ensure proper activation of the plugin, make sure the correct plugin is selected or the desired changes are made in the.uproject file.

The plugin is designed to be used with Visual Studio, and as such, it does not provide any user interfaces, commands, or logs within the Unreal Editor. However, it is still possible to test the plugin's execution by running thesample command below:

&"<AbsolutePathToEngine>\Engine\Binaries\Win64\UnrealEditor-Cmd.exe""$Env:UserProfile\Unreal Projects\EmptyProject\EmptyProject.uproject"-run=VisualStudioTools-output"$Env:Temp\vs-ue-tools.json" [-unattended-noshadercompile-nosound-nullrhi-nocpuprofilertrace-nocrashreports-nosplash]

This command will run the plugin for the specified project and save Unreal Engine Blueprint information in the output file. Optional parameters are included to run the command faster.

For more information on the specific command line parameters, you can run the following command in the powershell prompt with-help:

&"<Editor-Cmd.exe>""<path_to_uproject>"-run=VisualStudioTools-help [-unattended-noshadercompile-nosound-nullrhi-nocpuprofilertrace-nocrashreports-nosplash]

Note: The executable name isUE4Editor-cmd.exe for UE4.x, located under a similar path.

If you encounter any issues when setting up Visual Studio in conjunction with the Unreal Editor plugin, please refer to theTroubleshooting guide in the repository. This guide provides solutions for common issues and is periodically updated to ensure that the latest solutions are available.

To report new issues, provide feedback, or request new features, please use the following options:Report a Problem andSuggest a Feature. These options will allow you to submit your issue or feedback directly to our team and help us improve the plugin moving forward.

This project welcomes contributions and suggestions. Check out ourcontributing guide for instructions on how to contribute to the project.

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must followMicrosoft's Trademark & Brand Guidelines.Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.Any use of third-party trademarks or logos are subject to those third-party's policies.