Add documentation about .gdextension file #9383
Open
+142
−17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
paddy-exe
added
content:new page
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
2b73f33
to
f567fa1
Compare
dsnopek
reviewed
May 17, 2024
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
b47f96d
to
90e7155
Compare
aaronfranke
reviewed
May 17, 2024
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
90e7155
to
ac065d9
Compare
aaronfranke
reviewed
May 17, 2024
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
ac065d9
to
91b93c8
Compare
mhilbrunner
approved these changes
May 19, 2024
RedMser
reviewed
May 27, 2024
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
91b93c8
to
cea6ef0
Compare
|
Thanks for the feedback! Should be good now |
Update tutorials/scripting/gdextension/gdextension_file.rst
paddy-exe
force-pushed
the
gdextension-file-quick-reference
branch
from
cea6ef0
to
ecc21c6
Compare
|
Updated to feedback, added another sections about icons support and removed the icons section from the Example page as it makes no sense to have it double |
dsnopek
reviewed
May 30, 2024
Comment on lines
+20
to
+21
| | **entry_symbol** | Name of the entry function for initializing the GDExtension. This function should be defined in | | ||
| | | the ``register_types.cpp`` file. Adding this is necessary for the extension to work. | |
There was a problem hiding this comment.
The note about register_types.cpp is only for godot-cpp. Maybe something like:
Suggested change
| | **entry_symbol** | Name of the entry function for initializing the GDExtension. This function should be defined in | | |
| | | the ``register_types.cpp`` file. Adding this is necessary for the extension to work. | | |
| | **entry_symbol** | Name of the entry function for initializing the GDExtension. This function should be defined in | | |
| | | the ``register_types.cpp`` file when using godot-cpp. Adding this is necessary for the extension to work. | |
| | | depend on features from newer versions of Godot. **Only supported for Godot 4.1+** | | ||
| +-------------------------------+------------------------------------------------------------------------------------------------------+ | ||
| | **compatibility_maximum** | Maximum compatible version. This prevents newer versions of Godot from loading the extension. | | ||
| | | **Only supported for Godot 4.3+** | |
There was a problem hiding this comment.
Suggested change
| | | **Only supported for Godot 4.3+** | | |
| | | **Only supported in Godot 4.3+** | |
There was a problem hiding this comment.
"or later" might also be good to add.
| | | the ``register_types.cpp`` file. Adding this is necessary for the extension to work. | | ||
| +-------------------------------+------------------------------------------------------------------------------------------------------+ | ||
| | **compatibility_minimum** | Minimum compatible version. This prevents older versions of Godot from loading extensions that | | ||
| | | depend on features from newer versions of Godot. **Only supported for Godot 4.1+** | |
There was a problem hiding this comment.
Suggested change
| | | depend on features from newer versions of Godot. **Only supported for Godot 4.1+** | | |
| | | depend on features from newer versions of Godot. **Only supported in Godot 4.1+** | |
Comment on lines
+29
to
+30
| | **reloadable** | Reloads the extension upon recompilation. Reloading is not supported for every exposed class. | | ||
| | | This flag should be mainly used for developing or debugging an extension. | |
There was a problem hiding this comment.
What is meant by "Reloading is not supported for every exposed class"? It should work for any class, although, some can have additional considerations, for example, editor plugins.
It may be worth pointing out that not all GDExtension bindings support it? We could mention that godot-cpp for Godot 4.2+ does - I'm not sure it makes sense trying to list other bindings, because that list will always be growing
| | **reloadable** | Reloads the extension upon recompilation. Reloading is not supported for every exposed class. | | ||
| | | This flag should be mainly used for developing or debugging an extension. | | ||
| +-------------------------------+------------------------------------------------------------------------------------------------------+ | ||
| | **android_aar_plugin** | The GDExtension is part of a :ref:`v2 Android plugin <doc_android_plugin>`. During export this flag | |
There was a problem hiding this comment.
It's not clear from this description that this is a boolean property. Perhaps we should be listing the type for each property?
| --------------------- | ||
|
|
||
| +-------------------------------+------------------------------------------------------------------------------------------------------+ | ||
| | Instruction | Description | |
There was a problem hiding this comment.
I'm not sure about calling these "Instruction"s. Maybe "Property" instead?
Suggested change
| | Instruction | Description | | |
| | Property | Description | |
| ----------------- | ||
|
|
||
| In this section you can set the paths to the compiled binaries of your GDExtension libraries. | ||
| By setting feature flags you can filter which version should be loaded and exported with your |
There was a problem hiding this comment.
Suggested change
| By setting feature flags you can filter which version should be loaded and exported with your | |
| By specifying feature flags you can filter which version should be loaded and exported with your |
| In this section you can set the paths to the compiled binaries of your GDExtension libraries. | ||
| By setting feature flags you can filter which version should be loaded and exported with your | ||
| game depending on which feature flags are active. Every feature flag must match to Godot's | ||
| feature flags or your custom export flags to run in an exported game. For instance ``macos.debug`` |
There was a problem hiding this comment.
Suggested change
| feature flags or your custom export flags to run in an exported game. For instance ``macos.debug`` | |
| feature flags or your custom export flags to be loaded in an exported game. For instance ``macos.debug`` |
| linux.release.rv64 = "res://bin/libgdexample.linux.template_release.rv64.so" | ||
|
|
||
|
|
||
| Here are lists of available built-in options (for more look at the :ref:`feature tags <doc_feature_tags>`): |
There was a problem hiding this comment.
Suggested change
| Here are lists of available built-in options (for more look at the :ref:`feature tags <doc_feature_tags>`): | |
| Here are lists of some of the available built-in options (for more look at the :ref:`feature tags <doc_feature_tags>`): |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a WIP draft in the effort to improve the GDExtension docs for users
Adds details how to configure the
.gdextensionfile and aids as a quick reference guide to add support for platforms