🦀 unreal-rust

针对Unreal Engine的偏执Rust集成

☣️ 注意

unreal-rust 不可用于实际项目。 unreal-rust 处于非常早期阶段，目前仅是一个概念验证。API将会频繁更改。可能会崩溃，或者不按预期工作。用户体验不会很好。

我在GitHub上发布 unreal-rust 以在公开环境中进行开发。

🎯 功能

• 简单的偏执绑定：轻松访问核心API，如播放声音、生成actor、路径查找、物理等。
• 开发者友好：在编辑器和实时播放期间快速迭代时间，支持热重载。恐慌被捕获，不会崩溃编辑器
• 编辑器集成：在编辑器中将Rust组件添加到actor中，或从蓝图访问Rust组件以驱动动画。
• 实体组件系统：unreal-rust建立在ECS之上。
• 建立在 AActor 之上：大多数游戏功能，如 GameMode、Characters、GameState、GAS，在unreal-rust中无法直接访问。相反，unreal-rust将提供可选的替代方案。但是，您仍然可以与引擎的大部分部分交互，因为Rust组件可以在蓝图中被访问。
• 无需修改引擎：unreal-rust仅是一个 Plugin，只需将其放入您的项目即可。有关更多信息，请参阅 支持的版本。
• 示例：unreal-rust的开发受到示例的强烈驱动。
• 免费：MIT/APACHE双许可

🖥️ 支持的平台

• 🐧 Linux
• 🪟 Windows

潜在的未来平台：iOS、macOS、Android、html5/browser（可能）

不支持游戏机。我无法提供游戏机支持，因为它是一个封闭的生态系统。我也没有访问任何开发套件。

💌 博客文章 / 媒体

• 宣布 Unreal Rust
• unreal-rust 开发日志

🚩 已知问题

• 这只是我在正常工作时间外做的个人爱好项目。我可能对问题、问题、功能请求或PR评审的响应会比较慢。

🦮 开始使用

运行示例

我知道这些步骤很多。对此表示歉意，我会在未来尝试简化这些步骤。

• 先决条件
• • Unreal Engine 5。对于 Linux 用户，您可以从这里获取。
• • 获取 git lfs，并运行 git lfs install
• • ue4cli，您可以使用 pip3 install ue4cli 获取。这一步是可选的，但在本指南中我将使用 ue4cli。
• • Rust

我们首先克隆这个仓库

git clone https://github.com/MaikKlein/unreal-rust

接下来克隆子模块。这将下载带有所有资源的实际示例。

cd unreal-rust
git submodule update --init

接下来我们需要设置示例

• • Linux sh setup.sh
• • Windows setup.bat

这将创建 RustPlugin 到 Unreal example/RustExample/Plugin 文件夹的符号链接。

现在我们需要构建实际的 Rust 代码

只需运行

cargo build --release

这将构建整个项目。这也会生成我们将加载到 Unreal 中的 dll 文件。

将 dll/so 文件复制到项目中

• Linux: cp target/release/libunreal_rust_example.so example/RustExample/Binaries/rustplugin.so
• Windows: copy .\target\release\unreal_rust_example.dll .\example\RustExample\Binaries\rustplugin.dll

现在我们需要构建 Unreal 示例

cd example/RustExample
ue4 build Development Editor

现在您可以使用 ue4 run 运行示例

🚀 支持的版本

• 5.0

该项目将始终尝试支持最新版本。

• Unreal 最新版本
• Rust 最新版本
• 所有依赖项的最新版本

🤝 替代方案

• Unreal Angelscript
• UnrealCLR

🥰 感谢

• kenney，quaternius
• bevy