diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 22 insertions, 13 deletions
@@ -42,12 +42,15 @@ so formatting is done before your changes are submitted. ## Getting Started -It's a bit similar to what it was for 3.x but also a bit different. This new approach is much more akin to how core Godot modules are structured. +It's a bit similar to what it was for 3.x but also a bit different. +This new approach is much more akin to how core Godot modules are structured. Compiling this repository generates a static library to be linked with your shared lib, just like before. -To use the shared lib in your Godot project you'll need a `.gdextension` file, which replaces what was the `.gdnlib` before. Follow the example: +To use the shared lib in your Godot project you'll need a `.gdextension` +file, which replaces what was the `.gdnlib` before. +Follow [the example](test/demo/example.gdextension): ```ini [configuration] @@ -56,15 +59,17 @@ entry_symbol = "example_library_init" [libraries] -linux.64.debug = "bin/libgdexample.linux.debug.64.so" -linux.64.release = "bin/libgdexample.linux.release.64.so" -windows.64.debug = "bin/libgdexample.windows.debug.64.dll" -windows.64.release = "bin/libgdexample.windows.release.64.dll" -macos.debug = "bin/libgdexample.debug.framework" -macos.release = "bin/libgdexample.release.framework" +macos.debug = "bin/libgdexample.osx.debug.framework" +macos.release = "bin/libgdexample.osx.release.framework" +windows.debug.x86_64 = "bin/libgdexample.windows.debug.x86_64.dll" +windows.release.x86_64 = "bin/libgdexample.windows.release.x86_64.dll" +linux.debug.x86_64 = "bin/libgdexample.linux.debug.x86_64.so" +linux.release.x86_64 = "bin/libgdexample.linux.release.x86_64.so" +# Repeat for other architectures to support arm64, rv64, etc. ``` -The `entry_symbol` is the name of the function that initializes your library. It should be similar to following layout: +The `entry_symbol` is the name of the function that initializes +your library. It should be similar to following layout: ```cpp extern "C" { @@ -74,19 +79,23 @@ extern "C" { GDNativeBool GDN_EXPORT example_library_init(const GDNativeInterface *p_interface, const GDNativeExtensionClassLibraryPtr p_library, GDNativeInitialization *r_initialization) { godot::GDExtensionBinding::InitObject init_obj(p_interface, p_library, r_initialization); - init_obj.register_scene_initializer(register_example_types); - init_obj.register_scene_terminator(unregister_example_types); + init_obj.register_initializer(initialize_example_module); + init_obj.register_terminator(uninitialize_example_module); + init_obj.set_minimum_library_initialization_level(MODULE_INITIALIZATION_LEVEL_SCENE); return init_obj.init(); } } ``` -The `register_example_types()` should register the classes in ClassDB, very like a Godot module would do. +The `initialize_example_module()` should register the classes in ClassDB, very like a Godot module would do. ```cpp using namespace godot; -void register_example_types() { +void initialize_example_module(ModuleInitializationLevel p_level) { + if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) { + return; + } ClassDB::register_class<Example>(); } ``` |