godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a6c1cfae99
godot/modules/mono
History
Rémi Verschelde 340f62d1ec .NET: Generate SdkPackageVersions.props from version.py 
Ensures that the versions always match the Godot version, albeit following
SemVer 2.0 so inserting a dot between "beta" and the build number.

For "stable" status, we omit the suffix as this would be interpreted as a
pre-release build too.

So we have:

| Godot version  | Nupkg version  |
| -------------- | -------------- |
| 4.0.0-beta     | 4.0.0-beta     |
| 4.0.0-beta2    | 4.0.0-beta.2   |
| 4.0.0-rc1      | 4.0.0-rc.1     |
| 4.0.0-stable   | 4.0.0          |
2022-10-05 20:31:26 +02:00
..
build_scripts .NET: Generate SdkPackageVersions.props from version.py 2022-10-05 20:31:26 +02:00
doc_classes C#: Begin move to .NET Core 2022-08-22 03:35:59 +02:00
editor Rename Projection matrix to columns 2022-10-04 12:34:19 -05:00
glue C#: Use Span in Color to avoid string allocations 2022-10-03 12:11:37 +02:00
icons
mono_gd C#: Fix module builds for Windows 32-bit with mingw-w64 2022-09-08 20:57:28 +02:00
thirdparty C#: Replace libnethost dependency to find hostfxr 2022-09-07 16:36:36 +02:00
utils Style: Cleanup header guards for consistency 2022-09-26 13:51:17 +02:00
__init__.py
.editorconfig C#: Code cleanup and greatly reduce use of C# pointers 2022-08-22 03:36:51 +02:00
.gitignore .NET: Generate SdkPackageVersions.props from version.py 2022-10-05 20:31:26 +02:00
class_db_api_json.cpp
class_db_api_json.h
config.py SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
csharp_script.cpp GDScript/C#: Tweak error message for invalid script type for object 2022-10-04 12:56:49 +02:00
csharp_script.h Remove unsupported NO_SAFE_CAST/-fno-rtti from Android build 2022-10-03 11:18:31 +02:00
Directory.Build.props C#: Make GodotSharp API a NuGet package 2022-08-22 03:36:51 +02:00
Directory.Build.targets C#: Make GodotSharp API a NuGet package 2022-08-22 03:36:51 +02:00
godotsharp_defs.h C#: Ensure native handles are freed after switch to .NET Core 2022-08-22 03:36:51 +02:00
godotsharp_dirs.cpp Rename String plus_file to path_join 2022-08-29 19:38:13 -05:00
godotsharp_dirs.h C#: Use custom project setting for C# project files name 2022-08-22 03:36:52 +02:00
interop_types.h
managed_callable.cpp ManagedCallable: use delegate target instead of middleman when possible 2022-10-01 02:09:58 +02:00
managed_callable.h ManagedCallable: use delegate target instead of middleman when possible 2022-10-01 02:09:58 +02:00
mono_gc_handle.cpp C#: Begin move to .NET Core 2022-08-22 03:35:59 +02:00
mono_gc_handle.h C#: Add source generator for properties and exports default values 2022-08-22 03:36:51 +02:00
README.md Add float arg to build_assemblies.py 2022-09-04 04:02:39 +09:30
register_types.cpp
register_types.h
SCsub SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
signal_awaiter_utils.cpp Rename CONNECT_ONESHOT TO CONNECT_ONE_SHOT 2022-09-06 19:00:33 +02:00
signal_awaiter_utils.h

README.md

How to build and run

  1. Build Godot with the module enabled: module_mono_enabled=yes.
  2. After building Godot, use it to generate the C# glue code: 
    <godot_binary> --generate-mono-glue ./modules/mono/glue
  3. Build the C# solutions: 
    ./modules/mono/build_scripts/build_assemblies.py --godot-output-dir ./bin

The paths specified in these examples assume the command is being run from the Godot source root.

How to deal with NuGet packages

We distribute the API assemblies, our source generators, and our custom MSBuild project SDK as NuGet packages. This is all transparent to the user, but it can make things complicated during development.

In order to use Godot with a development of those packages, we must create a local NuGet source where MSBuild can find them. This can be done with the .NET CLI:

dotnet nuget add source ~/MyLocalNugetSource --name MyLocalNugetSource

The Godot NuGet packages must be added to that local source. Additionally, we must make sure there are no other versions of the package in the NuGet cache, as MSBuild may pick one of those instead.

In order to simplify this process, the build_assemblies.py script provides the following --push-nupkgs-local option:

./modules/mono/build_scripts/build_assemblies.py --godot-output-dir ./bin \
    --push-nupkgs-local ~/MyLocalNugetSource

This option ensures the packages will be added to the specified local NuGet source and that conflicting versions of the package are removed from the NuGet cache. It's recommended to always use this option when building the C# solutions during development to avoid mistakes.

Double Precision Support (REAL_T_IS_DOUBLE)

Follow the above instructions but build Godot with the float=64 argument to scons

When building the NuGet packages, specify --float=64 - for example:

./modules/mono/build_scripts/build_assemblies.py --godot-output-dir ./bin \
    --push-nupkgs-local ~/MyLocalNugetSource --float=64