seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

LibGodot: Core - Build Godot Engine as a Library

Browse Source 
* 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.

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: https://github.com/godotengine/godot/pull/72883
* Thanks to Ben Rog-Wilhelm (Zorbathut) for creating a smaller, minimal version for easier review.
* Thanks to Ernest Lee (iFire) for his support

Co-Authored-By: Gabor Koncz <gabor.koncz@migeran.com>
Co-Authored-By: Ben Rog-Wilhelm <zorba-github@pavlovian.net>
This commit is contained in:
Gergely Kis
2025-09-24 06:36:20 +02:00
parent c01c7b800d
commit 6c44c80c62
23 changed files with 752 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
platform/windows/SCsub
View File

@ -13,7 +13,6 @@ from methods import redirect_emitter
sources = []
common_win = [
"godot_windows.cpp",
"os_windows.cpp",
"display_server_windows.cpp",
"key_mapping_windows.cpp",
@ -28,6 +27,11 @@ common_win = [
"drop_target_windows.cpp",
]
if env["library_type"] == "executable":
common_win += ["godot_windows.cpp"]
else:
common_win += ["libgodot_windows.cpp"]
if env.msvc:
common_win += ["crash_handler_windows_seh.cpp"]
else:
@ -39,7 +43,7 @@ common_win_wrap = [
env_wrap = env.Clone()
if env["arch"] == "x86_64":
if env["arch"] == "x86_64" and env["library_type"] == "executable":
env_cpp_check = env.Clone()
env_cpp_check.add_source_files(sources, ["cpu_feature_validation.c"])
if env.msvc:
@ -76,7 +80,12 @@ sources += res_obj
if env["accesskit"] and not env.msvc:
sources += env.DEFLIB("uiautomationcore")
prog = env.add_program("#bin/godot", sources, PROGSUFFIX=env["PROGSUFFIX"])
if env["library_type"] == "static_library":
prog = env.add_library("#bin/godot", sources, PROGSUFFIX=env["PROGSUFFIX"])
elif env["library_type"] == "shared_library":
prog = env.add_shared_library("#bin/godot", sources, PROGSUFFIX=env["PROGSUFFIX"])
else:
prog = env.add_program("#bin/godot", sources, PROGSUFFIX=env["PROGSUFFIX"])
arrange_program_clean(prog)
env.Depends(prog, "godot.manifest")

4
platform/windows/detect.py
View File

@ -233,7 +233,7 @@ def get_flags():
return {
"arch": arch,
"supported": ["d3d12", "dcomp", "mono", "xaudio2"],
"supported": ["d3d12", "dcomp", "library", "mono", "xaudio2"],
}
@ -243,7 +243,7 @@ def configure_msvc(env: "SConsEnvironment"):
## Build type
# TODO: Re-evaluate the need for this / streamline with common config.
if env["target"] == "template_release":
if env["target"] == "template_release" and env["library_type"] == "executable":
env.Append(LINKFLAGS=["/ENTRY:mainCRTStartup"])
if env["windows_subsystem"] == "gui":

71
platform/windows/libgodot_windows.cpp Normal file
View File

@ -0,0 +1,71 @@
/**************************************************************************/
/* libgodot_windows.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#include "core/extension/libgodot.h"
#include "core/extension/godot_instance.h"
#include "main/main.h"
#include "os_windows.h"
static OS_Windows *os = nullptr;
static GodotInstance *instance = nullptr;
GDExtensionObjectPtr libgodot_create_godot_instance(int p_argc, char *p_argv[], GDExtensionInitializationFunction p_init_func) {
ERR_FAIL_COND_V_MSG(instance != nullptr, nullptr, "Only one Godot Instance may be created at a time.");
os = new OS_Windows(GetModuleHandle(nullptr));
Error err = Main::setup(p_argv[0], p_argc - 1, &p_argv[1], false);
if (err != OK) {
return nullptr;
}
instance = memnew(GodotInstance);
if (!instance->initialize(p_init_func)) {
memdelete(instance);
instance = nullptr;
return nullptr;
}
return (GDExtensionObjectPtr)instance;
}
void libgodot_destroy_godot_instance(GDExtensionObjectPtr p_godot_instance) {
GodotInstance *godot_instance = (GodotInstance *)p_godot_instance;
if (instance == godot_instance) {
godot_instance->stop();
memdelete(godot_instance);
// Note: When Godot Engine supports reinitialization, clear the instance pointer here.
//instance = nullptr;
Main::cleanup();
}
}