Merge pull request #41 from wherget/non-core-msbuild

Don't run NetcodePatchTask in non-Core MSBuild.

Author: Lordfirespeed

NetcodePatcher.MSBuild/Sdk/Sdk.targets

@@ -8,6 +8,15 @@
       ReferenceAssemblyPaths="@(ReferencePathWithRefAssemblies)"
       NoOverwrite="$(NetcodePatcherNoOverwrite)"
       DisableParallel="$(NetcodePatcherDisableParallel)"
+      Condition=" '$(MSBuildRuntimeType)' == 'Core' "
+    />
+    <Warning
+      Condition=" '$(MSBuildRuntimeType)' != 'Core' "
+      Code="NCP0001"
+      Text="The NetcodePatcher MSBuild SDK cannot be used in a .NET Framework MSBuild (e.g. Visual Studio).
+            You may ignore this warning if you have set up patching using the command line tool.
+            See the Help Link for details."
+      HelpLink="https://github.com/EvaisaDev/UnityNetcodePatcher#msbuild"
     />
   </Target>
 

README.md

@@ -64,7 +64,10 @@ Run `netcode-patch --help` for usage information and available options.
 ### MSBuild
 
 > [!IMPORTANT]
-> Due to issues with Visual Studio the MSBuild plugin is not currently working properly with it, using the CLI tool and post build event is recommended if you are using Visual Studio.
+> Since Visual Studio still uses 'full' MSBuild (which is based on .NET Framework), some dependencies targeting .NET Standard 2.1
+> cannot be loaded into the build host process.
+> Using the CLI tool and post build event is recommended if you are using Visual Studio.
+> You can use both the SDK and CLI tool depending on your build environemnt. See the example under "Usage with Visual Studio" below.
 > *Alternatively you can manually run `dotnet build` from commandline if you do want to use MSBuild.*
 
 NetcodePatcher has an MSBuild plugin that can be applied with minimal configuration.
@@ -101,6 +104,30 @@ to automatically netcode patch the project's output assemblies.
 
 </details>
 
+<details>
+<summary>Usage with Visual Studio</summary>
+
+If you want to support building in both environments (e.g. Visual Studio and `dotnet`) you can use CLI tool for Visual Studio builds, with a `Condition="'$(MSBuildRuntimeType)' != 'Core'"`.
+
+```xml
+<Project>
+  <ItemGroup>
+    <!-- will be automatically skipped for Visual Studio -->
+    <NetcodePatch Include="$(TargetPath)" />
+  </ItemGroup>
+  <PropertyGroup>
+    <!-- silence the warning message that should have led you to this documentation -->
+    <MSBuildWarningsAsMessages>$(MSBuildWarningsAsMessages);NCP0001</MSBuildWarningsAsMessages>
+  </PropertyGroup>
+  <Target Name="LegacyNetcodePatch" AfterTargets="NetcodePatch" Condition="'$(MSBuildRuntimeType)' != 'Core'">
+    <!-- run the CLI patcher only for MSBuilds that cannot load the dependencies -->
+    <Exec Command="netcode-patch -nv 1.5.2 &quot;$(TargetPath)&quot; @(ReferencePathWithRefAssemblies->'&quot;%(Identity)&quot;', ' ')"/>
+  </Target>
+</Project>
+```
+
+</details>
+
 ### Manual
 
 1. Download the latest [release](https://github.com/EvaisaDev/UnityNetcodePatcher/releases) asset for your platform.