LibGodot with GDExtension #72883

Faolan-Rad · 2023-02-08T10:57:09Z

LibGodot is a system to allows Godot to be compiled as a library and connected into it using GDExtensions by giving a function pointer to the entry point of a GDExtension implementation before starting Godot.

LibGodot adds language support for languages that have C support but can not becompiled into a shared library.

LibGodot allows the use of different C# runtimes allowing dotnetAOT compilation, C# android support, and C# web support.

LibGodot also allows Godot to be embedded in other applications like Blender.

lyuma · 2023-02-08T11:00:54Z

Related to #68153 - this provides a means of loading the Godot Engine from a standard .NET 6 android project

Zireael07 · 2023-02-08T13:21:29Z

Is this slated for 4.1 or 4.0?

YuriSizov · 2023-02-08T13:23:18Z

@Zireael07 You can see the milestone :) Nothing of the sort is going into 4.0 at this point. We're done with features.

Zireael07 · 2023-02-08T13:37:58Z

Ah. Right. Mobile GitHub and my poor eyesight are to blame.

Calinou · 2023-02-08T13:42:12Z

Does this address godotengine/godot-proposals#4773?

Faolan-Rad · 2023-02-08T13:54:31Z

It does for the most part the thing it doesn't do is allow someone using the Library to manually tell Godot to update

core/libgodot/libgodot.cpp

fire · 2023-02-10T22:47:14Z

We discussed out-of-band how that @Faolan-Rad should tell us the story of his need for this feature and how this can benefit the wider community of C#, other languages and XR.

TL;DR: pending a new proposal.

fire · 2023-02-12T05:12:11Z

The update problem was avoided by having the libgodot user make a gdextension and have it block in the gdextension class like the "_process" method.

Benefits

Avoids stepping the MainLoop.
Avoids handling synchronization when two different functions are called externally.

neikeq · 2023-02-12T14:42:02Z

Regarding C#:

No work has started yet for porting to mobile, so I can't say what will be needed. If we can't find a better solution, we would have to go with a C# project as entry-point and Godot as a shared library. However, there's actually hope that .NET 8 or 9 could allow publishing mobile projects as libraries, which would simplify things for us.

@Faolan-Rad

* Add a new GodotInstance GDCLASS that provides startup, shutdown and iteration commands * Add a new GDExtension entry point that creates a new Godot instance and returns a GodotInstance object. * This object can be used to control the GodotInstance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com> Co-Authored-By: K. S. Ernest (iFire) Lee <ernest.lee@chibifire.com>

@Faolan-Rad

* Based on top of the GDExtensionLoader PR: godotengine#91166 * Add a new GodotInstance GDCLASS that provides startup and iteration commands to control a Godot instance. * Adds a libgodot_create_godot_instance entry point that creates a new Godot instance and returns a GodotInstance object. * Adds a libgodot_destroy_godot_instance entry point that destroys the Godot instance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com>

@Faolan-Rad

* Based on top of the GDExtensionLoader PR: godotengine#91166 * Add a new GodotInstance GDCLASS that provides startup and iteration commands to control a Godot instance. * Adds a libgodot_create_godot_instance entry point that creates a new Godot instance and returns a GodotInstance object. * Adds a libgodot_destroy_godot_instance entry point that destroys the Godot instance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com>

GeorgeS2019 · 2024-07-12T20:18:23Z

@Faolan-Rad
@JiepengTan

Still on the TODO list:
#90510 (comment)

Windows build

Fix CI builds

Create a .NET/C# example using the new GDExtension-based .NET implementation.

[WIP] Windows platform: libgodot.dll

The libgodot.dll comes from

library_type=shared_library

scons platform=windows target=template_debug arch=x86_64 verbose=yes msvc=yes library_type=shared_library dev_build=yes debug_symbols=yes

bin\ godot.windows.template_debug.dev.x86_64.dll

scons platform=windows arch=x86_64 verbose=yes msvc=yes dev_build=yes debug_symbols=yes

bin\ godot.windows.editor.dev.x86_64.exe --dump-extension-api

With this, provide the json and the dll to the godot-dotnet project.

bin\ extension_api.json
bin\ godot.windows.template_debug.dev.x86_64.dll

The output will be c# wrappers for the godot.windows.template_debug.dev.x86_64.dll

Users can then write c# applications to embed godot as a library in .NET applications

Very similar to: LibGodotSharp

@Faolan-Rad

* Add a new GodotInstance GDCLASS that provides startup, shutdown and iteration commands * Add a new GDExtension entry point that creates a new Godot instance and returns a GodotInstance object. * This object can be used to control the GodotInstance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS * Currently supported on Windows Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com> Co-Authored-By: K. S. Ernest (iFire) Lee <ernest.lee@chibifire.com>

@Faolan-Rad

* Based on top of the GDExtensionLoader PR: godotengine#91166 * Add a new GodotInstance GDCLASS that provides startup and iteration commands to control a Godot instance. * Adds a libgodot_create_godot_instance entry point that creates a new Godot instance and returns a GodotInstance object. * Adds a libgodot_destroy_godot_instance entry point that destroys the Godot instance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com>

@Faolan-Rad

* Based on top of the GDExtensionLoader PR: godotengine#91166 * Add a new GodotInstance GDCLASS that provides startup and iteration commands to control a Godot instance. * Adds a libgodot_create_godot_instance entry point that creates a new Godot instance and returns a GodotInstance object. * Adds a libgodot_destroy_godot_instance entry point that destroys the Godot instance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com>

@Faolan-Rad

* Based on top of the GDExtensionLoader PR: godotengine#91166 * Add a new GodotInstance GDCLASS that provides startup and iteration commands to control a Godot instance. * Adds a libgodot_create_godot_instance entry point that creates a new Godot instance and returns a GodotInstance object. * Adds a libgodot_destroy_godot_instance entry point that destroys the Godot instance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com>

@Faolan-Rad

* Based on top of the GDExtensionLoader PR: godotengine#91166 * Add a new GodotInstance GDCLASS that provides startup and iteration commands to control a Godot instance. * Adds a libgodot_create_godot_instance entry point that creates a new Godot instance and returns a GodotInstance object. * Adds a libgodot_destroy_godot_instance entry point that destroys the Godot instance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com>

@Faolan-Rad

* Based on top of the GDExtensionLoader PR: godotengine#91166 * Add a new GodotInstance GDCLASS that provides startup and iteration commands to control a Godot instance. * Adds a libgodot_create_godot_instance entry point that creates a new Godot instance and returns a GodotInstance object. * Adds a libgodot_destroy_godot_instance entry point that destroys the Godot instance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com>

@Faolan-Rad

* Based on top of the GDExtensionLoader PR: godotengine#91166 * Add a new GodotInstance GDCLASS that provides startup and iteration commands to control a Godot instance. * Adds a libgodot_create_godot_instance entry point that creates a new Godot instance and returns a GodotInstance object. * Adds a libgodot_destroy_godot_instance entry point that destroys the Godot instance. * Allow specifying an external native rendering surface handle to render Godot into the UI of a host application. * It is also possible to embed multiple Godot windows into the UI of a host application. * Currently supported on MacOS and iOS Sample Apps: https://github.com/migeran/libgodot_project Developed by [Migeran](https://migeran.com) Sponsors & Acknowledgements: * Initial development sponsored by [Smirk Software](https://www.smirk.gg/) * Rebasing to Godot 4.3 and further development sponsored by [Xibbon Inc.](https://xibbon.com) * The GDExtension registration of the host process & build system changes were based on @Faolan-Rad's LibGodot PR: godotengine#72883 Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com>

Faolan-Rad requested review from a team as code owners February 8, 2023 10:57

Faolan-Rad force-pushed the LibGodot branch 3 times, most recently from 4a2f8bf to 62fb86e Compare February 8, 2023 11:32

akien-mga added feature proposal topic:gdextension labels Feb 8, 2023

akien-mga added this to the 4.x milestone Feb 8, 2023

Faolan-Rad force-pushed the LibGodot branch 3 times, most recently from b1f7a78 to 1a1bbf7 Compare February 8, 2023 12:21

fire reviewed Feb 8, 2023

View reviewed changes

core/libgodot/libgodot.cpp Outdated Show resolved Hide resolved

Faolan-Rad mentioned this pull request Feb 11, 2023

Add a build-time option to compile Godot as a shared library (for use in other languages) godotengine/godot-proposals#6267

Open

Faolan-Rad force-pushed the LibGodot branch from 1a1bbf7 to 04afaf1 Compare February 11, 2023 08:46

Faolan-Rad requested a review from a team as a code owner February 11, 2023 08:46

Faolan-Rad force-pushed the LibGodot branch from 04afaf1 to c4e1652 Compare February 11, 2023 08:53

GeorgeS2019 mentioned this pull request Jul 12, 2024

Possible to create .NET csharp example illustrating the use case below? migeran/libgodot_project#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LibGodot with GDExtension #72883

LibGodot with GDExtension #72883

Faolan-Rad commented Feb 8, 2023

lyuma commented Feb 8, 2023

Zireael07 commented Feb 8, 2023 •

edited

Loading

YuriSizov commented Feb 8, 2023

Zireael07 commented Feb 8, 2023

Calinou commented Feb 8, 2023

Faolan-Rad commented Feb 8, 2023

fire commented Feb 10, 2023

fire commented Feb 12, 2023 •

edited

Loading

neikeq commented Feb 12, 2023

GeorgeS2019 commented Jul 12, 2024 •

edited

Loading

LibGodot with GDExtension #72883

Are you sure you want to change the base?

LibGodot with GDExtension #72883

Conversation

Faolan-Rad commented Feb 8, 2023

lyuma commented Feb 8, 2023

Zireael07 commented Feb 8, 2023 • edited Loading

YuriSizov commented Feb 8, 2023

Zireael07 commented Feb 8, 2023

Calinou commented Feb 8, 2023

Faolan-Rad commented Feb 8, 2023

fire commented Feb 10, 2023

fire commented Feb 12, 2023 • edited Loading

Benefits

neikeq commented Feb 12, 2023

GeorgeS2019 commented Jul 12, 2024 • edited Loading

[WIP] Windows platform: libgodot.dll

Zireael07 commented Feb 8, 2023 •

edited

Loading

fire commented Feb 12, 2023 •

edited

Loading

GeorgeS2019 commented Jul 12, 2024 •

edited

Loading