Merge pull request #115 from EpicGames/UE5.2

Bring 5.2 changes back to master

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

@@ -36,6 +36,10 @@ jobs:
       working-directory: ./Frontend/library
       run: npm run build
 
+    - name: NPM link frontend lib into ui-library
+      working-directory: ./Frontend/ui-library
+      run: npm link ../library
+
     - name: Install ui-library deps
       working-directory: ./Frontend/ui-library
       run: npm ci
@@ -44,6 +48,10 @@ jobs:
       working-directory: ./Frontend/ui-library
       run: npm run build-all
 
+    - name: NPM link frontend and ui-library into implementations/EpicGames
+      working-directory: ./Frontend/implementations/EpicGames
+      run: npm link ../../library ../../ui-library
+
     - name: Install implementations/EpicGames deps
       working-directory: ./Frontend/implementations/EpicGames
       run: npm ci

Frontend/ui-library/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "description": "Frontend library default UI for Pixel Streaming",
     "main": "dist/lib-pixelstreamingfrontend-ui.js",
     "types": "types/pixelstreamingfrontend-ui.d.ts",
@@ -26,7 +26,7 @@
         "webpack-cli": "^5.0.1"
     },
     "dependencies": {
-        "@epicgames-ps/lib-pixelstreamingfrontend-ue5.2": "0.0.1",
+        "@epicgames-ps/lib-pixelstreamingfrontend-ue5.2": "0.1.0",
         "jss": "^10.9.2",
         "jss-plugin-camel-case": "^10.9.2",
         "jss-plugin-global": "^10.9.2"

README.md

@@ -18,25 +18,36 @@ Reference implementations for the various pieces needed to support a PixelStream
 - Matchmaker
 - Frontend (the javascript frontend library for the WebRTC player and input)
 
-## Container images
 
-The following container images are built from this repository:
+## Releases
+We release a number of different things under this repository, currently they are:
 
-- [ghcr.io/epicgames/pixel-streaming-signalling-server](https://github.com/orgs/EpicGames/packages/container/package/pixel-streaming-signalling-server) (since Unreal Engine 5.1)
+- container images for the signalling server
+- npm packages for the frontend
+- source releases of this repo with the reference frontend built as a minified js bundle
 
-## Releases
+### Container images
 
-### Frontend library (Unofficial NPM packages)
+The following container images are built from this repository:
+
+- [ghcr.io/epicgames/pixel-streaming-signalling-server](https://github.com/orgs/EpicGames/packages/container/package/pixel-streaming-signalling-server) (since Unreal Engine 5.1)
 
-- UE 5.2
+### NPM Packages
 
-`npm i @epicgames-ps/lib-pixelstreamingfrontend-ue5.2`
+| Branch | Frontend library | Frontend reference ui |
+|--------|------------------|-----------------------|
+| UE5.2  |[lib-pixelstreamingfrontend-ue5.2](https://www.npmjs.com/package/@epicgames-ps/lib-pixelstreamingfrontend-ue5.2)|[lib-pixelstreamingfrontend-ui-ue5.2](https://www.npmjs.com/package/@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2)|
 
-- Dev
+### NPM getting started
 
-`npm i @epicgames-ps/lib-pixelstreamingfrontend-dev`
+```bash
+#frontend (core lib)
+npm i @epicgames-ps/lib-pixelstreamingfrontend-ue5.2
+#frontend ui
+npm i @epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2
+```
 
-### Full release + built reference implementation
+### Tagged source releases + built typescript frontend
 
 [Github releases](https://github.com/EpicGames/PixelStreamingInfrastructure/releases)
 

RELEASE_VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1