🐧Prepare your Unreal Engine project for Linux

Pre-requisites for Linux packaging

To prepare for Linux packaging of Unreal Engine projects with Pixel Streaming, the primary prerequisite is downloading and installing a cross-compile toolchain. This toolchain enables you to cross-compile your project from Windows to Linux, ensuring compatibility and functionality for Pixel Streaming on Linux platforms. No additional configuration of the toolchain in Unreal Engine is required once it is installed.

Cross-Compiling for Linux

Welcome to the essential segment of cross-compiling for Linux in your Arcane Mirage experience. Whether you are new to compiling projects for Linux or have prior experience, this guide is tailored to support you through the process. We provide a straightforward and engaging approach to cross-compiling, ensuring that your project seamlessly transitions to the Linux environment, fully optimized for the Arcane Mirage platform.

  • First download the cross-compile toolchain from Unreal Engine official documentation here. Example shown for UE version 5.2:

  • Install:

Restarting your computer is necessary for Linux cross-compile to work.

If your project was built from the Unreal Engine source code you may need to regenerate the .sln file and rebuild from the solution. (don’t compile from setup.bat with the flag β€œ-exclude=linux”)

Additional resource for cross-compilation can be found here (credits to Flopperam): https://www.youtube.com/watch?v=MVm5got0RMY

Preparing an Unreal Engine Project for Linux

  • Unreal Engine Version: Make sure you're working with version 5.2 or higher. The platform works with any Unreal 5 version but from 5.2 onward Epic Games released several improvements to the Pixel Streaming architecture.

  • Enabling Pixel Streaming Plugin: This is a must-have setting. We'll guide you through this essential step to ensure your project is Arcane Mirage-ready.

Once you open your project go to: Edit β†’ Plugins and search for Pixel Streaming, enable it.

Package your project

  • Zipping the 'Linux' Project Folder: Once everything is set, you'll zip up the project folder named 'Linux'. Feel free to rename this zipped file to something distinctive and recognizable, especially if you plan on uploading new versions later. (Packaging for 'Shipping' is best if it's the final version of the project)

IMPORTANT: Linux packages have some limitations described in the FAQ section of the documentation, please check before packaging.

Last updated