godot/modules/mono
Rémi Verschelde d5064a7d44
Bump version to 4.2.2-rc
2023-12-12 11:03:21 +01:00
..
build_scripts Merge pull request #80489 from raulsntos/dotnet/diagnostics 2023-10-17 23:59:17 +02:00
doc_classes Doctool: Remove version attribute from XML header 2023-07-06 10:08:21 +02:00
editor Bump version to 4.2.2-rc 2023-12-12 11:03:21 +01:00
glue Bump version to 4.2.2-rc 2023-12-12 11:03:21 +01:00
icons Optimize and fix up some SVGs 2023-08-13 17:48:17 +03:00
mono_gd [iOS] Fix dotnet export. 2023-11-16 15:05:44 +02:00
thirdparty
utils Merge pull request #78218 from raulsntos/dotnet/reserved-assembly-name 2023-06-15 15:26:22 +02:00
.editorconfig
.gitignore
Directory.Build.props
Directory.Build.targets
README.md
SCsub C#: Remove old and unused android support code for mono 2023-06-28 22:34:14 +02:00
__init__.py
class_db_api_json.cpp [Modules] Replace `ERR_FAIL_COND` with `ERR_FAIL_NULL` where applicable 2023-09-26 16:44:52 +02:00
class_db_api_json.h
config.py Add C# iOS support 2023-10-09 18:22:56 +02:00
csharp_script.cpp C#: Fail `callp` silently if script is not valid 2023-11-14 16:56:16 +01:00
csharp_script.h Highlight doc comments in a different color 2023-10-08 19:26:10 +03:00
godotsharp_defs.h
godotsharp_dirs.cpp Haiku: Remove remnants of past WIP platform port 2023-09-07 16:37:51 +02:00
godotsharp_dirs.h
interop_types.h
managed_callable.cpp Replace `ERR_FAIL_COND` with `ERR_FAIL_NULL` where applicable 2023-10-08 17:23:33 +02:00
managed_callable.h Style: Harmonize header includes in modules 2023-06-15 14:35:45 +02:00
mono_gc_handle.cpp
mono_gc_handle.h
register_types.cpp Style: Harmonize header includes in modules 2023-06-15 14:35:45 +02:00
register_types.h
signal_awaiter_utils.cpp
signal_awaiter_utils.h Style: Harmonize header includes in modules 2023-06-15 14:35:45 +02:00

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