Skip to content

Latest commit

 

History

History
61 lines (33 loc) · 4.34 KB

using-prerelease-packages.md

File metadata and controls

61 lines (33 loc) · 4.34 KB
Raw

Using Pre-Release Packages

Cesium for Unreal has a continous integration (CI) system that automatically builds an installable version of the plugin for every commit in every branch. You can download and install these yourself to try out new features before they're released.

Before you begin, back up your project. Cesium for Unreal can not guarantee that levels saved with a pre-release version will be loadable in other versions of the plugin.

Download a pre-release version from a Pull Request

To download a pre-release version built from a pull request, click the "Checks" tab at the top of the pull request:

image

Then click the "Cesium for Unreal on: push" link:

image

And scroll down to the Artifacts section:

image

If there is no Artifacts section on that page, it's probably because the CI run is still in progress. Artifacts don't appear until the build is complete.

Find the appropriate ZIP file for your version of Unreal Engine. For example, CesiumForUnreal-52-*.zip is for Unreal Engine 5.2. Note that artifacts that name a platform will only work on that platform, while artifacts without any platform in the name will work on all platforms that Cesium for Unreal supports. So in most cases you should download an artifact without any platform in its name.

Once you've downloaded the appropriate ZIP, move on to installing a Cesium for Unreal ZIP.

Download a pre-release version from a branch or commit

To download a pre-release version built from a branch (or a commit), click the green check ✔️ at the top of the list of files in the branch:

image

Click any of the Details links that appear:

image

Then click the Summary link:

image

And scroll down to the Artifacts section:

image

If there is no Artifacts section on that page, it's probably because the CI run is still in progress. Artifacts don't appear until the build is complete.

Find the appropriate ZIP file for your version of Unreal Engine. For example, CesiumForUnreal-52-*.zip is for Unreal Engine 5.2. Note that artifacts that name a platform will only work on that platform, while artifacts without any platform in the name will work on all platforms that Cesium for Unreal supports. So in most cases you should download an artifact without any platform in its name.

Once you've downloaded the appropriate ZIP, move on to installing a Cesium for Unreal ZIP.

Installing a Cesium for Unreal ZIP

Once you've download a pre-release ZIP file using one of the methods above, you can install it into your Unreal Engine as follows:

  1. If you previously installed the Cesium for Unreal plugin via the Unreal Engine Marketplace, uninstall it first.
  2. Find Unreal Engine's Engine/Plugins/Marketplace directory. For example, on Unreal Engine 5.2 on Windows, this is typically C:\Program Files\Epic Games\UE_5.2\Engine\Plugins\Marketplace. You may need to create the Marketplace directory yourself.
  3. If the CesiumForUnreal subdirectory already exists in this Marketplace directory, delete it first to make sure you're getting a clean installation.
  4. Extract the release ZIP into this Marketplace directory. If you've done this correctly, you'll find a CesiumForUnreal sub-directory inside the Marketplace directory.