GDNative 的 Rust 绑定

godot-rust 是一个 Rust 库，它实现了对 Godot 游戏引擎 的本地绑定。这使得您可以在 Godot 中开发游戏或其他应用程序，同时利用 Rust 的优势，如其类型系统、可扩展性和性能。

注意：如果您正在寻找 GDExtension (Godot 4) 的 Rust 绑定，请查看 gdext.

维护策略

gdnative 被认为功能基本完善，并专注于 API 稳定性进行维护。我们尽量避免不必要的破坏性更改，并在必要时将其对最终用户的影响降到最低。

我们遵循 Cargo 的语义版本控制 作为传达版本之间公共 API 变化的手段。未来的版本计划在 GitHub 上公开，使用 里程碑 功能。请注意，我们使用 breaking-change 标签来指示存在任何技术中断，无论其对最终用户程序的影响预期如何。

如果您想贡献，但不确定您想做的事情是否在项目范围内并符合我们的维护策略，请在开始之前随时与项目维护者 联系。

工具链兼容性

gdnative 目前支持的最低 Rust 版本 (MSRV) 为 1.70。我们使用 Rust 2021 版本。

警告：Linux 用户：请注意您 Godot 二进制文件的来源！使用基于容器格式的 Godot 二进制分布可能包含与直接从您的系统构建的 GDNative 库不兼容的依赖项版本。此类格式的示例包括 Flatpak、Snap 和 AppImage。

截至 2023 年，一些包管理器可能在请求 Godot 时静默地安装其中之一而不是正常安装包，这可能会导致与您的 GDNative 库出现奇特的兼容性问题。我们建议使用来自 godotengine.org 的官方二进制文件，包括编辑器和导出模板。

由于 GDNative API 并不严格遵循 SemVer，以及一些概念无法与 Rust (默认参数) 1:1 映射，因此 godot-rust 版本难以同时与多个 Godot 版本保持兼容。

然而，我们默认支持最新稳定的 Godot 3 小版本，并允许您通过使用 custom-godot 功能标志轻松地使用自定义引擎版本（见下文）。

兼容性列表

• Godot 3.5.1（与 gdnative 0.11 兼容）
• Godot 3.4（与 gdnative 0.10 兼容，0.11 版本为自定义构建）
• Godot 3.3（自定义构建）
• Godot 3.2（自定义构建）

这些绑定不支持 Godot 4。如果您正在寻找 GDExtension（Godot 4）的 Rust 绑定，请查看 gdextension。

入门指南

详细的设置说明在 本书的“入门”部分。如果遇到问题，也可以考虑阅读 常见问题解答（FAQ）。

最新发布版本

这是使用 godot-rust 的推荐方式。在安装了 bindgen 依赖项和当前 Godot 版本后，将 gdnative 包作为依赖项添加，并将包类型设置为 cdylib

[dependencies]
gdnative = "0.11"

[lib]
crate-type = ["cdylib"]

最新 GitHub 版本

如果您想利用最新的特性和错误修复，可以使用 GitHub 版本。我们有一个相对复杂的 CI 和测试套件来保证基本稳定性，但 GitHub 版本通常比 crates.io 发布的版本更实验性，测试也更少。我们也不保证任何 SemVer 兼容性。

[dependencies]
gdnative = { git = "https://github.com/godot-rust/godot-rust.git" }

[lib]
crate-type = ["cdylib"]

自定义构建

要使用与不同 Godot 版本或自定义构建的引擎兼容的绑定，请参阅用户指南中的 “自定义 Godot 构建”。

异步/yield 支持

异步支持仍在开发中，如果启用了 async 特性，则 gdnative::tasks 提供了低级 API。有关如何使用 Tokio 使用异步功能，请参阅本书中的 此页面。

示例

一个典型的用例是公开您的自己的 本地类，这是一个可以从 Godot 引擎调用的 Rust API。生成的本地脚本可以附加到场景树中，就像 GDScript（.gd 文件）一样。

这是通过动态库和 GDNative 接口 实现的，该接口将由 Godot 加载。godot-rust 在幕后完成了必要的配置。一个简单的“Hello world”应用程序可能看起来像这样

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);

更多示例

重要提示

要运行或编辑示例，您首先需要为其构建本地库。否则，项目将损坏。您可以使用 cargo build 手动执行此操作，或者使用方便的 example.sh 脚本：使用 ./example.sh run hello-world 或 ./example.sh edit hello-world 来运行或编辑编辑器。

/examples 目录包含几个可立即使用的示例，包括 Godot 项目和 Cargo 的编译设置

• hello-world - 您的第一个项目，将信息写入控制台。
• spinning-cube - 在原位旋转我们自己的节点，公开编辑器属性。
• scene-create - 使用Rust代码加载、实例化和放置场景。
• builder-export - 使用builder API导出。
• property-export - 导出如集合等复杂属性。
• dodge-the-creeps - 小Godot游戏的Rust版本。
• signals - 连接和发出信号。
• resource - 创建和使用自定义资源。
• rpc - 简单的对等网络。
• native-plugin - 创建自定义节点插件。

在启动时，Godot编辑器会尝试加载项目中使用的所有资源，包括本地库。如果后者不存在，编辑器将跳过与场景中缺失的本地脚本相关的属性或信号。这会导致依赖于编辑器中配置的属性或信号的任何示例场景树无法正常工作。

第三方项目

要查看基于godot-rust开发的游戏和集成列表，请参阅书中第三方项目列表。

贡献

请参阅贡献指南。

许可证

您提交的任何贡献，若要包含在本工作中，均应按照MIT许可证许可，不附加任何额外条款或条件。