This document is a tutorial of the feature ‘'Should Append Parameters from URL with existing one to override’'.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
It is possible to append CMDLine Arguments with existing ones. This can be used for authentication / token purposes. |
Prepare to execute instructions
| Info |
|---|
For this document you need to:
|
- 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.
...
Learn how to append Parameters to your App URL from the Old Control panel.
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
...
To prepare the setup for this tutorial
...
, 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 :
Download the sample App “E3DSFeatures Template”.
Upload “E3DSFeaturesTemplate” on the Old Control Panel.
Select the App from the List in “Step 1 : Select an App” in the Old Control Panel.
Create a New Config and call it “CMDLineDemo” from “Step 2 : Create a Config” in the Control Panel.
Enable “Parameters to Pass to App
...
” from the “Developer Option” Tab of the Config “CMDLineDemo”.
Add -green in the text
...
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 → Save. |
...
”.
Play the “E3DSFeaturesTemplate” game from “Step 3 : Generate URLs” and run to the 12th Bay.
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
...
| Info |
|---|
UE will receive the command during runtime. The color of the sphere should be green when you run the game. |
Step 3. 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. |
...
Step 4. Copy the App URL
...
Go to : Control Panel → Step 3: Generate URLs → Copy App URL
...
In the Old Control Panel, select “CMDLineDemo” Config from “Step 2 : Create a Config”.
Go to : Edit Config > Developer Option.
Enable “Should append parameters from URL with existing one to override?” (see image below).
Click “Save”.
...
Step 3. Copy the App URL to the clipboard
Go to : Control Panel > Step 3: Generate URLs.
Click “Copy App URL”. (See image below).
...
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
...
We are going to add ?exeLunchArgs=-[variable]
...
to the end of the URL.
...
For example:
...
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
Open the game again to see the additional Command Lines you have added.
...
| panelIconId | atlassian-info |
|---|---|
| panelIcon | :info: |
| bgColor | #F4F5F7 |
...
Paste the App URL 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
...
2 places in
...
the CMDLine arguments (image below):
From the “Parameters To Pass to App” Config Feature (the green color).
From the additional Command added to the end of the URL (the Blue color).
...
| Panel | |||||
|---|---|---|---|---|---|
|
...
| |
Now that we are familiar with how the |
...
Step 7. Authenticate by a user’s Email address
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
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)
(this link will not work and is for demonstration purposes only). |
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
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, 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). |
Special data:
| Info |
|---|
|
Step 8. Add -bb=%ip_streamer% -aa=%ip_ss%:%port_streamer2ss%
Add these Commands in Parameters to Pass to App.
...
Step 9. Get this Output
...
Appending system works, we can explore how this is used for |
...
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
...
.
...
Requests sent on weekends will not be addressed until the following business day.