Add instructions on how to use a pre-compiled GDExtension, + update a link in the GDExtension class reference #10960
+4
−1
Conversation
This file contains hidden or 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
Update index.rst
Update class_gdextension.rst
Calinou
added
enhancement
area:manual
AThousandShips
requested changes
Jun 11, 2025
dsnopek
reviewed
Jun 11, 2025
Comment on lines
+12
to
+13
| In order to use a pre-compiled GDExtension in your Godot project, place the `.gdextension` file somewhere inside your | ||
| project's directory. Godot will then load the extension and you should be able to use it in your project. |
There was a problem hiding this comment.
I think some folks may interpret this to mean that you only need to copy in the .gdextension file and nothing else.
Maybe something like:
Suggested change
| In order to use a pre-compiled GDExtension in your Godot project, place the `.gdextension` file somewhere inside your | |
| project's directory. Godot will then load the extension and you should be able to use it in your project. | |
| In order to use a pre-compiled GDExtension in your Godot project, place all the files (including the `.gdextension` file) somewhere inside your | |
| project's directory. Godot will then load the extension and you should be able to use it in your project. |
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.
Currently, a Godot end-user who downloaded a pre-made GDExtension (such as SG Physics 2D) would struggle to find out how to use it in their own project. These instructions are not listed anywhere, and the current GDExtension docs only cater to people writing a GDExtension.
This PR adds a short section to the main GDExtension page describing this, and also changes the link in the GDExtension class doc to lead to the main GDExtension page instead of a sub-page.
Addresses #9277.