Skip to content

Commit 5c99fd3

Browse files
committed
Update GDExtension C++ tutorial to explain compatibility and point out Godot 4.1 breakage
1 parent 87dbe4a commit 5c99fd3

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

tutorials/scripting/gdextension/gdextension_cpp_example.rst

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,23 @@ Note that this repository has different branches for different versions
3333
of Godot. GDExtensions will not work in older versions of Godot (only Godot 4 and up) and vice versa, so make sure you download the correct branch.
3434

3535
.. note::
36-
3736
To use `GDExtension <https://godotengine.org/article/introducing-gd-extensions>`__
38-
you need to use the ``4.0`` branch or later of godot-cpp.
39-
Godot 4.1 is being used here as an example.
40-
The ``master`` branch is the development branch and is being updated
41-
regularly to work with godot's ``master`` branch.
37+
you need to use the godot-cpp branch that matches the version of Godot that you are
38+
targeting. For example, if you're targeting Godot 4.1, use the ``4.1`` branch,
39+
which is what is shown through out this tutorial.
40+
41+
The ``master`` branch is the development branch which is updated regularly
42+
to work with Godot's ``master`` branch.
43+
44+
.. warning::
45+
Our long-term goal is that GDExtensions targeting an earlier version of Godot will work
46+
in later minor versions, but not vice-versa. For example, a GDExtension targeting Godot 4.2
47+
should work just fine in Godot 4.3, but one targeting Godot 4.3 won't work in Godot 4.2.
48+
49+
However, GDExtension is currently *experimental*, which means that we may break compatibility
50+
in order to fix major bugs or include critical features. For example, GDExtensions created
51+
for Godot 4.0 aren't compatible with Godot 4.1
52+
(see :ref:`updating_your_gdextension_for_godot_4_1`).
4253

4354
If you are versioning your project using Git, it is recommended to add it as
4455
a Git submodule:

0 commit comments

Comments
 (0)