godot/modules/mono
Rémi Verschelde c9ee508089
Bump version to 4.0.2-rc
2023-03-30 21:41:11 +02:00
..
build_scripts Rename `float=64` SCons option to `precision=double` 2022-12-10 16:43:45 +01:00
doc_classes
editor Bump version to 4.0.2-rc 2023-03-30 21:41:11 +02:00
glue Bump version to 4.0.2-rc 2023-03-30 21:41:11 +02:00
icons
mono_gd C#: Fix editor crashing without a message when .NET is not installed 2023-02-23 13:52:45 +01:00
thirdparty C#: Replace libnethost dependency to find hostfxr 2022-09-07 16:36:36 +02:00
utils Fix various typos with codespell 2023-01-30 14:22:47 +01:00
.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
Directory.Build.props C#: Make GodotSharp API a NuGet package 2022-08-22 03:36:51 +02:00
Directory.Build.targets C#: Generate symbols packages 2022-10-08 13:59:06 +02:00
README.md Rename `float=64` SCons option to `precision=double` 2022-12-10 16:43:45 +01:00
SCsub SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
__init__.py
class_db_api_json.cpp One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
class_db_api_json.h One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
config.py SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
csharp_script.cpp Fix "hides member" warnings in `csharp_script.cpp` 2023-03-27 17:56:20 +02:00
csharp_script.h Remove unused `ScriptLanguage` methods 2023-02-26 22:30:56 -08:00
godotsharp_defs.h One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
godotsharp_dirs.cpp [macOS] Re-add support for the _sc_ inside app bundle. Update docs. 2023-03-27 16:34:57 +02:00
godotsharp_dirs.h One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
interop_types.h One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
managed_callable.cpp One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
managed_callable.h One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
mono_gc_handle.cpp One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
mono_gc_handle.h One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
register_types.cpp One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
register_types.h One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
signal_awaiter_utils.cpp One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
signal_awaiter_utils.h One Copyright Update to rule them all 2023-01-05 13:25:55 +01: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