Versions Compared

Key

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

Information on Learn how to append Parameters to your App URL from the Old Control panel and how to use that to authenticate by appending a user’s Email address.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

It is possible to append CMD Line Arguments with existing ones. This can be used for authentication / token purposes.

...

Overview

After Passing a Command to your App from the Control Panel Config “Parameters to Pass to App”, you can append Parameters to your App URL by enabling the Feature “Should append parameters from URL with existing one to override?” from the Old Control Panel and adding CMD Line arguments to the end of your App URL.

Instructions :

Step 1. Prepare the setup

FollowStep 1of To prepare the setup for this tutorial to prepare the setup to Pass Parameters to get our E3DSFeaturesTemplate UE Project and upload it on your Control panel and to create a CmdLineDemo Config.

...

, refer to this document and follow the instructions.

These are the steps explained in the document which should be completed before moving to Step 2 :

  1. Download the sample App “E3DSFeatures Template”.

  2. Upload “E3DSFeaturesTemplate” on the Old Control Panel.

  3. Select the App from the List in “Step 1 : Select an App” in the Old Control Panel.

  4. Create a New Config and call it “CMDLineDemo” from “Step 2 : Create a Config” in the Control Panel.

  5. Enable “Parameters to Pass to App” from the “Developer Option” Tab of the Config “CMDLineDemo”.

  6. Add -green in the text

...

  1. box of Parameters to Pass to App

...

Info

Go to: Control Panel > Step 2: Config Selection > Edit > Developer Option > Parameters to Pass to App > Enter -green

image-20240515-145230.pngImage Removed

...

  1. ”.

  2. Play the “E3DSFeaturesTemplate” game from “Step 3 : Generate URLs” and run to the 12th Bay.

  3. Check the color of the Sphere in the 12th Bay. It should be green (since we added the Command -green).

After completing the steps above from the document, you are now ready to move to Step 2 of this tutorial to Append Parameters To your App URL.

Step 2. Enable Should append parameters from URL with existing one to override

...

  1. In

...

  1. the Old Control Panel, select “CMDLineDemo” Config from “Step 2 : Create a Config”.

  2. Go to : Edit Config > Developer Option.

  1. Enable Should append parameters from URL with existing one to override

...

Info

UE will receive the command during runtime. The color of the sphere should be green when you run the game.

Image Removed

Step 4. Open the game. Run to the 12th bay

Open the game to check the color of the sphere.

Info

Go to: Control Panel > Step 3: Generate URLs > Play App > Run to the 12th bay

The color of the sphere changed to green.

Image Removed

...

  1. ?” (see image below).

  2. Click “Save”.

...

Step 3. Copy the App URL to the clipboard

...

  1. Go to : Control Panel > Step 3: Generate URLs

...

  1. .

  2. Click “Copy App

...

  1. URL”. (See image below).

...

  1. This URL will be copied to the clipboard (demo is an example username) :

https://connector.eagle3dstreaming.com/v5/demo/E3DSFeaturesTemplate/CmdLineDemo

Step

...

4. Add

...

Command lines to the copied App URL

...

panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

...

We are going to add ?exeLunchArgs=-[variable]

...

to the end of the URL. Follow the examples below :

  • Example 1 :

...

In this example, we are adding ?exeLunchArgs=-blue

...

to the end of the URL :

https://connector.eagle3dstreaming.com/v5/demo/E3DSFeaturesTemplate/CmdLineDemo?exeLunchArgs=-blue

...

The system has now appended the

...

Command and has sent both the

...

Command added into the

...

Config (i.e. -green) and the

...

Command added into the URL (i.e. ?exeLunchArgs=-blue) to the UE game.

  • Example 2 :

...

In this example, we are adding ?exeLunchArgs=-green pink red

...

to the end of the URL

https://connector.eagle3dstreaming.com/v5/demo/E3DSFeaturesTemplate/

...

CmdLineDemo?exeLunchArgs=-green pink red

The system has now appended the ?exeLunchArgs=-green pink red Command and has sent both the Command added into the Config (i.e. -green) and the Command added into the URL (i.e. ?exeLunchArgs=-green pink red) to the UE game.

Step

...

5. Open the game. Run to the 12th bay

Paste the App URL (i.e. that you added the Command to) in from the Clipboard to the Browser :

https://connector.eagle3dstreaming.com/v5/demo/E3DSFeaturesTemplate/CmdLineDemo?exeLunchArgs=-blue,

Warning 🛑

Note

DO NOT run the game by clicking “Play App” in “Step 3 : Generate URLs” of the Control Panel !!!

That causes you to ONLY see the changes made to the “Parameters to Pass to App” Config from the Control Panel (i.e. the green color) and not the ones made to the App URL.

In the game, 2 values will be getting parsed from two 2 places in the CMDLine arguments in the game. (See image below)(image below):

  1. From the “Parameters To Pass to App” Config Feature (the green color).

  2. From the additional Command added to the end of the URL (the Blue color).

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7#E6FCFF

Now that we are familiar with how the appending Appending system works, we can explore how this is used for authentication.

Step 8. Authenticate by a user’s Email address

On the URL side, append the user’s email address to the URL, so that it looks like this:

(assuming that you know how to do this programmatically)

https://connector.eagle3dstreaming.com/v5/demo/E3DSFeaturesTemplate/CmdLineDemo?exeLunchArgs=-user=myEmailAddress@gmail.com

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Note : This link will not work and is for demonstration purposes only.

By adding the email address into the URL (the '@' sign is an accepted character),

you will be able to pass the email address into your UE app where you can then proceed with the authentication.

Within the E3DSFeaturesTemplate App (source https://bitbucket.org/Eagle3DStreaming/e3dsfeaturestemplate/), there is a blueprint showing how to receive a value

(in the E3DSFeaturesTemplate example we show how to use the Command Line to get an IP Address for multiplayer). (Check this document).

Special Data:

...

%ip_streamer% will pass the IP address of the machine where UE app is running

...

%port_streamer2ss% will pass the port of the Signaling server through which UE app communicates with the signaling server

Step 9. Add these Commands to Parameters to Pass to App

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#E6FCFF

Add these Commands -bb=%ip_streamer% and -aa=%ip_ss%:%port_streamer2ss%

Image Removed

Step 10. Get this Output

...

Authentication. Refer to this document.

...

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.

Requests sent on weekends will not be addressed until the following business day.