Skip to content

Add instructions on how to use a pre-compiled GDExtension, + update a link in the GDExtension class reference #10960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+4 −1
Open

Add instructions on how to use a pre-compiled GDExtension, + update a link in the GDExtension class reference #10960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eadbde7
Update index.rst
muno777 May 23, 2025
a8e99d3
Update class_gdextension.rst
muno777 May 23, 2025
8e75a2a
Merge pull request #1 from muno777/patch-1
muno777 May 23, 2025
2ac2ed5
Merge pull request #2 from muno777/patch-2
muno777 May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion classes/class_gdextension.rst
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change needs to be done over here, changing the generated files is not allowed, see here

Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The **GDExtension** resource type represents a `shared library <https://en.wikip
Tutorials
---------

- :doc:`GDExtension overview <../tutorials/scripting/gdextension/what_is_gdextension>`
- :doc:`GDExtension overview <../tutorials/scripting/gdextension/index>`

- :doc:`GDExtension example in C++ <../tutorials/scripting/cpp/gdextension_cpp_example>`

Expand Down
3 changes: 3 additions & 0 deletions tutorials/scripting/gdextension/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ The GDExtension system
native `shared libraries <https://en.wikipedia.org/wiki/Library_(computing)#Shared_libraries>`__
at runtime. You can use it to run native code without compiling it with the engine.

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.
Comment on lines +12 to +13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


.. note:: GDExtension is *not* a scripting language and has no relation to
:ref:`GDScript <doc_gdscript>`.

Expand Down