a91a3d01f8
Scripts that are instantiated at some point will always be recreated if they ever become placeholders to prevent non-tool scripts instantiated manually by users to become placeholders, if they do become placeholders due to errors that prevent instantiation (such as a missing parameterless constructor) these scripts will also be recreated replacing the temporary placeholder. If a script is marked as a tool but becomes a non-tool script in a rebuild, the script will become a placeholder and will no longer be considered applicable to be replaced by an instance since the user explicitly removed the Tool attribute. |
||
|---|---|---|
| .. | ||
| build_scripts | ||
| doc_classes | ||
| editor | ||
| glue | ||
| icons | ||
| mono_gd | ||
| utils | ||
| __init__.py | ||
| .editorconfig | ||
| .gitignore | ||
| class_db_api_json.cpp | ||
| class_db_api_json.h | ||
| config.py | ||
| csharp_script.cpp | ||
| csharp_script.h | ||
| Directory.Build.props | ||
| Directory.Build.targets | ||
| 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 | ||
| SdkPackageVersions.props | ||
| signal_awaiter_utils.cpp | ||
| signal_awaiter_utils.h | ||
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.