godot-rust is a Rust library that implements native bindings for the Godot game engine. 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.
Note: if you are looking for a Rust binding for GDExtension (Godot 4), checkout
gdext.
gdnative is considered mostly feature complete, and is maintained with a focus on API stability. We try to avoid unnecessary breaking changes, and try to limit their end-user impact to a minimum whenever we have to make them.
We adhere to Cargo's semantic versioning as the means to convey changes in the public API between versions. Future releases are planned publicly on GitHub, with the milestone feature. Note that we use the breaking-change label to indicate the existence of any technical breakage, regardless of the expected impact on end user programs.
If you are looking to contribute, but are not sure if what you want to do falls in the scope of the project and is permitted by our maintenance policy, feel free to get in touch with the project maintainers before you start.
gdnative currently has a minimum supported Rust version (MSRV) of 1.67. We use the Rust 2021 Edition.
Warning: Linux users: Be aware of the source of your Godot binary! Binary distributions of Godot using a container-based format may ship versions of dependencies that may not be compatible with GDNative libraries built directly from your base system. Examples of such formats include Flatpak, Snap, and AppImage.
As of 2023, some package managers might silently install one of these instead of a normal package when Godot is requested, which can then cause bizarre compatibility issues with your GDNative libraries. We recommend using the official binaries from godotengine.org for both the editor and the export templates.
Due to GDNative API not strictly following SemVer and some concepts not mapping 1:1 to Rust (default parameters), it is difficult for a godot-rust version to remain compatible with multiple Godot versions simultaneously.
However, we support the latest stable Godot 3 minor release out-of-the-box, and allow to easily use custom engine
versions using the custom-godot feature flag (see below).
Compatibility list:
- Godot 3.5.1 (works with gdnative 0.11)
- Godot 3.4 (works with gdnative 0.10, custom build for 0.11)
- Godot 3.3 (custom build)
- Godot 3.2 (custom build)
The bindings do not support Godot 4. If you are looking for a Rust binding for GDExtension (Godot 4), checkout gdextension.
Detailed setup is explained in the Getting Started section of the book. In case of problems, consider also reading the FAQ.
This is the recommended way of using godot-rust. After bindgen dependencies and a current Godot version are installed, add the gdnative crate as a dependency, and set the crate type to cdylib:
[dependencies]
gdnative = "0.11"
[lib]
crate-type = ["cdylib"]If you would like to benefit from cutting-edge features and bugfixes, you can use the GitHub version. We have a relatively sophisticated CI and test suite for basic stability, but the GitHub version is typically more experimental and less battle-tested than a crates.io release. We also do not guarantee any SemVer compatibility here.
[dependencies]
gdnative = { git = "https://github.com/godot-rust/godot-rust.git" }
[lib]
crate-type = ["cdylib"]To use the bindings with a different Godot version or a custom build of the engine, see Custom Godot builds in the user guide.
Async support is a work-in-progress, with a low-level API available in gdnative::tasks, if the async feature is enabled on gdnative. See this page in the book for an introduction to use the async feature with Tokio.
A typical use case is to expose your own Native Class, a Rust API that can be invoked from the Godot engine. The resulting native script can be attached to the scene tree, just like GDScript (.gd files).
This happens via dynamic libraries and the GDNative interface, which will be loaded from Godot. The necessary wiring is done behind the scenes by godot-rust. A simple "Hello world" application could look like this:
use gdnative::prelude::*;
#[derive(NativeClass)]
#[inherit(Node)]
pub struct HelloWorld;
#[methods]
impl HelloWorld {
fn new(_base: &Node) -> Self {
HelloWorld
}
#[method]
fn _ready(&self, #[base] _base: &Node) {
godot_print!("Hello, world.");
}
}
fn init(handle: InitHandle) {
handle.add_class::<HelloWorld>();
}
godot_init!(init);Important note:
To run or edit an example, you need to build the native library for it first. Otherwise, the project will be broken. You can do so manually with
cargo build, or use theexample.shshell script for convenience:./example.sh run hello-worldor./example.sh edit hello-worldfor the editor.
The /examples directory contains several ready to use examples, complete with Godot projects and setup for easy compilation from Cargo:
- hello-world - Your first project, writes to the console.
- spinning-cube - Spin our own node in place, exposing editor properties.
- scene-create - Load, instance and place scenes using Rust code.
- builder-export - Export using the builder API.
- property-export - Export complex properties such as collections.
- dodge-the-creeps - A Rust port of the little Godot game.
- signals - Connect and emit signals.
- resource - Create and use custom resources.
- rpc - Simple peer-to-peer networking.
- native-plugin - Create custom node plugins.
At startup, the Godot editor tries to load all resources used by the project, including the native library. If the latter isn't present, the editor will skip properties or signals associated with the missing native scripts in the scene. This causes the scene tree to be non-functional for any sample that relies on properties or signals configured in the editor.
To see a list of games and integrations developed on top of godot-rust, have a look at our list of third-party projects in the book.
See the contribution guidelines.
Any contribution submitted for inclusion in the work by you shall be licensed under the MIT license, without any additional terms or conditions.