GDNative的Rust绑定

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

注意：如果您正在寻找Godot 4的GDExtension（Godot 4）的Rust绑定，请查看 gdext。

维护策略

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

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

如果您想要贡献，但不确定您想做的事情是否属于项目的范围并且符合我们的维护策略，请在开始之前与项目负责人联系。

工具链兼容性

gdnative 目前支持的最小Rust版本（MSRV）为 1.70。我们使用Rust 2021版。

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

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

由于GDNative API并不严格遵循SemVer，并且某些概念与Rust（默认参数）不是一一对应的，因此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。

入门指南

详细的设置说明在书籍的《入门指南》部分。如有问题，还可以阅读常见问题解答。

最新发布版本

这是使用godot-rust的推荐方法。在安装了bindgen依赖和一个当前的Godot版本后，将gdnativecrate作为依赖项添加，并将crate类型设置为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支持

异步支持正在进行中，如果启用了gdnative上的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来完成，或者使用方便的shell脚本example.sh：使用./example.sh run hello-world或./example.sh edit hello-world来编辑编辑器。

/examples目录包含几个现成的示例，包括Godot项目和设置，可以轻松地从Cargo编译

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

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

第三方项目

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

贡献

请参阅贡献指南。

许可

您提交的任何贡献，只要包含在本作品中，都应按照MIT许可进行许可，不附加任何额外条款或条件。