C#: Switch games to MSBuild Sdks and .NET Standard #40595

neikeq · 2020-07-22T12:24:26Z

Godot.NET.Sdk

Godot uses its own custom MSBuild Sdk for game projects. This new Sdk adds its own functionality on top of 'Microsoft.NET.Sdk'.

The new Sdk is resolved from the NuGet package.

All the default boilerplate was moved from game projects to the Sdk. The default csproj for game project can now be as simple as:

<Project Sdk="Godot.NET.Sdk/4.0.0-dev1">
  <PropertyGroup>
    <TargetFramework>netstandard2.1</TargetFramework>
  </PropertyGroup>
</Project>

Source files are included by automatically so Godot no longer needs to keep the csproj in sync when creating new source files.

Closes godotengine/godot-proposals#315

Define constants

Godot defines a list of constants for conditional compilation. When exporting games, this list also included engine 'features' and platform 'bits'.
There were a few problems with that:

The 'features' constants were only defined when exporting games. Not when building the game for running in the editor player.
If the project was built externally by an IDE, the constants wouldn't be defined at all.

The new Sdk assigns default values to these constants when not built from the Godot editor, i.e.: when built from an IDE or from the command line. The default define constants are determined from the system MSBuild is running on.

However, it's not possible for MSBuild to determine the set of supported engine features.
It's also not possible to determine if a project is being built to run on a 32-bit or 64-bit Godot executable.

As such the 'features' and 'bits' constants had to be removed.
The benefit of checking those at compile time was questionable, and they can still be checked at runtime.

The new list of define constants includes:

GODOT
GODOT_<PLATFORM>
Defaults to the platform MSBuild is running on.
TOOLS
When building with the 'Debug' configuration (editor and editor player).
GODOT_REAL_T_IS_DOUBLE
Not defined by default unless $(GodotRealTIsDouble) is overriden to be 'true'.

.NET Standard

The target framework of game projects was changed
to 'netstandard2.1'.

Closes godotengine/godot-proposals#339

aaronfranke · 2020-07-22T18:11:31Z

$ mono --version
Mono JIT compiler version 6.10.0.104 (tarball Fri Jun 26 19:38:44 UTC 2020)

On an empty project, with this PR and the above Mono on Ubuntu 20.04, I get this error when building:

Project "NeikeqTesting.sln" (Build target(s)):
	Message: Building solution configuration "Debug|Any CPU".
	Project "NeikeqTesting.csproj" (default targets):
		MakeDir: Creating directory ".mono/temp/bin/Debug/".
		MakeDir: Creating directory ".mono/temp/obj/Debug/".
		/usr/lib/mono/msbuild/Current/bin/Sdks/Microsoft.NET.Sdk/targets/Microsoft.PackageDependencyResolution.targets(234,5): error NETSDK1004: Assets file '/home/aaronfranke/NeikeqTesting/.mono/temp/obj/project.assets.json' not found. Run a NuGet package restore to generate this file. [/home/aaronfranke/NeikeqTesting/NeikeqTesting.csproj]
	Done building project "NeikeqTesting.csproj" -- FAILED.
Done building project "NeikeqTesting.sln" -- FAILED.

Running nuget restore as suggested fixes it, but Godot should do this automatically.

Also, when building after restoring, I got this message:

ERROR: Cannot find dotnet CLI executable. Fallback to MSBuild from Mono.
   at: godot_icall_GD_pusherror (modules/mono/glue/gd_glue.cpp:251)

With both Mono and .NET Core 3.1 (3.1.302) installed, I get the same error, with a different MSBuild:

Project "NeikeqTestingButWithDotnetInstalled.sln" (Build target(s)):
	Message: Building solution configuration "Debug|Any CPU".
	Project "NeikeqTestingButWithDotnetInstalled.csproj" (default targets):
		MakeDir: Creating directory ".mono/temp/bin/Debug/".
		MakeDir: Creating directory ".mono/temp/obj/Debug/".
		/usr/share/dotnet/sdk/3.1.302/Sdks/Microsoft.NET.Sdk/targets/Microsoft.PackageDependencyResolution.targets(234,5): error NETSDK1004: Assets file '/home/aaronfranke/NeikeqTestingButWithDotnetInstalled/.mono/temp/obj/project.assets.json' not found. Run a NuGet package restore to generate this file. [/home/aaronfranke/NeikeqTestingButWithDotnetInstalled/NeikeqTestingButWithDotnetInstalled.csproj]
	Done building project "NeikeqTestingButWithDotnetInstalled.csproj" -- FAILED.
Done building project "NeikeqTestingButWithDotnetInstalled.sln" -- FAILED.

As before, running nuget restore as suggested fixes it, but Godot should do this automatically.

neikeq · 2020-07-22T18:16:17Z

@aaronfranke There was a recent fix. Did you test with the commit 4a30289 included?

aaronfranke

The new list of define constants includes:

Why not also include GODOT_PC, GODOT_MOBILE, and GODOT_WEB? These are essentially unions of operating systems, which we already define, so it should be easy to add these.

The architecture/bits and texture compression are of low importance, so it's fine to ditch them... and that covers everything!

modules/mono/csharp_script.cpp

modules/mono/editor/GodotTools/GodotTools/BottomPanel.cs

aaronfranke · 2020-07-22T18:24:55Z

@neikeq If you rebased this PR, then that fix would be included :)

Godot.NET.Sdk ------------- Godot uses its own custom MSBuild Sdk for game projects. This new Sdk adds its own functionality on top of 'Microsoft.NET.Sdk'. The new Sdk is resolved from the NuGet package. All the default boilerplate was moved from game projects to the Sdk. The default csproj for game project can now be as simple as: ``` <Project Sdk="Godot.NET.Sdk/4.0.0-dev2"> <PropertyGroup> <TargetFramework>netstandard2.1</TargetFramework> </PropertyGroup> </Project> ``` Source files are included by automatically so Godot no longer needs to keep the csproj in sync when creating new source files. Define constants ---------------- Godot defines a list of constants for conditional compilation. When exporting games, this list also included engine 'features' and platform 'bits'. There were a few problems with that: - The 'features' constants were only defined when exporting games. Not when building the game for running in the editor player. - If the project was built externally by an IDE, the constants wouldn't be defined at all. The new Sdk assigns default values to these constants when not built from the Godot editor, i.e.: when built from an IDE or from the command line. The default define constants are determined from the system MSBuild is running on. However, it's not possible for MSBuild to determine the set of supported engine features. It's also not possible to determine if a project is being built to run on a 32-bit or 64-bit Godot executable. As such the 'features' and 'bits' constants had to be removed. The benefit of checking those at compile time was questionable, and they can still be checked at runtime. The new list of define constants includes: - GODOT - GODOT_<PLATFORM> Defaults to the platform MSBuild is running on. - GODOT_<PC/MOBILE/WEB> - TOOLS When building with the 'Debug' configuration (editor and editor player). - GODOT_REAL_T_IS_DOUBLE Not defined by default unless $(GodotRealTIsDouble) is overriden to be 'true'. .NET Standard ------------- The target framework of game projects was changed to 'netstandard2.1'.

neikeq · 2020-07-25T17:27:31Z

Re-based to latest master, added GODOT_PC/MOBILE/WEB define constants as suggested and made additional changes.

aaronfranke · 2020-07-25T20:51:30Z

I still get this error message when building an empty project without .NET Core, though it still builds and runs.

modules/mono/glue/gd_glue.cpp:251 - Cannot find dotnet CLI executable. Fallback to MSBuild from Mono.

Does this mean that .NET Core is now required as a part of Godot moving to .NET Standard? So you need both Mono and .NET Core for Godot? If .NET Core is not required, then it should not throw an error. If it is required, that should be documented.

Also, should TOOLS be GODOT_TOOLS, or should it be left as TOOLS?

neikeq · 2020-07-25T21:50:38Z

That's unrelated to this PR. That should probably be changed to a simple print rather than an error. It's printed when the selected build tool cannot be found (dotnet CLI is the default now) and Godot will try to fallback to a different one.

Also, should TOOLS be GODOT_TOOLS, or should it be left as TOOLS?

I decided to keep it TOOLS as it's commonly used constant when writing editor code. If anything, we may remove it later and move editor code into a separate csproj.

modules/mono/editor/GodotTools/GodotTools/BottomPanel.cs

modules/mono/editor/GodotTools/GodotTools/Export/ExportPlugin.cs

aaronfranke

I don't understand every line of this but it works well and I have no further concerns.

akien-mga · 2020-07-26T18:47:39Z

Thanks!

evelant · 2020-07-27T18:53:28Z

Is there a plan to backport this into the 3.x versions or would that be too difficult or not worth the effort? I've run into helpful nuget packages requiring netstandard2.1 which are unfortunately impossible to use with Godot 3.x.

aaronfranke · 2020-07-27T19:04:19Z

@AndrewMorsillo Probably not. It's not really reasonable to expect major features like this to be backported to stable branches, since that's not the point of stable branches and major changes like this have a high chance of breaking things. If you want to use new features, you will simply have to upgrade to new versions when they come out.

EDIT: Also, this PR already has known compatibility breakages (though they are minor).

neikeq added enhancement topic:dotnet labels Jul 22, 2020

neikeq added this to the 4.0 milestone Jul 22, 2020

neikeq requested a review from aaronfranke as a code owner July 22, 2020 12:24

aaronfranke reviewed Jul 22, 2020

View reviewed changes

modules/mono/csharp_script.cpp Outdated Show resolved Hide resolved

modules/mono/editor/GodotTools/GodotTools/BottomPanel.cs Outdated Show resolved Hide resolved

This was referenced Jul 23, 2020

[Mono] Mono MSBuild assumes C#7.3 feature level in new version #36058

Closed

Add a page listing all features supported by Godot godotengine/godot-docs#3775

Merged

neikeq force-pushed the godot-net-sdk-and-net-standard branch from 86a591e to ced77b1 Compare July 25, 2020 17:22

aaronfranke reviewed Jul 25, 2020

View reviewed changes

modules/mono/editor/GodotTools/GodotTools/BottomPanel.cs Show resolved Hide resolved

modules/mono/editor/GodotTools/GodotTools/BottomPanel.cs Show resolved Hide resolved

modules/mono/editor/GodotTools/GodotTools/Export/ExportPlugin.cs Show resolved Hide resolved

aaronfranke approved these changes Jul 26, 2020

View reviewed changes

akien-mga merged commit dc45605 into godotengine:master Jul 26, 2020

Calinou mentioned this pull request Aug 6, 2020

Add support for nullable static types in GDScript godotengine/godot-proposals#162

Open

neikeq mentioned this pull request Aug 20, 2020

Migrate to "new" .csproj format. #20305

Closed

neikeq deleted the godot-net-sdk-and-net-standard branch May 13, 2021 23:16

raulsntos mentioned this pull request Oct 17, 2021

Re-add project features as define constants in C# #53920

Open

raulsntos mentioned this pull request Dec 12, 2021

c# Span struct not working #39410

Closed

ace24713 mentioned this pull request Jan 24, 2023

C# Preprocessor defines doc is out of date godotengine/godot-docs#6659

Closed

raulsntos mentioned this pull request Feb 24, 2023

Missing C# defines when exporting with custom feature tags #73852

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

C#: Switch games to MSBuild Sdks and .NET Standard #40595

C#: Switch games to MSBuild Sdks and .NET Standard #40595

neikeq commented Jul 22, 2020

aaronfranke commented Jul 22, 2020

neikeq commented Jul 22, 2020

aaronfranke left a comment •

edited

Loading

aaronfranke commented Jul 22, 2020

neikeq commented Jul 25, 2020

aaronfranke commented Jul 25, 2020 •

edited

Loading

neikeq commented Jul 25, 2020 •

edited

Loading

aaronfranke left a comment

akien-mga commented Jul 26, 2020

evelant commented Jul 27, 2020 •

edited

Loading

aaronfranke commented Jul 27, 2020 •

edited

Loading

C#: Switch games to MSBuild Sdks and .NET Standard #40595

C#: Switch games to MSBuild Sdks and .NET Standard #40595

Conversation

neikeq commented Jul 22, 2020

Godot.NET.Sdk

Define constants

.NET Standard

aaronfranke commented Jul 22, 2020

neikeq commented Jul 22, 2020

aaronfranke left a comment • edited Loading

Choose a reason for hiding this comment

aaronfranke commented Jul 22, 2020

neikeq commented Jul 25, 2020

aaronfranke commented Jul 25, 2020 • edited Loading

neikeq commented Jul 25, 2020 • edited Loading

aaronfranke left a comment

Choose a reason for hiding this comment

akien-mga commented Jul 26, 2020

evelant commented Jul 27, 2020 • edited Loading

aaronfranke commented Jul 27, 2020 • edited Loading

aaronfranke left a comment •

edited

Loading

aaronfranke commented Jul 25, 2020 •

edited

Loading

neikeq commented Jul 25, 2020 •

edited

Loading

evelant commented Jul 27, 2020 •

edited

Loading

aaronfranke commented Jul 27, 2020 •

edited

Loading