History

Juan Pablo Arce e3790de461 Fix exported typed dictionaries in .NET having an incorrect hint, which led to incorrect scene serialization		2024-10-18 00:55:24 -03:00
..
build_scripts	C# Assemblies can now be built with deprecated=no	2024-09-05 10:04:24 +02:00
doc_classes
editor	Fix exported typed dictionaries in .NET having an incorrect hint, which led to incorrect scene serialization	2024-10-18 00:55:24 -03:00
glue	Add ReadOnlySpan API Overloads	2024-10-09 23:14:38 +08:00
icons
mono_gd	CI: Update `clang-format` pre-commit hook to 19.1.0	2024-09-26 11:46:12 +02:00
thirdparty	C#: Fallback to CoreCLR/MonoVM hosting APIs when hostfxr/NativeAOT fails	2024-09-16 17:07:03 +02:00
utils
.editorconfig
.gitignore
__init__.py
class_db_api_json.cpp
class_db_api_json.h
config.py
csharp_script.cpp	Merge pull request #97014 from hayahane/fix_script_property_order	2024-09-19 17:13:34 +02:00
csharp_script.h
Directory.Build.props
Directory.Build.targets
global.json
godotsharp_defs.h
godotsharp_dirs.cpp	C#: Clear existing data directory extracted from PCK	2024-09-12 07:12:01 +08:00
godotsharp_dirs.h
interop_types.h
managed_callable.cpp
managed_callable.h
mono_gc_handle.cpp
mono_gc_handle.h
README.md
register_types.cpp
register_types.h
SCsub	SCons: Add unobtrusive type hints in SCons files	2024-09-25 09:34:35 -05:00
signal_awaiter_utils.cpp
signal_awaiter_utils.h

README.md

How to build and run

Build Godot with the module enabled: module_mono_enabled=yes.
After building Godot, use it to generate the C# glue code:
```
<godot_binary> --generate-mono-glue ./modules/mono/glue
```

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 precision=double argument to scons

When building the NuGet packages, specify --precision=double - for example:

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