Skip to content

Commit 4de929e

Browse files
committed
Reword warning about extension compatibility in README
GDExtension has limited forwards compatibility available since Godot 4.1, so the warning, while still relevant, can be made less prominent.
1 parent 4131b7f commit 4de929e

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -49,20 +49,22 @@ Godot version.**
4949
5050
## Compatibility
5151

52-
> [!WARNING]
53-
>
54-
> The GDExtension API is brand new in Godot 4.0, and is still
55-
considered in **beta** stage, despite Godot 4.0 itself being released.
56-
>
57-
> This applies to both the GDExtension interface header, the API JSON, and this
52+
Due to the intricacies of working with [ABIs](https://en.wikipedia.org/wiki/Application_binary_interface),
53+
compatibility with GDExtension is not as strictly guaranteed as with GDScript or C#.
54+
Current limitations in the GDExtension system may also require compatibility-breaking changes
55+
to be lifted. This applies to both the GDExtension interface header, the API JSON, and this
5856
first-party `godot-cpp` extension.
59-
>
60-
> Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
61-
> get more used, documented, and critical issues get resolved. See the
62-
> [Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension)
63-
> and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues)
64-
> for a list of known issues, and be sure to provide feedback on issues and PRs
65-
> which affect your use of this extension.
57+
58+
In practice, this means that **GDExtension compatibility can occasionally break across minor Godot releases**.
59+
Be sure to read the [Migrating](https://docs.godotengine.org/en/latest/tutorials/migrating/index.html)
60+
guide for your current Godot version when running into issues with installing GDExtensions.
61+
62+
Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
63+
get more used, documented, and critical issues get resolved. See the
64+
[Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension)
65+
and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues)
66+
for a list of known issues, and be sure to provide feedback on issues and PRs
67+
which affect your use of this extension.
6668

6769
## Contributing
6870

0 commit comments

Comments
 (0)