05. Upload and manage your Unreal packages
CloudRT user portal - Getting Started
Before uploading a packaged project to Arcware CloudRT, please make sure that you follow the minimum required steps to prepare your package for streaming...
- 1.Unreal Engine Version Ensure you are using a supported version of Unreal Engine (4.27 or 5.1)
- 2.Enable the Pixel Streaming plugin in your Unreal Engine project. If you already have a packaged project and you're not sure if the Pixel Streaming plugin is enabled, you can navigate to the following folders to check if the plugin is present or not...
PixelStreaming Plugin location for UE4.27
PixelStreaming Plugin location for UE5.1
- 3.Package your project. Before packaging, make sure you assign the desired Game Mode + Default Map in the 'Project Settings'. Packaging as a 'Windows - Shipping' build is recommended.
- 4.Zip up your packaged project files. You can either zip the root folder containing your package (Zip method 01) or zip all the contents from within the root folder (Zip method 02)
Zip method 01
Zip method 02
- 5.Package Ready... Now you have a packaged Unreal Engine application ready to upload to Arcware CloudRT.
The steps listed above are the minimum required to turn your Unreal Engine project into a testable streamed application. To get the highest quality experience and ensure you have all desired features working correctly in your streamed Unreal Engine application, please consult the following section with a more in-depth guide to preparing Unreal Engine for Pixel Streaming. Set up Pixel Streaming in your own project
- 1.Log in to Arcware CloudRT, open your streaming project. Go to https://platform.arcware.cloud, navigate to the 'Projects' tab and choose the streaming project for which you would like to upload the package into.
- 2.Project overview. 1. You will notice in the top right corner of the project page, your project is automatically set to 'Disabled' until you upload your first package. 2. Once inside your desired project, click on the 'Packages' section.
Uploading and releasing packages will still work for disabled projects, but if you want to see the project streamed, please make sure to enable it here in the project settings after your first upload
- 3.Upload your zipped package to Arcware CloudRT. Once inside the 'Packages' section, Drag and drop your zipped package into the upload box (manual browsing to your package is also possible). The upload will start immediately.
Note: If you don't yet have an Unreal Engine project, but you would like to test the upload process, an example package is provided here... https://www.dropbox.com/sh/bu5l9fveihcd8jh/AAB2pGRi7M1KX_OewIxCfr6Ca?dl=0
- 4.Track the upload/scanning/gauging progress. Every upload you do will be shown in a list with their respective status. Please keep the Web browser window open during your upload, as there is no possibility yet to resume your upload after closing.
After the upload process has finished, you can then observe the status of the following stability checks for your package.
Your upload will not automatically be available for streaming. It first needs to undergo virus scanning and a simple automated test, to check that pixel streaming is enabled and that your application doesn't crash on startup.
- 5.Release your package. If Upload / AV Scanning / Testing phases are all successful, you will then be presented with the option to 'Release' your package.
The package will not automatically be released. In a future update of platform we will add a checkbox to fast-forward an upload for being released automatically 'when finished'. The default platform behaviour will remain, with a package not being released automatically.
When you release the package it will kill all current running connections to your stream, thus, you should plan when to do new releases in order not to disrupt your stream users.
Press to release your package
Confirm package release if intented
After pressing the release button, it will still take some time to download your package to our system and to distribute it on the servers. We are working on a visual feedback for when your package is ready for streaming. For now, please wait approximately 30 minutes for the stream to be viewable.
- 6.Enable Project Now that you have uploaded your first package to your project, you will be able to 'Enable' your project, to allow it to be streamed.
Warning: If your Unreal Engine package shows it has uploaded successfully but does not seem to start correctly after releasing it on the platform, please consider the following Unreal Engine application 'start-up' guidelines... - The Unreal Engine application must start within '30' seconds - Pop-up messages that require user interaction during the application start-up, must NOT be present. If any of these issues are present in your uploaded package, then eventually, you will notice the project is automatically disabled after some time. If this happens, it's because the CloudRT platform recognizes that your application does not start after multiple attempts and subsequently disables the project, to spare your streaming resources. We will work on more automated feedback for this in the future. Currently, the best thing you can do to avoid these issues is to debug your applications start-up on your local machine, before uploading it to the platform.
Note: We will keep all past uploads for you (failed and succeeded), to keep an overview of all your attempts. We will add functionality to remove failed uploads to keep the list clean. It will always be possible to release past uploads again, to make a roll back.
Note: Add 'Tags' to your Unreal Engine package uploads. This will keep your uploads manageable and help to identify the package uploads you consider to be 'stable'. You may want to revert back to a stable version of your stream at a later stage.
Note: Deleting previously uploaded packages from the list will not increase your overall upload limit for the month.
Warning: Please keep in mind that you have a limited amount of package 'Uploads' / 'Releases' (the limit is determined by your tenant plan for each project/each month) It is therefore advised to be cautious with your uploads and reserve one of your 'Releases' for a fallback scenario. Imagine this likely scenario... You have organised an upcoming showcase for your pixel stream and in preparation you have been uploading/testing new packages. Now you're finished with testing and decide to revert back to your 'stable' package version, however you can not revert back anymore because you have used up all your 'Releases' for the month... We are making developments to help you avoid this scenario. In the future we will enable you to test your applications directly on the Arcware CloudRT platform without needing to upload a package every time (via a bypass feature). This will enable you to connect your locally running Unreal Engine application to our platform, allowing you to test freely without using your Upload/Release allowance.
Note: If you need your files/packages fully purged from our systems, please send us a message on [email protected]