godot/modules/mono
Markus Sauermann c4705a590b Fix Object::notification order
Previously the `p_reversed` parameter didn't influence the order
in a correct way.
Also script overridden _notification functions were not called in
the correct order.

To fix this some `notification` functions had to add a `p_reversed`
parameter.

This made it necessary to adjust cpp-bindings.

Co-authored-by: David Snopek <dsnopek@gmail.com>
2023-08-30 00:15:55 +02:00
..
build_scripts
doc_classes
editor Merge pull request #80631 from Repiteo/C#-delegate-docstring 2023-08-16 09:15:50 +02:00
glue C#: Generate instance types for singletons 2023-08-06 00:48:22 +02:00
icons Optimize and fix up some SVGs 2023-08-13 17:48:17 +03:00
mono_gd Show alert if .NET assemblies dir does not exist 2023-08-03 13:52:13 +02:00
thirdparty
utils
__init__.py
.editorconfig
.gitignore
class_db_api_json.cpp
class_db_api_json.h
config.py
csharp_script.cpp Fix Object::notification order 2023-08-30 00:15:55 +02:00
csharp_script.h Fix Object::notification order 2023-08-30 00:15:55 +02:00
Directory.Build.props
Directory.Build.targets
godotsharp_defs.h
godotsharp_dirs.cpp C#: Fix exporting for Android 2023-08-12 09:22:49 +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
signal_awaiter_utils.cpp
signal_awaiter_utils.h

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 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