IntialCommit

Plugins/VisualStudioTools/Docs/Marketplace_Readme.md

@@ -0,0 +1,57 @@
+# Visual Studio Integration Tool
+
+Visual Studio Integration Tool is an Unreal Engine plugin that works in conjunction with Visual Studio to display information about Blueprints assets in C++ code (requires Visual Studio 2022 17.4 or later).
+
+## Installing
+
+### Visual Studio
+
+The tool requires the `Visual Studio Tools for Unreal Engine` component from Visual Studio to be installed. You can find it under the "Game development with C++" workload in the Visual Studio Installer (figure 1).
+
+![figure 1](./images/ide_support_ue.png) \
+*Figure 1 - Installing the Visual Studio component*
+
+### Unreal Engine
+  You can install the plugin in a couple of ways:
+
+ - Through the Epic Games Launcher:
+  - Select the "Install to Engine" option within the Launcher. From there, you can select an engine version for installation.
+     - If you're using the Marketplace website, you can add the plugin to your account and you will have an option to open the Launcher in order to install it as detailed above.
+     - If you already added the plugin to your account, go Library -> Vault in the and locate the plugin there.
+
+ - Through source distribution:
+     - If you're unable to use the Marketplace-based distribution (e.g. you're building the Unreal Engine from source), then you can install the plugin manually by following the instructions found at <https://github.com/microsoft/vc-ue-extensions#readme>
+
+## Enabling the plugin
+
+- Through the Unreal Editor
+  - Open your project and then use the Plugin Manager to enable "VisualStudioTools".
+  - See [official documentation](https://docs.unrealengine.com/INT/working-with-plugins-in-unreal-engine/) for more information on how to install and enable plugins.
+- (Advanced) Alternatively, you can manually edit the '.uproject' descriptor for your project and add an entry for the "VisualStudioTools" plugin.
+
+## Usage
+
+Test discovery in Visual Studio 2022
+
+1. Begin by installing and enabling the `Visual Studio Tools for Unreal Engine` plugin.
+2. Open your solution in Visual Studio.
+3. Click on the Test Explorer to show a pop-up that will display available tests. (figure 3).
+4. You can find the logs from the plugin execution in the Tests Output Window.
+5. To refresh your filters for test discovery, you can select the "Options > Unreal Engine > Test Adapter" option under the "Tests" menu. (figure 4)
+
+![figure 2](./images/configuration_page.png) \
+*Figure 2 - Unreal Engine project Configuration Page
+
+![figure 3](./images/test_explorer.png) \
+*Figure 3 - Menu to rescan the blueprint assets in the game project*
+
+![figure 4](./images/test_options.png) \
+*Figure 3 - Menu to change options for Tests Discovery
+
+## Troubleshooting
+
+If you encounter any issues when setting up Visual Studio in conjunction with the Unreal Editor plugin, please refer to the [Troubleshooting](https://github.com/microsoft/vc-ue-extensions/blob/main/Docs/Troubleshooting.md) guide in the repository. This guide provides solutions for common issues and is periodically updated to ensure that the latest solutions are available.
+
+## Reporting issues
+
+To report new issues, provide feedback, or request new features, please use the following options: [Report a Problem](https://aka.ms/feedback/cpp/unrealengine/report) and [Suggest a Feature](https://aka.ms/feedback/cpp/unrealengine/suggest). These options will allow you to submit your issue or feedback directly to our team and help us improve the plugin moving forward.

Plugins/VisualStudioTools/Docs/Troubleshooting.md

@@ -0,0 +1,55 @@
+# Troubleshooting guide
+
+This document describes some of the errors that might happen in the integration with the Unreal Engine and potential ways to mitigate them.
+
+The integration works by Visual Studio being able to invoke the `VisualStudioTools` plugin using the Unreal Editor executable in commandlet mode. That means the following must be true:
+
+- The `Visual Studio Tools for Unreal Engine` component from Visual Studio must be installed. You can find it under the "Game Development with C++" workload in the VS Installer.
+- The game project must be built in a Editor target (e.g., `"Development_Editor"`).
+- The `VisualStudioTools` plugin must be enabled for the project, either explicitly in the .uproject descriptor file or be enabled by default to all projects if installed at the as an engine plugin (via the `"EnabledByDefault=true"` entry in the .uplugin file).
+- Starting on version 17.5, Visual Studio will wait to scan the game project until a file with the `UCLASS/UPROPERTY/UFUNCTION` macros is opened and the Code Lens hints are requested.
+- At the moment, the Code Lens hints will only be displayed for game projects. In particular, the files in the _engine_ project of the solution (with name like "UE4" or "UE5") will not display the hints yet.
+
+## Code Lens are not visible
+
+### Verify the required VS component is installed
+
+In recent versions of UE, the generated solution comes with a `.vsconfig` file, which allows right-clicking on the Solution in VS and selecting "Install Missing Feature(s)". The component is part of the "Game Development with C++" workload.
+
+You can also see this [help page](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2022#step-4---choose-workloads) about installing features using the Visual Studio installer.
+
+### Check if the opened documents have any class decorated with the Unreal macros
+
+For real world projects, scanning the blueprints information might take several seconds and be expensive in terms of machine resources. Visual Studio will only start the operation when the Code Lens are rendered. That means it will wait until a file from the game project with the Unreal macros is opened in the editor.
+
+### Check if a `cpp.hint` file is redefining the relevant Unreal macros
+
+Some projects might have a cpp.hint file that includes the `UCLASS`, `UPROPERTY`, `UFUNCTION` macros. That might suppress the new logic in Visual Studio that uses the macros to display the Code Lens hints.
+
+If that is the case, you can remove those macros from the hint file, save it and try reloading the project.
+
+Note that other macros in the hint file can be left as-is and do not affect the Code Lens hints.
+
+### Ensure the C++ Database is enabled
+
+In Tools > Options > Text Editor > C/C++ > Advanced > Browsing/Navigation, the setting "Disable Database" should be set to "False". This is the default value of this setting.
+
+## Errors showing up in the Output Window and/or Task Center notification
+
+### Message "LogInit: Error: VisualStudioToolsCommandlet looked like a commandlet, but we could not find the class."
+
+Possible causes are the plugin not being installed correctly or installed but not yet enabled for the game project (which is required on installation from the Marketplace).
+
+- See [this section](../README.md#building-and-installing) for installation instructions.
+
+- See [this section](../README.md#optional-enabling-the-plugin) for instructions on how to enable the plugin.
+
+### Message "Command finished with exit code 1" without other errors
+
+Either the game project or the plugin DLL is not yet built. Rebuilding the project should ensure they are available. Then manually rescan the game project using the `Project > Rescan UE Blueprints` menu.
+
+### Task Center error: "Your task failed with the message: Could not find a part of the path...'
+
+This was a known issue when trying to locate the path the Unreal Editor executable, fixed in Visual Studio 17.5-Preview3. This usually happens when the selected Configuration in VS is not one with an "Editor" target.
+
+A workaround is to switch to such configuration and manually rescan the game project using the `Project > Rescan UE Blueprints` menu.