godot-bevy brings Bevy's powerful ECS to Godot, allowing you to write high-performance game logic in Rust while leveraging Godot's excellent editor and rendering capabilities.
Special thanks to Blaze for their support of this project. They provide high-performance Linux (AMD64 & ARM64) and Apple Silicon macOS runners for GitHub Actions, greatly reducing our automated build times.
The book covers everything you need to know:
- Installation and setup
- Core concepts and architecture
- Transform system and physics
- Input handling
- Examples and best practices
Add to your Cargo.toml:
[dependencies]
godot-bevy = "0.7.0"
bevy = { version = "0.16", default-features = false }
godot = "0.3"Basic example:
use bevy::prelude::*;
use godot_bevy::prelude::*;
#[bevy_app]
fn build_app(app: &mut App) {
// Print to the Godot console:
// (https://docs.rs/godot-core/0.3.1/godot_core/macro.godot_print.html)
godot_print!("Hello from Godot-Bevy!");
// This line runs the `position_system` function every Godot render frame.
//
// Read more about Bevy "Systems" here:
// (https://bevy.org/learn/quick-start/getting-started/ecs/).
//
// The `Update` schedule parameter is provided by Godot-Bevy.
// It runs the system during Godot's `_process` update cycle.
//
// Read more about other schedules provided by Godot-Bevy here:
// (https://github.com/bytemeadow/godot-bevy/blob/main/docs/TIMING_AND_SCHEDULES.md).
app.add_systems(Update, position_system);
}
// A system is a normal Rust function. This system moves all Node2Ds to the right, such as Sprite2Ds.
//
// The `transform` parameter is a Bevy `Query` that matches all `Transform2D` components.
// `Transform2D` is a Godot-Bevy-provided component that matches all Node2Ds in the scene.
// (https://docs.rs/godot-bevy/latest/godot_bevy/plugins/core/transforms/struct.Transform2D.html)
//
// For more information on Bevy Components, Systems, and Queries, see:
// (https://bevy.org/learn/quick-start/getting-started/ecs/).
fn position_system(mut transform: Query<&mut Transform2D>) {
// For single matches, you can use `single_mut()` instead:
// `if let Ok(mut transform) = transform.single_mut() {`
for mut transform in transform.iter_mut() {
// Move the node to the right.
transform.as_godot_mut().origin.x += 1.0;
}
}Check out the examples directory:
- 2D Platformer - Physics-based platformer
- Dodge the Creeps - Classic arcade game
- Simple Movement - Basic transform usage
This library is inspired by and builds upon the work of bevy_godot, which provided similar functionality for Godot 3. godot-bevy extends this concept to support Godot 4 and Bevy 0.16.
Alternative: If you're looking for a different approach to godot-bevy, check out bevy_godot4. For a comparison of the differences between these libraries, see Issue #2.
godot-bevy |
Bevy | Godot-Rust | Godot |
|---|---|---|---|
| 0.7.x | 0.16 | 0.3 | 4.4.x |
The minimum supported Rust version is 1.87.0.
The MSRV is the minimum Rust version that can be used to compile each crate.
godot-bevy is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE-APACHE and LICENSE-MIT for details. Opening a pull request is assumed to signal agreement with these licensing terms.
Contributions are welcome! Please feel free to submit a Pull Request.