GDNative bindings for 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（默认参数）一一对应，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构建”。

Async/yield支持

异步支持是正在进行的工作，如果启用async功能，在gdnative中可提供低级API，在gdnative::tasks中，请参见本书中的此页，介绍如何使用Tokio使用异步功能。

示例

一个典型的用例是暴露您的自己的Native Class，这是一个可以从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许可证许可，不附加任何额外条款或条件。