Skip to content

Commit e31e15b

Browse files
committed
Add compatibility warning: godot-cpp is still in beta
1 parent 1f1a373 commit e31e15b

File tree

1 file changed

+30
-15
lines changed

1 file changed

+30
-15
lines changed

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,30 @@
22

33
> **Warning**
44
>
5-
> This repository's `master` branch is only usable with Godot 4.0 ([GDExtension](https://godotengine.org/article/introducing-gd-extensions)).
5+
> This repository's `master` branch is only usable with Godot's ([GDExtension](https://godotengine.org/article/introducing-gd-extensions))
6+
> API (Godot 4.0 and later).
67
>
7-
> Switch to the [`3.5` branch](https://github.com/godotengine/godot-cpp/tree/3.5)
8-
> if using Godot 3.5.x with GDNative,
9-
> or the [`3.x` branch](https://github.com/godotengine/godot-cpp/tree/3.x)
10-
> if using the Godot 3.x development branch with GDNative.
8+
> For GDNative users (Godot 3.x), switch to the [`3.x`](https://github.com/godotengine/godot-cpp/tree/3.x)
9+
> or the [`3.5`](https://github.com/godotengine/godot-cpp/tree/3.5) branch.
1110
1211
This repository contains the *C++ bindings* for the [**Godot Engine**](https://github.com/godotengine/godot)'s GDExtensions API.
1312

1413
- [**Versioning**](#versioning)
14+
- [**Compatibility**](#compatibility)
1515
- [**Contributing**](#contributing)
16-
- [**Getting Started**](#getting-started)
17-
- [**Included Example**](#included-example)
16+
- [**Getting started**](#getting-started)
17+
- [**Included example**](#included-example)
1818

1919
## Versioning
2020

2121
This repositories follows the same branch versioning as the main [Godot Engine
2222
repository](https://github.com/godotengine/godot):
2323

24-
- `master` tracks the current development branch.
25-
- `3.x` tracks the development of the next 3.x minor release.
26-
- Other versioned branches (e.g. `3.3`, `3.2`) track the latest stable release
24+
- `master` tracks the current GDExtension development branch for the next Godot
25+
4.x minor release.
26+
- `3.x` tracks the development of the GDNative plugin for the next 3.x minor
27+
release.
28+
- Other versioned branches (e.g. `4.0`, `3.5`) track the latest stable release
2729
in the corresponding branch.
2830

2931
Stable releases are also tagged on this repository:
@@ -37,18 +39,31 @@ Godot version.**
3739
> using `godot-cpp` against a more current version of Godot, see the instructions
3840
> in the `gdextension` folder to update the relevant files.
3941
42+
## Compatibility
43+
44+
**Warning:** The GDExtension API is brand new in Godot 4.0, and is still
45+
considered in **beta** stage, despite Godot 4.0 itself being released.
46+
47+
This applies to both the GDExtension interface header, the API JSON, and this
48+
first-party `godot-cpp` extension.
49+
50+
Some compatibility breakage is to be expected as GDExtension and `godot-cpp`
51+
get more used, documented, and critical issues get resolved. See the
52+
[issue tracker](https://github.com/godotengine/godot/issues) for a list of known
53+
issues, and be sure to provide feedback on issues and PRs which affect your use
54+
of this extension.
55+
4056
## Contributing
4157

4258
We greatly appreciate help in maintaining and extending this project. If you
4359
wish to help out, ensure you have an account on GitHub and create a "fork" of
44-
this repository. Rémi "Akien" Verschelde wrote an excellent bit of documentation
45-
for the main Godot project on this:
46-
[Pull request workflow](https://docs.godotengine.org/en/stable/community/contributing/pr_workflow.html)
60+
this repository. See [Pull request workflow](https://docs.godotengine.org/en/stable/community/contributing/pr_workflow.html)
61+
for instructions.
4762

4863
Please install clang-format and copy the files in `misc/hooks` into `.git/hooks`
4964
so formatting is done before your changes are submitted.
5065

51-
## Getting Started
66+
## Getting started
5267

5368
It's a bit similar to what it was for 3.x but also a bit different.
5469
This new approach is much more akin to how core Godot modules are structured.
@@ -110,6 +125,6 @@ void initialize_example_module(ModuleInitializationLevel p_level) {
110125

111126
Any node and resource you register will be available in the corresponding `Create...` dialog. Any class will be available to scripting as well.
112127

113-
## Included Example
128+
## Included example
114129

115130
Check the project in the `test` folder for an example on how to use and register different things.

0 commit comments

Comments
 (0)