Package Cesium for Unreal failed for MacOS+iOS

wuwei416 · April 19, 2024, 7:16am

Hi guys,

I am trying to build and package Cesium for Unreal by myself. The codes are based on branch of ue_5.4_support.

I build it follow this link:

CesiumGS/cesium-unreal/blob/ue_5.4_support/Documentation/developer-setup-osx.md

Detailed instructions for setting up a Cesium for Unreal development environment on macOS. Please see the [Developer Setup](developer-setup.md) page for an overview of the process.

# Prerequisities

- Install CMake (version 3.15 or newer) from https://cmake.org/install/
- Install Xcode 11.3 from https://developer.apple.com/xcode/resources/
- For best JPEG-decoding performance, you must have [nasm](https://www.nasm.us/) installed so that CMake can find it. Everything will work fine without it, just slower.
- Install the Unreal Engine (version 4.26 or newer) from https://www.unrealengine.com/en-US/download

# Cloning the git repos

The following illustrates the recommended directory layout for developers:

- `~/dev` - Your own root directory for development.
- `~/dev/cesium-unreal-samples` - The directory for the Unreal project that will use the plugin.
- `~/dev/cesium-unreal-samples/Plugins/cesium-unreal` - The directory for the actual *Cesium for Unreal* plugin.
- `~/dev/cesium-unreal-samples/Plugins/cesium-unreal/extern/cesium-native` - The directory for the base libraries project.

You may use any directory for the project, but the directory for the actual *Cesium for Unreal* plugin **MUST** be in a subdirectory `Plugins/cesium-unreal` of the project directory. This way, Unreal will automatically find the Plugin when running the project, and pick up any changes that have been made to the plugin.

This file has been truncated. show original

the build command i used is:
for MacOS:
cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
cmake --build build --target install
for iOS:
cmake -B build-ios -S . -GXcode -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_ARCHITECTURES=arm64 -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_BUILD_TYPE=Release
cmake --build build-ios --target install --config Release

and package it(macOS+iOS) follow this link:

github.com

CesiumGS/cesium-unreal/blob/ue_5.4_support/Documentation/packaging-guide.md

# Packaging

Our Travis CI automatically creates a plugin package on every commit to the Cesium for Unreal repo. But if you want to do it locally, there are a few things to keep in mind:

* Unreal Engine always uses Visual Studio 2017 to package a plugin. So if you only have Visual Studio 2019 installed, the package process will fail.
* Similarly, if you built cesium-native with Visual Studio 2019, you will get linker errors when you try to build Cesium for Unreal with Visual Studio 2017. So, be sure to build cesium-native with Visual Studio 2017 if you need to package.

## Packaging Cesium for Unreal Plugin

Packaging an Unreal Engine plugin makes it portable and you can use it as part of the Unreal Engine directory, to be used for all your Unreal projects. This is similar to installing it from the Unreal Engine Marketplace, except you can use non-release branches.

To package the plugin, follow the steps below:

1. After compiling Cesium Native in your `cesium-unreal` directory, run the following command:
    ```bash
    # Command Template:
    $UNREAL_ENGINE_DIR/Engine/Build/BatchFiles/RunUAT.bat" BuildPlugin -Plugin="<absolute path to cesium-unreal/CesiumForUnreal.uplugin>" -Package="<absolute path to output directory>" -CreateSubFolder -TargetPlatforms=<target platforms>
    ```
    * Windows Example:
        ```cmd

This file has been truncated. show original

the package command i used is:
sudo “/Users/Shared/Epic Games/UE_5.3/Engine/Build/BatchFiles/RunUAT.command” BuildPlugin -Plugin=“/Users/wuwei/work/wyd/cesium/cesium-unreal/CesiumForUnreal.uplugin” -Package=“/Users/wuwei/work/wyd/cesium/out/CesiumForUnreal” -CreateSubFolder -TargetPlatforms=Mac+iOS

then i got bunch of errors when package:
Size mismatch /Users/wuwei/work/wyd/cesium/cesium-unreal/extern/cesium-native/extern/KTX-Software/NOTICE.md = 10 to /Users/wuwei/work/wyd/cesium/out/CesiumForUnreal/HostProject/Plugins/CesiumForUnreal/extern/cesium-native/extern/KTX-Software/NOTICE.md = 1523
Failed to copy /Users/wuwei/work/wyd/cesium/cesium-unreal/extern/cesium-native/extern/KTX-Software/NOTICE.md to /Users/wuwei/work/wyd/cesium/out/CesiumForUnreal/HostProject/Plugins/CesiumForUnreal/extern/cesium-native/extern/KTX-Software/NOTICE.md, deleting, waiting 10s and retrying.
SafeDeleteFile /Users/wuwei/work/wyd/cesium/out/CesiumForUnreal/HostProject/Plugins/CesiumForUnreal/extern/cesium-native/extern/KTX-Software/NOTICE.md

So, can you give some ideas to solve these errors? Thx!

janine · April 22, 2024, 2:15pm

HI @wuwei416, welcome to the community!

Currently, we’re working on UE 5.4 support on Github here. It’s not perfect, but you could reference the changes there and bring them into your own branch. We’ll also finalize and release the changes for the upcoming 5.4 release. Please let us know how it goes!

wuwei416 · April 23, 2024, 10:01am

Hi Janine,
Thanks for your answer.
According official documentations, i found you have CI for Cesium for Unreal.
I have download the plugin package from branch of ue_5.4_support.
One more question, in order to support UE5.4, should i download plugin package from branch of ue_5.4_support? Or another branch?

Brian_Langevin · April 29, 2024, 7:49pm

I assume you’re wanting to package for UE 5.4?

Your command looks like it’s using 5.3.

Topic		Replies	Views
Errors building Cesium for Unreal for MacOS/iOS Cesium for Unreal	1	41	December 10, 2024
Unreal Engine 5.4.1 with Cesium for Unreal 2.5.0 fails to package iOS Cesium for Unreal	5	490	May 23, 2024
Help Installing on Mac Cesium for Unreal	4	1059	May 17, 2022
Can cesium for unreal plugins working on Xcode iOS simulator? Cesium for Unreal	5	69	July 3, 2024
Cesium for Linux arm64 Cesium for Unreal	15	1821	April 14, 2025

Package Cesium for Unreal failed for MacOS+iOS

Related topics