Bevy Godot4 集成指南

1. 项目介绍

Bevy Godot4 是一个开源项目，旨在将 Bevy 的实体组件系统（ECS）引入 Godot 4 游戏引擎。Bevy 是一个用 Rust 编写的游戏引擎，以其高效的 ECS 架构而闻名。Godot 4 是一个功能强大的开源游戏引擎，支持 2D 和 3D 游戏开发。通过这个项目，开发者可以利用 Bevy 的 ECS 特性，同时保留 Godot 的成熟功能和灵活性。

2. 项目快速启动

环境准备

• Rust 开发环境
• Godot 4 安装

依赖安装

首先，在你的 Cargo.toml 文件中添加以下依赖：

[dependencies]
bevy = {
    version = "0.16",
    default-features = false,
    features = ["bevy_asset", "bevy_state"]
}
bevy_godot4 = {
    git = "https://github.com/jrockett6/bevy_godot4",
    branch = "main"
}
godot = "0.2.4"

创建 Bevy 应用

创建一个函数来构建你的 Bevy 应用，并使用 #[bevy_app] 属性标记它：

#[bevy_app]
fn build_app(app: &mut App) {
    app.add_system(my_system);
}

构建项目

使用 cargo build 命令构建你的项目，并确保 Godot 可以找到生成的 dll 文件。

配置 Godot

在 Godot 项目设置中，添加一个名为 BevyAppSingleton 的 Godot autoload，它将指向你的 BevyApp 节点。

3. 应用案例和最佳实践

使用 Godot 节点作为组件

你可以通过 ErasedGd 组件在 Bevy 系统中操作 Godot 节点：

fn set_positions(mut erased_gds: Query<&mut ErasedGd>) {
    for mut node in erased_gds.iter_mut() {
        if let Some(node2D) = node.try_get::<Node2D>() {
            node2D.set_position(Vector2::ZERO);
        }
    }
}

将 Godot 资源作为 Bevy 资源

使用 ErasedGdResource 来在 Bevy 中存储和管理 Godot 资源：

#[derive(Resource)]
pub struct GodotResources {
    pub my_packed_scene: ErasedGdResource,
}

impl Default for GodotResources {
    // 加载 Godot 资源，例如使用 ResourceLoader 单例。
}

在 Bevy 中实例化 Godot 场景

使用 GodotScene 来从 PackedScene 资源中实例化场景：

fn spawn_scene(godot_resources: Res<GodotResources>, mut commands: Commands) {
    commands.spawn(GodotScene::from_resource(godot_resources.my_packed_scene.clone()));
}

调度 Bevy 系统以匹配 Godot 更新循环

使用 as_visual_system() 或 as_physics_system() 来确保你的 Bevy 系统在正确的 Godot 更新循环中运行：

app.add_system(set_positions.as_physics_system());

确保 Bevy 系统在主线程上运行

使用 SceneTreeRef 参数来确保你的 Bevy 系统在主线程上执行：

fn my_main_thread_system(/* ... */, _scene_tree: SceneTreeRef) {
    // 非线程安全的代码，例如 move_and_slide()
}

4. 典型生态项目

Bevy Godot4 的生态项目包括但不限于：

• bevy_godot：用于与 Godot 3 和 GDNative 交互的类似项目。
• 多个示例项目，展示了如何在不同场景下集成 Bevy 和 Godot。

开发者可以参考这些项目来更好地理解如何在自己的项目中使用 Bevy Godot4。