Versions Compared

Old Version 14

changes.mady.by.user Ahsan

Saved on

compared with

New Version Current

changes.mady.by.user Khaoula Bouhlali

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Preparing to execute instructions

Before starting the first step, make Learn to Upload an Unreal Engine Application on Eagle 3D’s Platform.

Prerequisites

Info

Make sure you have:

A project ready to upload;
How to install Pixel Streaming plugin;

  • Access to the Control Panel. Contact us to get access [1];

    • To complete this guide, your working environment must meet all the requirements above. If you have not completed any of the points, follow the link to the appropriate instruction and complete it first.

    Step 1. Create Project Archive

    Info

    Make sure you have the Pixel Streaming plugin enabled, and export your App for Windows.

    1.1 In the Root folder, that is, in the folder where the application executable file is located (file with the .exe extension), select all files and folders (image 1).

    Image Removed WarningPlease note, if

    Instructions

    Panel
    panelIconIdatlassian-warning
    panelIcon:warning:
    bgColor#FFEBE6

    Make sure to Test your App Locally with Epic’s Signaling Server before uploading.

    Step 1. Select all the files in your Root folder

    In the Root folder, where the exe file of your Application is located, select all the files and folders.

    Image Added

    Step 2. Create an Archive of your Packaged Project’s Root folder

    Note

    Note : If you upload a project without archiving it first then , the upload will fail (image 2).

    Image Removed

    1.2 Right

    .

    The Supported archive format is ZIP.

    Panel
    panelIconIdatlassian-info
    panelIcon:info:
    bgColor#FFFFFF

    Use ZIP as your Archive format, right-click on the selected files

    to bring up the context menu. In the context menu, select "Send to"->”

    →Send to → Compressed (zipped)

    folder”(image 3).
    Tip

    You can use any archive creation software. Supported archive formats: RAR, ZIP, 7z.

    Image Removed

    Info

    Here is an example of creating an archive in the WinRar application that Windows provides (image 4 and image 5).

    Image Removed
    Image Removed

    Step 2: Upload the Application

    2.1 Go to the Control Panel by your URL (image 6).

    Info

    If you don't have access to the Control Panel, please contact our support team for a custom URL. Get Access.

    Image Removed

    2.2 In the APP section, click the Add button (image 7), and enter the name of the application in the opened popup window, which exactly matches the executable file (.exe) inside the ready-to-upload archive, then click the Ok button (image 8).

    Image RemovedImage Removed

    Warning

    Be sure to enter the name of the app before clicking ‘Upload New App’. Clicking ‘Upload New App’ before entering an app name will result in an error.

    2.3 Once you have verified that the application name is correct, click the Upload button. A new tab will open in your browser (image 9).

    Image Removed

    2.4 Click the Browse button, select the archive with the project in the opened window (image 10) and click the Open button.

    Image Removed

    2.5 Click the Upload button and wait for the project to upload.

    folder

    Image Added

    Step 3. Add the name of your App

    Info

    Go to:Control Panel → Step 1: App Selection → Add → enter the name of your App → click OK

    Panel
    panelIconIdatlassian-warning
    panelIcon:warning:
    bgColor#FFEBE6

    The name of your App should match exactly the name of your exe file from your Root folder.

    If you input a different name, your App will fail to start (it will get stuck on the loading phase (Starting App page))

    Note

    The App name should NOT contain any dot or space as it might cause streaming issues.

    image-20240501-055233 (1).pngImage Added

    Step 4. Upload your App

    1- Click Upload from Step 1 : Select an App

    A new tab of the Uploader page will open in your browser.

    Warning

    Note : For the first version of your App, enter the name of the App before clicking the ‘Upload’ button, or else, an error warning message will appear.

    image-20240501-060032 (1).pngImage Added

    2- Click Browse → select the archived Project → Open

    Image Added

    3- Click on ´Verify´ for a verification of the zip file

    image-20231225-102341 (1).pngImage Added

    4- Click Upload

    In the progress bar, you will see the application uploading progress

    (image 11).Image Removed

    As soon as the project is uploaded to the server, you will see a message about the successful completion of the upload, in place of the Upload button (image 12).

    Image Removed

    Step 3. Create Config

    Info

    You don't have to create a new config for every new application. If you already have a Config that suits your new application just select it.

    3.1 When the application is uploaded, go back to the Control Panel tab, and click the Add button in a CONFIG section (image 13). In the opened window enter any name for your new Config, then click the Ok button (image 14).

    Note

    Please note, spaces are not allowed in the config name.

    Image RemovedImage Removed

    Warning

    If invalid characters are entered in the name of your config, you will see an error when you try to run the application (image 15). Delete this config (image 16) and create a new one with the correct name.

    Image Removed
    Image Removed

    Tip

    In the following tutorials, you will find a detailed description of all the features in the Application Config (image 17).

    Image Removed

    Step 4. Play Application

    4.1 Select the application from the list of apps in the APP section to launch (image 18).

    Image Removed
    Info

    If you don't see the application in the list, refresh the page and select the application in the list again.

    Info

    To refresh the page, press F5 on your keyboard or use the corresponding button in your browser.

    4.2 Select a config file from the list of configs in the CONFIG section for this app (image 19).

    Image Removed

    4.3 Click the Play App button in the GENERATE URLS section to start the game. The game will open in a new tab.

    Tip

    You can also Copy the App URL or iframeScript to embed or share on your site.

    Image Removed

    Tip

    In the following tutorials, you will find a detailed description of all the features in the Control Panel (image 21).

    Image Removed

    Image Added
    Image Added

    5- Your App is successfully uploaded if the progress bar displays "Upload completed"

    Panel
    panelIconIdatlassian-info
    panelIcon:info:
    bgColor#E6FCFF

    Tip : Refresh the page to see your App in Step 1: Add an App.

    Now you are ready to Upload your Project on Eagle 3D’s Platform !

    Info

    Set a new Config from your Control Panel.

    Generate URLs from the Control Panel.

    Was this article helpful? Comment Below. Let us know your feedback.

    Need help? Contact Support

    If you still need help, contact support to get your issue resolved quickly.

    Submit a new request at E3DS support portal or send an Email at support@eagle3dstreaming.com.

    Seek advice. Connect with others. Share your experiences. Join our lively E3DS Community Forum today.