mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00

History

Rémi Verschelde 4b070e8031 Fix various typos with codespell Using 2.2.7.dev217+g10c2abcf. Had to add `colour` to the ignore list as we used it as an alias/keyword for the documentation of color-related APIs. Also ignore recommendations to change `thirdparty` to either `third-party` or `third party`, which are correct but we use the former fairly consistently.		2024-05-07 10:08:42 +02:00
..
build_scripts	Enforce using .NET SDK >= 8 in modules/mono/	2024-04-23 22:54:22 +02:00
doc_classes
editor	Reduce and prevent unnecessary random-access to `List`	2024-05-04 16:08:55 +02:00
glue	Fix various typos with codespell	2024-05-07 10:08:42 +02:00
icons
mono_gd
thirdparty
utils
__init__.py
.editorconfig	Dotnet: Fix attributes for `sln`/`csproj` files	2024-05-03 12:21:51 -05:00
.gitignore
class_db_api_json.cpp	Reduce and prevent unnecessary random-access to `List`	2024-05-04 16:08:55 +02:00
class_db_api_json.h
config.py
csharp_script.cpp	Merge pull request #90968 from raulsntos/fix-gdscript-analyzer-with-overloaded-dotnet-methods	2024-04-22 12:53:47 +02:00
csharp_script.h	Organize existing code for editor plugins	2024-04-27 11:59:58 -07:00
Directory.Build.props
Directory.Build.targets
global.json	Enforce using .NET SDK >= 8 in modules/mono/	2024-04-23 22:54:22 +02:00
godotsharp_defs.h
godotsharp_dirs.cpp
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

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