godot/modules/mono
bruvzg 24c4b5e8ad [macOS] Re-add support for the _sc_ inside app bundle. Update docs.
(cherry picked from commit 174e0837e0)
2023-03-27 16:34:57 +02:00
..
build_scripts
doc_classes
editor C#: Get singleton instances using the Core name 2023-03-13 21:56:31 +01:00
glue Bump version to 4.0.1-rc 2023-03-01 14:09:30 +01: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
utils Fix various typos with codespell 2023-01-30 14:22:47 +01:00
.editorconfig
.gitignore
Directory.Build.props
Directory.Build.targets
README.md
SCsub
__init__.py
class_db_api_json.cpp
class_db_api_json.h
config.py
csharp_script.cpp Validate that C# class names are valid identifiers 2023-03-13 21:52:44 +01:00
csharp_script.h Remove unused `ScriptLanguage` methods 2023-02-26 22:30:56 -08:00
godotsharp_defs.h
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
interop_types.h
managed_callable.cpp
managed_callable.h
mono_gc_handle.cpp
mono_gc_handle.h
register_types.cpp
register_types.h
signal_awaiter_utils.cpp
signal_awaiter_utils.h

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