本文为编译 cesium for unreal 源码踩坑记录，适用于新手小白/零代码基础。 网上对于这方面的资料并不多，而且大部分是针对 UE4 版本的。但 UE5 版本与其略有不同，因此这篇文章记录在 windows 系统编译 Cesium for unreal 源码（适配 UE5） 项目的流程，以供参考。

使用版本

工具
版本
 下载地址 备注
CMake 3.15或更高 https://cmake.org/install/
cesium for unreal ue5-main https://github.com/CesiumGS/cesium-unreal 注意切换分支
Visual Studio community 2019 https://visualstudio.microsoft.com/zh-hans/thank-you-downloading-visual-studio/?sku=Community&rel=16 注意添加UE相关扩展
Unreal Engine 5.0 https://www.unrealengine.com/zh-CN/download
nasm - 负责JPEG编码，非必需

流程

🔗 官方文档

1. 准备环境

  • git
  • CMake、VS2019、nasm
  • UE 编辑器 5.0 版本

2. 下载源码

此处为先下载示例项目，再拉取插件源码

    git clone https://github.com/CesiumGS/cesium-unreal-samples.git
    cd cesium-unreal-samples
    mkdir Plugins
    cd Plugins
    git clone --recursive https://github.com/CesiumGS/cesium-unreal.git

cesium-native/extern 里的子模块引用了第三方库。如果下面的 git 命令拉取失败，可以手动下载。

 cd cesium-unreal
 git submodule update --init --recursive

3. 构建 cesium-native

这一步的方法有很多。官方文档给出了 VS2019、VS code、CMake GUI、CMake cmd 几种方法的指南，此处以 CMake cmd 为例。

  • 采用 CMake cmd
cd extern
cmake -B build -S . -G "Visual Studio 16 2019" -A x64
cmake --build build --config Release --target install

4. 创建 UE 项目（包含C++ 类）

使用空项目

  • 添加 C++ 类
    打开项目后，在编辑器中 工具 - 新建 C++ 类 - 无 - 下一步 - <命名> - 创建类

  • 修改 UE 编辑器中构建工具使用的 VS 版本
    在 编辑-编辑器偏好设置-通用-源代码 中设置为 Visual Studio 2019 ，并点击 设置为默认值 ，根据提示重启编辑器。

  • 关闭编辑器

使用官方示例项目

示例项目中并没有 .sln 文件，需拷贝 cesium-unreal-ue5-main\Documentation 中的 Source 文件夹到项目根目录。然后在对 .uproject 右键 Generate Visual Studio project files

5. 配置解决方案

  • 用 VS2019 打开 .sln 文件
  • 打开后查看解决方案属性页，注意将 解决方案平台改为 win64 。 配置也可选择 DebugGame Editor （用于debug）或 Development Editor （速度更快）。如果你想修改源码，那么选择 DebugGame Editor 会更合适。