Unreal-Rust 技术文档

🦀 Unreal-Rust 技术文档

unreal-rust Rust integration for Unreal Engine 5 项目地址: https://gitcode.com/gh_mirrors/un/unreal-rust

---

安装指南

前提条件

在开始集成 Unreal-Rust 到您的项目之前，请确保满足以下条件：

• Unreal Engine 5：访问官方站点下载并安装最新版本的UE5。
• Git LFS：通过官方网站或命令行工具安装，并执行 git lfs install 初始化。
• ue4cli：使用Python的包管理器pip安装，运行 pip3 install ue4cli。
• Rust编程环境：通过访问Rust官网并遵循指示进行安装。

获取并配置项目

1. 克隆仓库：

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

2. 更新子模块：

   cd unreal-rust
   git submodule update --init
   

3. 设置环境：

   • 在Linux上执行 sh setup.sh
   • Windows用户则执行 setup.bat

这会将Rust插件链接到示例项目的对应位置。

构建与部署Rust代码

• 使用Cargo构建Rust代码：

  cargo build --release
  

完成编译后，将生成的动态库文件复制到项目目录下：

• 对于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示例项目

1. 进入示例项目目录：

   cd example/RustExample
   

2. 构建示例：

   ue4 build Development Editor
   

最后，启动示例：

ue4 run

项目的使用说明

Unreal-Rust 目前主要作为实验性质的整合，提供了简化的接口以便快速接入核心Unreal Engine功能。开发者可以在编辑器内添加Rust组件到演员（Actors），并通过蓝图（Blueprint）访问这些组件来驱动游戏逻辑。请注意，尽管其拥有热重载等开发者友好特性，但因处于早期阶段，API可能频繁变动，且稳定性不保证。

项目API使用文档

当前文档未提供详细的API使用说明。在实际应用中，您需参考源码中的例子以及项目更新日志。建议关注作者发布的博客文章和YouTube频道获取更多使用示例和API更新信息。

项目支持的安装方式

仅支持以插件形式集成至Unreal Engine 5项目。将RustPlugin目录复制到目标项目的Plugins文件夹下，然后跟随上述步骤完成Rust端的编译和配置即可。

---

本技术文档概述了如何安装和初步使用Unreal-Rust框架。考虑到项目的持续发展，建议密切关注项目页面和相关社区，以获取最新的进展和指导。

unreal-rust Rust integration for Unreal Engine 5 项目地址: https://gitcode.com/gh_mirrors/un/unreal-rust