|
4 | 4 |
|
5 | 5 | [](https://docs.rs/gdnative)
|
6 | 6 |
|
7 |
| -Rust bindings to the [Godot game engine](http://godotengine.org/). |
8 | 7 |
|
9 |
| -**[Website](https://godot-rust.github.io/)** | |
10 |
| -**[User Guide](https://godot-rust.github.io/book/)** | **[API Documentation](https://docs.rs/gdnative/0.9.3/gdnative/)** |
| 8 | +**[Website](https://godot-rust.github.io)** | |
| 9 | +**[User Guide](https://godot-rust.github.io/book)** | **[Stable Docs](https://docs.rs/gdnative)** | **[Latest Docs](https://godot-rust.github.io/docs)** |
| 10 | + |
| 11 | +**godot-rust** is a Rust library that implements native bindings for the [Godot game engine](http://godotengine.org/). This allows you to develop games or other applications in Godot, while benefiting from Rust's strengths, such as its type system, scalability and performance. |
11 | 12 |
|
12 | 13 | ## Stability
|
13 | 14 |
|
14 |
| -The bindings cover most of the exposed API of Godot 3.2, 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. |
| 15 | +The bindings cover most of the exposed API of Godot 3.2, 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 | 16 |
|
16 | 17 | ## Engine compatibility
|
17 | 18 |
|
18 |
| -We are serious about engine compatibility. We are committed to keeping compatibility with the latest stable patch releases of all minor versions of the engine, starting from Godot 3.2. |
| 19 | +We are committed to keeping compatibility with the latest stable patch releases of all minor versions of the engine, starting from Godot 3.2. |
19 | 20 |
|
20 |
| -The current minimum compatible version, with `api.json` replacement, is Godot 3.2-stable. Changes to this will be considered a breaking change, and will be called out in the release notes. |
| 21 | +The current minimum compatible version, with `api.json` replacement, is Godot 3.2. Godot 3.3 is supported as well. Changes to this will be considered a breaking change, and will be called out in the release notes. |
21 | 22 |
|
22 |
| -The bindings do *not* support Godot 4.0 (`master` branch) currently. |
| 23 | +The bindings do _**not**_ support Godot 4.0 currently. Support is planned as the native extensions become more stable. |
23 | 24 |
|
24 | 25 | ## Requirements
|
25 | 26 |
|
@@ -80,7 +81,7 @@ impl HelloWorld {
|
80 | 81 |
|
81 | 82 | #[export]
|
82 | 83 | fn _ready(&self, _owner: &Node) {
|
83 |
| - godot_print!("hello, world."); |
| 84 | + godot_print!("Hello, world."); |
84 | 85 | }
|
85 | 86 | }
|
86 | 87 |
|
@@ -111,23 +112,26 @@ The [/examples](https://github.com/godot-rust/godot-rust/tree/master/examples) d
|
111 | 112 |
|
112 | 113 | ## Third-party resources
|
113 | 114 |
|
114 |
| -### Tutorials |
| 115 | +### Tools and integrations |
115 | 116 |
|
116 |
| -- Step by step guide - [Up and running with Rust and Godot: A basic setup](https://hagsteel.com/posts/godot-rust/) |
| 117 | +- [godot-egui](https://github.com/setzer22/godot-egui) (setzer22, jacobsky) - combine the [egui](https://github.com/emilk/egui) library with Godot |
| 118 | +- [ftw](https://github.com/macalimlim/ftw) (macalimlim) - manage your godot-rust projects from the command line |
| 119 | + |
| 120 | +### Open-source games |
117 | 121 |
|
118 |
| -### Open-source projects |
| 122 | +- [Action RPG](https://github.com/MacKarp/Rust_Action_RPG_Tutorial) (MacKarp) - this [Godot tutorial](https://www.youtube.com/playlist?list=PL9FzW-m48fn2SlrW0KoLT4n5egNdX-W9a) ported to Rust. |
| 123 | +- [Air Combat](https://github.com/paytonrules/AirCombat) (paytonrules) - this [Godot tutorial](https://devga.me/tutorials/godot2d/) ported to Rust. |
| 124 | +- [Simple single-player Blackjack](https://github.com/paytonrules/Blackjack) (paytonrules) |
| 125 | +- [Pong](https://github.com/you-win/godot-pong-rust) (you-win) |
119 | 126 |
|
120 |
| -- Pong - https://github.com/you-win/godot-pong-rust |
121 |
| -- Air Combat - https://github.com/paytonrules/AirCombat - This [Godot Tutorial](https://devga.me/tutorials/godot2d/) ported to Rust. |
122 |
| -- Action RPG - https://github.com/MacKarp/Rust_Action_RPG_Tutorial - This [Godot Tutorial](https://www.youtube.com/playlist?list=PL9FzW-m48fn2SlrW0KoLT4n5egNdX-W9a) ported to Rust. |
123 |
| -- Simple Single-Player Blackjack - https://github.com/paytonrules/Blackjack |
| 127 | +### Tutorials |
| 128 | + |
| 129 | +- Step by step guide - [Up and running with Rust and Godot: A basic setup](https://hagsteel.com/posts/godot-rust/) |
124 | 130 |
|
125 |
| -### Tools |
126 |
| -- ftw - https://github.com/macalimlim/ftw - manage your godot-rust projects! |
127 | 131 |
|
128 | 132 | ## Contributing
|
129 | 133 |
|
130 |
| -See the [contribution guidelines](CONTRIBUTING.md) |
| 134 | +See the [contribution guidelines](CONTRIBUTING.md). |
131 | 135 |
|
132 | 136 | ## License
|
133 | 137 |
|
|
0 commit comments