Skip to content

Commit

Permalink
Reword warning about extension compatibility in README
Browse files Browse the repository at this point in the history
GDExtension has limited forwards compatibility available since Godot 4.1,
so the warning, while still relevant, can be made less prominent.
  • Loading branch information
Calinou committed Sep 16, 2024
1 parent 4131b7f commit c29a888
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,20 +49,22 @@ Godot version.**
## Compatibility

> [!WARNING]
>
> The GDExtension API is brand new in Godot 4.0, and is still
considered in **beta** stage, despite Godot 4.0 itself being released.
>
> This applies to both the GDExtension interface header, the API JSON, and this
Due to the intricacies of working with [ABIs](https://en.wikipedia.org/wiki/Application_binary_interface),
compatibility with GDExtension is not as strictly guaranteed as with GDScript or C#.
Current limitations in the GDExtension system may also require compatibility-breaking changes
to be lifted. This applies to both the GDExtension interface header, the API JSON, and this
first-party `godot-cpp` extension.
>
> Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
> get more used, documented, and critical issues get resolved. See the
> [Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension)
> and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues)
> for a list of known issues, and be sure to provide feedback on issues and PRs
> which affect your use of this extension.

In practice, this means that **GDExtension compatibility can occasionally be broken across minor Godot releases**.
Be sure to read the [Migrating](https://docs.godotengine.org/en/latest/tutorials/migrating/index.html)
guide for your current Godot version when running into issues with installing GDExtensions.

Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
get more used, documented, and critical issues get resolved. See the
[Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension)
and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues)
for a list of known issues, and be sure to provide feedback on issues and PRs
which affect your use of this extension.

## Contributing

Expand Down

0 comments on commit c29a888

Please sign in to comment.