Versions Compared

Key

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

In this section we will guide you to upload your app automatically using E3DS Automation plugins. Follow the steps below to upload app using E3DS Automation Tools:

Info

Why use E3DS Automation Tools?

  • Automatically packaging your Unreal Engine Pixel Streaming project,

  • Automatically zipping it up and

  • Automatically uploading it to Eagle 3D Streaming System.

All these things are done with just a single click and makes your overall process very smooth by taking the responsibility of uploading your project to the perfect place it should be.

Step 1. Open your Unreal Engine project folder and create a “Plugins” folder inside your project folder.

Note

If Plugins folder already existed then skip this step

image-20241023-053549.pngImage Removed

Step 2. Download E3DS Automation Tools from this URL and extract it inside the “Plugins” folder.

Info

If you want to install E3DS Automation Tools from marketplace then follow this docs to upload and stream your app.

Info

If you want to install E3DS Automation Tools by cloning github repository of E3DS then follow this docs to upload and stream your app.

image-20241023-160909.pngImage Removed

Note

Rename the extracted folder as “E3DSAutomationTools” as shown in Figure 3. Make sure the folder structure and the contents inside the “E3DSAutomationTools” are like Figure 4.

image-20241025-093232.pngImage Removed

image-20241025-093813.pngImage Removed

Step 3. Open your project in Unreal editor and Go to Edit > Plugins

image-20241021-152709.pngImage Removed

Step 4. Enable Pixel Streaming Plugins. Then restart your Unreal Editor.

image-20241021-153944.pngImage Removed

Step 5. Go to Edit > Project Settings

image-20241021-154520.pngImage Removed

Step 6. From Plugins select “E3DS Automation Tools Settings”

image-20241021-154815.pngImage Removed

Step 7. Configure E3DS Automation Tools Settings

Info

Download EL_AT.exe file (If you have not downloaded it before)

image-20241023-171302.pngImage Removed

Info

Download 7-Zip application and install that match your computer specification (If you have not done it before)

image-20241023-163051.pngImage Removed

...

Warning

Do not configure the fields that is shown in Figure 13, 14 and 15 as these field are automatically configured.

image-20241025-101054.pngImage Removedimage-20241025-101401.pngImage Removedimage-20241025-101419.pngImage Removed

...

(iii) Login to Control Panel and copy the api key of your E3DS Account by visiting this link (Figure 18) and paste it to API Key field (Figure 19)

...

(iv) Give Your E3DS App Name

...

Info

If you upload using a name that has been previously used, it will create a new version of that application.

image-20241022-032007.pngImage Removed

(v) Choose Packaging Mode

There are two types of packaging mode : Development mode and Shipping mode. In development mode the packaging is slower and you can see the “Output logs” while packaging it. On the other hand in shipping mode the packaging is faster but you can’t see the “Output logs” while packaging it.

...

(vi) In “Packaging Folder” Choose the folder where you want to store the packaged version of your application (Figure 22 and 23)

Note

Choose an empty folder

image-20241021-162511.pngImage Removedimage-20241021-165027.pngImage Removed
Note

Do not check the “Do Dedicated Server Build” checkbox unless you are using Unreal Editor of E3DS.

image-20241023-070127.pngImage Removed

Step 8. Launch your project

Select Launch E3DS Automation Tool to push the project to cloud (Figure 25)

image-20241021-165425.pngImage Removed

After clicking Launch E3DS Automation Tool you will see a command prompt (Figure 26). Wait a moment and then you will see the message in the command prompt indicating the app is uploaded (Figure 27)

image-20241022-013647.pngImage Removedimage-20241022-013629.pngImage Removed

Step 9. Now come to Control Panel and you will see your uploaded app

image-20241022-013803.pngImage Removed

Step 10. Click Create New Stream link

image-20241022-013823.pngImage Removed

Step 11. Click Play App

image-20241022-013848.pngImage Removed

Step 12. Wait to get a slot

image-20241029-130051.pngImage Removed

image-20241019-072443.pngImage Removed

Note

If you face any problem in this step then check [2] [3]

Step 13. Acquiring App

Info

The app is being downloaded to the streamer machine from cloud storage.

image-20241029-130308.pngImage Removed

Step 14. Preparing and Launching App

Info

The app is downloaded as ZIP file, which is extracted during the the preparation phase and then the app is launched for streaming.

image-20241029-130349.pngImage Removed

image-20241029-141150.pngImage Removed

Step 15. Press Play Button

Info

App is ready to stream

image-20241019-072551.pngImage Removed

Note

If you face any problem in this phase then check [3]

Step 16. Now you can see the app is streaming.

image-20241019-072702.pngImage Removed

Troubleshooting

1. Github ZIP version issue

When a new update is made to the E3DS Automation Tools on the GitHub repository, it may take 4-5 minutes to prepare the ZIP version. To verify if a recent update has been made, you can check this Github repository .

2. Stuck in queue issue

If you are consistently stuck in the queue, it is likely due to a network issue. Please try again after some time.

...

3. Stuck on the “Starting App” issue

Info

If your app typically streams without issues but sometimes gets stuck on the “Starting App” screen, this could be caused by a temporary network issue.

If your application is stuck on the "Starting App" page and displays a message similar to Figure 39, it likely indicates that the app was uploaded without enabling Pixel Streaming. To resolve this issue, please refer to the Enable Pixel Streaming Plugins Section to enable it.

The error message is “Our record indicates Your this app version don't have pixel streaming plugin enabled.So it cant stream”

image-20241020-200808.pngImage Removed

...

.

...

image-20241020-201243.pngImage Removed