You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-9Lines changed: 17 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,20 +12,27 @@
12
12
13
13
## Stability
14
14
15
-
The bindings cover most of the exposed API of Godot 3.4, and are being used on a number of projects in development, but we still expect non-trivial breaking changes in the API in the coming releases. godot-rust adheres to [Cargo's semantic versioning](https://doc.rust-lang.org/cargo/reference/semver.html).
15
+
The bindings cover most of the exposed API of Godot 3.5, and are being used on a number of projects in development, but we still expect non-trivial breaking changes in the API in the coming releases. godot-rust adheres to [Cargo's semantic versioning](https://doc.rust-lang.org/cargo/reference/semver.html).
16
16
17
17
Minimum supported Rust version (MSRV) is **1.56**. We use the Rust 2021 Edition.
18
18
19
19
## Engine compatibility
20
20
21
-
We are committed to keeping compatibility with the latest stable patch releases of all minor versions of the engine, starting from Godot 3.2:
22
-
* Godot 3.4 (works out-of-the-box)
23
-
* Godot 3.3 (needs feature `custom-godot`)
24
-
* Godot 3.2 (needs feature `custom-godot`)
21
+
Due to GDNative API not strictly following SemVer and some concepts not mapping 1:1 to Rust (default parameters),
22
+
it is difficult for a godot-rust version to remain compatible with multiple Godot versions simultaneously.
25
23
26
-
For versions 3.2 and 3.3, some extra steps are needed, see _Custom builds_ below.
24
+
However, we support the latest stable Godot 3 minor release out-of-the-box, and allow to easily use custom engine
25
+
versions using the `custom-godot` feature flag (see [below](#Custom builds)).
27
26
28
-
The bindings do _**not**_ support in-development Godot 4 versions at the moment. Support is planned as the native extensions become more stable.
27
+
Compatibility list:
28
+
29
+
* Godot 3.5.1 (works with gdnative 0.11)
30
+
* Godot 3.4 (works with gdnative 0.10, custom build for 0.11)
31
+
* Godot 3.3 (custom build)
32
+
* Godot 3.2 (custom build)
33
+
34
+
The bindings do _**not**_ support in-development Godot 4 versions.
35
+
A GDExtension binding is planned.
29
36
30
37
31
38
## Getting started
@@ -38,7 +45,7 @@ This is the recommended way of using godot-rust. After `bindgen` dependencies an
38
45
39
46
```toml
40
47
[dependencies]
41
-
gdnative = "0.10.1"
48
+
gdnative = "0.11"
42
49
43
50
[lib]
44
51
crate-type = ["cdylib"]
@@ -59,7 +66,8 @@ crate-type = ["cdylib"]
59
66
60
67
### Custom builds
61
68
62
-
To use the bindings with a different Godot version or a custom build of the engine, see [Custom Godot builds](https://godot-rust.github.io/book/advanced-guides/custom-godot.html) in the user guide.
69
+
To use the bindings with a different Godot version or a custom build of the engine, see
70
+
[Custom Godot builds](https://godot-rust.github.io/book/advanced-guides/custom-godot.html) in the user guide.
0 commit comments