mirror of https://github.com/godotengine/godot.git synced 2024-11-21 03:18:37 +08:00

History

Raul Santos 24ac82e235 C#: Suppress EventHandler suffix diagnostic for signals Suppress CA1711 for signal delegates because they are used in events so the naming follows the guidelines.		2022-09-22 14:23:01 +02:00
..
build_scripts	Make `push_nupkgs_local` absolute	2022-09-16 10:08:05 +02:00
doc_classes
editor	C#: Suppress EventHandler suffix diagnostic for signals	2022-09-22 14:23:01 +02:00
glue	C#: Rename `PlusFile` to `PathJoin`	2022-09-19 18:25:29 +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	Rename String `plus_file` to `path_join`	2022-08-29 19:38:13 -05:00
__init__.py
.editorconfig
.gitignore
class_db_api_json.cpp
class_db_api_json.h
config.py	C#: Replace libnethost dependency to find hostfxr	2022-09-07 16:36:36 +02:00
csharp_script.cpp	Rename and expose `RefCounted::get_reference_count()`	2022-09-21 21:18:54 +01:00
csharp_script.h	C#: Fix module builds for Windows 32-bit with mingw-w64	2022-09-08 20:57:28 +02:00
Directory.Build.props
Directory.Build.targets
godotsharp_defs.h
godotsharp_dirs.cpp	Rename String `plus_file` to `path_join`	2022-08-29 19:38:13 -05:00
godotsharp_dirs.h
interop_types.h
managed_callable.cpp
managed_callable.h
mono_gc_handle.cpp
mono_gc_handle.h
README.md	Add float arg to build_assemblies.py	2022-09-04 04:02:39 +09:30
register_types.cpp
register_types.h
SCsub
SdkPackageVersions.props
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

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