Sync branch with master and update github actions for this branch

.github/workflows/container-images.yml

@@ -0,0 +1,31 @@
+name: Publish the Signalling Server container image from our dev branch
+
+on:
+  push:
+    branches: ['UE5.2']
+    paths: ['SignallingWebServer/**']
+
+jobs:
+  signalling-server-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Build and push the Signalling Server container image for Unreal Engine based on our development branch
+        uses: docker/build-push-action@v3
+        with:
+          context: ./SignallingWebServer
+          tags: 'ghcr.io/epicgames/pixel-streaming-signalling-server:dev'
+          push: true

.github/workflows/create-gh-release.yml

@@ -0,0 +1,73 @@
+name: Releases
+
+on: 
+  push:
+    branches: ['UE5.2']
+    paths: ['RELEASE_VERSION']
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./
+
+    permissions:
+      contents: write
+    steps:
+    - name: "Checkout source code"
+      uses: actions/checkout@v3
+
+    - name: Read the RELEASE_VERSION file
+      id: getversion
+      run: echo "version=$(cat RELEASE_VERSION)" >> $GITHUB_OUTPUT
+
+    - uses: actions/setup-node@v3
+      with:
+        node-version: '16.x'
+        registry-url: 'https://registry.npmjs.org'
+
+    - name: Install library deps
+      working-directory: ./Frontend/library
+      run: npm ci
+
+    - name: Build frontend lib
+      working-directory: ./Frontend/library
+      run: npm run build
+
+    - name: Install implementations/EpicGames deps
+      working-directory: ./Frontend/implementations/EpicGames
+      run: npm ci
+
+    - name: Build implementations/EpicGames
+      working-directory: ./Frontend/implementations/EpicGames
+      run: npm run build-all
+
+    - name: Make output directory for archives
+      run: mkdir output
+
+    - name: Archive Release tar.gz
+      uses: thedoctor0/zip-release@0.7.1
+      with:
+        directory: './output'
+        path: '../'
+        type: 'tar'
+        filename: '${{ github.ref_name }}-${{ steps.getversion.outputs.version }}.tar.gz'
+        exclusions: '.git .github output Frontend/Docs Frontend/library/dist Frontend/library/types Frontend/library/node_modules Frontend/implementations/EpicGames/node_modules'
+
+    - name: Archive Release tar.gz
+      uses: thedoctor0/zip-release@0.7.1
+      with:
+        directory: './output'
+        path: '../'
+        type: 'zip'
+        filename: '${{ github.ref_name }}-${{ steps.getversion.outputs.version }}.zip'
+        exclusions: '*.git* /*node_modules/* .editorconfig /*types/* /*dist/* /*output/* /*Docs/*'
+
+    - name: "Make the release"
+      uses: ncipollo/release-action@v1
+      with:
+        tag: "${{ github.ref_name }}-${{ steps.getversion.outputs.version }}"
+        artifacts: "output/${{ github.ref_name }}-${{ steps.getversion.outputs.version }}.zip,output/${{ github.ref_name }}-${{ steps.getversion.outputs.version }}.tar.gz"
+        generateReleaseNotes: true

Frontend/.github/workflows/release.yml → .github/workflows/publish-library-to-npm.yml

@@ -1,14 +1,14 @@
 name: Publish library package to npmjs
 on:
   push:
-    tags:
-      - '*'
+    branches: ['UE5.2']
+    paths: ['Frontend/library/package.json']
 jobs:
   build:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: ./library
+        working-directory: Frontend/library
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3

.gitignore

@@ -5,4 +5,5 @@ node_modules/
 **/platform_scripts/bash/*/
 node.zip
 SignallingWebServer/Public/
+SignallingWebServer/certificates
 .vscode

Frontend/Docs/Accessing the Pixel Streaming Blueprint API.md

@@ -0,0 +1,13 @@
+**TO DO**: Update this information to match the new front end.
+
+## Accessing the Pixel Streaming Blueprint API
+
+The Pixel Streaming Plugin that runs within the Unreal Engine exposes a Blueprint API that you can use in your gameplay logic to handle custom UI events sent by the player HTML page, and to emit events from the Unreal Engine to the player page.
+
+To access this Blueprint API, add the **PixelStreamingInputComponent** to an Actor in your level. Your application's **PlayerController** is a safe choice. You can do this by clicking **Add Component** in the Blueprint menu and selecting the **Pixel Streaming Input** component from the dropdown.
+
+
+![Adding the Pixel Streaming component.](Resources\Images\pixelstreaming-add-component.jpg)
+
+
+**_NOTE:_** Prior to UE 4.27, the PixelStreamingInput Component was automatically added when you loaded the Pixel Streaming plugin. This was problematic, and now requires users to add this to their project themselves, as seen above.

Frontend/Docs/Communicating from UE5 to the Player Page.md

@@ -0,0 +1,38 @@
+**TO DO**: Update this information to match the new front end.
+
+## Communicating from UE5 to the Player Page
+
+You can make your Unreal Engine application emit custom events to all connected player HTML pages, which you can respond to in the player's JavaScript environment. This lets you change your web page UI in response to gameplay events.
+
+To set this up:
+
+1.  In your Unreal Engine application, any time you want to emit an event to the player page, use the **Pixel Streaming > Send Pixel Streaming Response** node. Specify a custom string argument to the node to indicate to the player page what event has happened.  
+
+
+    ![](Docs\Resources\Images\pixelstreaming-send-game-event.JPG)
+
+2.  In the JavaScript of your player page, you'll need to write a custom event handler function that will be invoked each time the page receives a response event from the Unreal Engine application. It will be passed the original string argument that was sent by the **Send Pixel Streaming Response** node. For example:
+
+        function myHandleResponseFunction(data) {
+            console.warn("Response received!");
+            switch (data) {
+                case "MyCustomEvent":
+                    ... // handle one type of event
+                case "AnotherEvent":
+                    ... // handle another event
+            }
+        }
+
+3.  Register your listener function by calling the `addResponseEventListener` function provided by `app.js`. You pass this function a unique name for your event listener, and your function. For example:
+
+        addResponseEventListener("handle_responses", myHandleResponseFunction);
+
+4.  If you ever need to remove your event listener, call `removeResponseEventListener` and pass the same name. For example:
+
+        removeResponseEventListener("handle_responses");
+
+**_Tip:_**
+If you want to pass more complex data, you can format the string you pass to the **Send Pixel Streaming Response** node as JSON. For example:  
+![Send Pixel Streaming response using JSON](Resources\Images\pixelstreaming-send-game-event-json.png "Send Pixel Streaming response using JSON")  
+Then, in your JavaScript event handler function, use  `JSON.parse(data)` to decode the string back into a JavaScript object.
+

Frontend/Docs/Communicating from the Player Page to UE5.md

@@ -0,0 +1,62 @@
+**TO DO**: Update this information to match the new front end.
+
+## Communicating from the Player Page to UE5
+
+The `app.js` file provides two JavaScript functions that you can call in your HTML player page to allow the user to send events and commands from the browser to the Unreal Engine application:
+
+*   You can use `emitCommand` to send console commands back to Unreal Engine. For example, `stat fps` to show the frame rate. See [Using the emitCommand Function below](#usingtheemitcommandfunction).
+*   `emitUIInteraction` sends any arbitrary string or JavaScript object to the game. Use this function to send your own custom commands from your player UI, which you can respond to in your gameplay logic to produce any effect you need in your application. See [Using the emitUIInteraction Function below](#usingtheemituiinteractionfunction).
+
+### Using the emitCommand Function
+
+When you call the `emitCommand` function, you must pass it a JavaScript object. This object must contain a key that matches one of the following strings:
+
+*   `ConsoleCommand` \- Use this key to execute a console command on the remote Unreal Engine application. The value of this key should be a string that contains the command you want to run, along with any parameters it needs. For example:
+
+        let descriptor = {
+            ConsoleCommand: 'stat fps'
+        }
+        emitCommand(descriptor);
+
+**_NOTE:_**
+Due to the power of the Unreal Engine console commands, the `emitCommand` function can present a security risk. In order for this function to work, you also need to provide the `-AllowPixelStreamingCommands` parameter on the command line when you launch your Unreal Engine application or start it from the Unreal Editor using the Standalone Game option.
+
+
+### Using the emitUIInteraction Function
+
+When you call the `emitUIInteraction` function, you can pass it a single string or JavaScript object. For example:
+
+    emitUIInteraction("MyCustomCommand");
+
+or
+
+    let descriptor = {
+        LoadLevel: "/Game/Maps/Level_2"
+        PlayerCharacter: {
+            Name: "Shinbi"
+            Skin: "Dynasty"
+        }
+    }
+    emitUIInteraction(descriptor);
+
+If you pass a JavaScript object, the `emitUIInteraction` function converts it to a JSON string internally. It then passes the resulting string back to the Pixel Streaming Plugin in your Unreal Engine application, which raises an event on the input controller. In your application's gameplay logic, you bind your own custom event to handle these inputs, using the **Bind Event to OnPixelStreamingInputEvent** node. For example:
+
+![Bind Event to OnPixelStreamingInputEvent](Resources\Images\pixelstreaming-uiinteractionrespond.JPG "Bind Event to OnPixelStreamingInputEvent")
+
+You need to bind this event once, typically at the start of your game. Each time any player HTML page connected to an instance of your Unreal Engine application calls the `emitUIInteraction`function, your custom event is automatically invoked, regardless of the input passed to `emitUIInteraction`.  
+
+The custom event you assign (for example, the **UI Interaction** node in the image above) has an output named **Descriptor**, which you can use to retrieve the string that was sent to your Unreal Engine application by the `emitUIInteraction` function. You can use that value to determine how your gameplay code needs to respond each time `emitUIInteraction` is called.
+
+For example, the following Blueprint tests to see whether the input given to `emitUIInteraction` contains the string "MyCustomCommand", and calls a custom function to handle the event:
+
+
+![Search for substring](Resources\Images\pixelstreaming-respond-searchsubstring.JPG "Search for substring")
+
+If you originally passed a JavaScript object to `emitUIInteraction`, you can retrieve the value of any key from that JSON object using the **Pixel Streaming > Get Json String Value** node. For example, the following Blueprint tests for a key named LoadLevel. If that key is present, it calls a custom function to handle the event:
+
+[![Get a JSON field value](Resources\Images\pixelstreaming-respond-json.JPG "Get a JSON field value")](pixelstreaming-respond-json.JPG)
+
+
+**_Tip:_**
+If you need to retrieve a nested key, use the dot notation common in JavaScript for your key. 
+For example, `PlayerCharacter.Name` or `PlayerCharacter.Skin`.

Frontend/Docs/Customizing Player Input Options.md

@@ -0,0 +1,45 @@
+**TO DO**: Update this information to match the new front end.
+
+## Customizing Player Input Options
+
+The `app.js` file offers some JavaScript configuration parameters that you can override in your custom player page to control the way the player widget responds to user interactions. The `inputOptions` object exposes the following properties:
+
+| Property | Default | Description |
+| --- | --- | --- |
+| controlScheme | `ControlSchemeType.LockedMouse` | Determines whether or not the player widget captures and locks the mouse when the player interacts with the widget.|
+| suppressBrowserKeys | true |When this setting is enabled, the player widget will intercept function keys (**F1** to **F12**) and the **Tab** key, and pass those keypress events through to the Unreal Engine application rather than allowing the browser to process them normally.| This means, for example, that while this setting is active, pressing **F5** will not refresh the player page in the browser. Instead, that event is passed through to the Unreal Engine application, and has its usual function of switching the view to visualize shader complexity.
+| fakeMouseWithTouches | false | When this option is enabled, and the user is viewing the stream on a device with a touch screen such as a smartphone or tablet, this setting causes single-finger touch events to be interpreted by the Unreal Engine application as mouse clicks and drag events. Enabling this setting can provide users on mobile devices with the ability to partially control your Unreal Engine application, even when the application's input controller does not specifically handle touch input events. |
+
+
+**_NOTE:_**  The controlScheme accepts the following values:
+* `ControlSchemeType.LockedMouse` - When this control scheme is active, clicking on the player widget causes it to capture and lock the mouse cursor. Any further movements of the mouse are passed immediately to the input controller in the Unreal Engine application. This typically allows the user to move and rotate the camera by simply dragging the mouse. To release the cursor from the control of the player widget, the user can press the **Esc** key.
+* `ControlSchemeType.HoveringMouse` - When this control scheme is active, the mouse cursor hovers over the player widget without interacting with it. In order to send the mouse movements to the input controller of the Unreal Engine application, the user needs to click and hold the left button of the mouse.
+
+
+You can set these values in your player page by including a code block like the following. Make sure that you run this code any time after you load the `app.js` file into the page, but before you call its `load` function.
+
+    <script>
+    inputOptions.controlScheme = ControlSchemeType.HoveringMouse;
+    inputOptions.fakeMouseWithTouches = true; 
+    </script>
+
+### Disabling User Input
+
+To disable user input entirely for one or more types of input device, you can override the following functions in the JavaScript environment for your player page with empty implementations:
+
+*   **registerHoveringMouseEvents** - Disables all input mouse events when the inputOptions.controlScheme is set to ControlSchemeType.HoveringMouse.
+*   **registerLockedMouseEvents** - Disables all input mouse events when the inputOptions.controlScheme is set to ControlSchemeType.LockedMouse.
+*   **registerTouchEvents** - Disables touch events on mobile devices and tablets.
+*   **registerKeyboardEvents** - Disables all keyboard events.
+
+For example, you could include this block of JavaScript in your player HTML page to disable all inputs. As above, run this code any time after you load the `app.js` file into the page, but before you call its `load` function.
+
+    <script>
+    registerHoveringMouseEvents = function() {}
+    registerLockedMouseEvents = function() {}
+    registerTouchEvents = function() {}
+    registerKeyboardEvents = function() {} 
+    </script>
+
+To keep one or more types of inputs active, comment out or remove the line that corresponds to the type of input you want to keep.
+

Frontend/Docs/Customizing the Player Webpage.md

@@ -0,0 +1,28 @@
+**TO DO**: Update this information to match the new front end.
+
+## Customising the Player Webpage
+The Pixel Streaming Signaling and Web Server provides a sample player page that is already set up to stream in media from your Unreal Engine application and to send mouse, keyboard, and touch events back to the application. You can use this default player page as-is, if it meets your needs. 
+
+Recent changes to Pixel Streaming have moved the front end and web server elements of Pixel Streaming to an external repository. We refer to this as the Pixel Streaming Infrastructure.
+
+There are a few ways to access the Pixel Streaming infrastructure.
+1. Directly access the github repository as found here: [https://github.com/EpicGames/PixelStreamingInfrastructure](https://github.com/EpicGames/PixelStreamingInfrastructure)
+1. Use `git clone --branch UE5.1 https://github.com/EpicGames/PixelStreamingInfrastructure.git` in your preferred terminal (make sure you have git installed). 
+1. Navigate to `\Engine\Plugins\Media\PixelStreaming\Resources\WebServers` and run the `get_ps_servers` command (make sure to use the `.bat` script for Windows and `.sh` script for Linux accordingly). This will automatically pull the relevant branch of the Pixel Streaming infrastructure into that folder.
+The git command mentioned above will pull the 5.1 branch of the infrastructure. If you need a different branch, please modify the git command accordingly.
+
+For more information about the Pixel Streaming front end and webserver changes, see [Pixel Streaming Infrastructure](https://docs.unrealengine.com/5.1/en-US/pixel-streaming-infrastructure/)
+
+
+However, with a little creativity and some knowledge of web technologies like JavaScript and HTML, you can take full control over the player page, creating your own custom UIs for interacting with your Unreal Engine content remotely. You can trigger and respond to gameplay events, issue console commands to control the Unreal Engine's behavior, and more.
+
+We recommend using the default player page as a starting point for creating your own custom player page. You'll find this page at `PixelStreamingInfrastructure\SignallingWebServer\Public\player.html` under your Unreal Engine installation folder. Then, use the information on this page to learn how to extend your page and tie it in with your Project's gameplay logic.  
+
+Additionally, if you have cloned the Pixel Streaming Infrastructure repository and made upstream changes, you can fork the repo and make a pull request.
+
+_The default Pixel Streaming player page:_
+![PixelStreamingDefaultPlayer](Resources\Images\pixelstreaming-default-interface.JPG)
+
+_A customised Pixel Streaming player page:_
+![PixelStreamingCustomPlayer](Resources\Images\pixelstreaming-custom-player.JPG)
+

Frontend/Docs/Customizing the Player Widget Style.md

@@ -0,0 +1,11 @@
+**TO DO**: Update this information to match the new front end.
+
+## Customizing the Player Widget Style
+
+In your custom HTML player page, you should have defined the Pixel Streaming player widget: a `div` element with `id="player"`. You can use standard HTML and CSS methods to add styling to this widget.
+
+However, the widget may occasionally need to reinitialize its size. This typically occurs when the browser window is resized (if the widget is set to automatically fill the available space), or when the resolution of the input video stream is updated. When this happens, the `style` attribute of the player element is overwritten with new values, which can potentially overwrite values that you have set in your own HTML or JavaScript.
+
+To avoid this, you can set your custom CSS values in a special global variable named `styleAdditional`. Whenever `app.js` needs to resize the player and clear its style, it will append the values you set in the `styleAdditional` variable to the end of the new style attributes it assigns to the player element. For example, the following value changes the mouse cursor to a hand when the user hovers the mouse over the player widget:
+
+    styleAdditional = 'cursor: grab; cursor: -moz-grab; cursor: -webkit-grab';