godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/mono
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 Doctool: Remove version attribute from XML header 2023-07-06 10:08:21 +02:00
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 Optimize and fix up some SVGs 2023-08-13 17:48:17 +03:00
mono_gd [.NET] Disable output embedding on macOS, move it to the advanced options on other platforms. 2024-04-09 17:47:39 +03:00
thirdparty C#: Replace libnethost dependency to find hostfxr 2022-09-07 16:36:36 +02:00
utils Fix `#if *_ENABLED` inconsistencies, should check if defined 2024-01-17 10:30:15 +01:00
.editorconfig Dotnet: Fix attributes for `sln`/`csproj` files 2024-05-03 12:21:51 -05:00
.gitignore .NET: Generate SdkPackageVersions.props from version.py 2022-10-05 20:31:26 +02:00
Directory.Build.props
…
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 C#: Remove unused code 2024-01-28 16:09:59 +01:00
__init__.py
…
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 One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
config.py C#: Let platforms signal if they support it or not 2024-02-13 22:48:43 +01:00
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
global.json Enforce using .NET SDK >= 8 in modules/mono/ 2024-04-23 22:54:22 +02:00
godotsharp_defs.h One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
godotsharp_dirs.cpp Haiku: Remove remnants of past WIP platform port 2023-09-07 16:37:51 +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 Add methods to get argument count of methods 2024-03-10 11:02:43 +01:00
managed_callable.h Add methods to get argument count of methods 2024-03-10 11:02:43 +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 Style: Harmonize header includes in modules 2023-06-15 14:35:45 +02: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 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