Rename implementations/EpicGames to implementations/typescript (#177)

Co-authored-by: William Belcher <william.belcher@xa.epicgames.com> (cherry picked from commit d92e46e) Co-authored-by: gunsha <gonzaller@gmail.com>
EpicGames · Jul 18, 2023 · 2dea212 · 2dea212
1 parent 149e526
commit 2dea212
Show file tree

Hide file tree

Showing 37 changed files with 382 additions and 386 deletions.
diff --git a/.github/workflows/create-gh-release.yml b/.github/workflows/create-gh-release.yml
@@ -48,16 +48,16 @@ jobs:
       working-directory: ./Frontend/ui-library
       run: npm run build-all
 
-    - name: Install implementations/EpicGames deps
-      working-directory: ./Frontend/implementations/EpicGames
+    - name: Install implementations/typescript deps
+      working-directory: ./Frontend/implementations/typescript
       run: npm ci
 
-    - name: NPM link frontend and ui-library into implementations/EpicGames
-      working-directory: ./Frontend/implementations/EpicGames
+    - name: NPM link frontend and ui-library into implementations/typescript
+      working-directory: ./Frontend/implementations/typescript
       run: npm link ../../library ../../ui-library
 
-    - name: Build implementations/EpicGames
-      working-directory: ./Frontend/implementations/EpicGames
+    - name: Build implementations/typescript
+      working-directory: ./Frontend/implementations/typescript
       run: npm run build-all
 
     - name: Move all content into output directory for archiving
@@ -70,7 +70,7 @@ jobs:
         path: 'PixelStreamingInfrastructure-${{ github.ref_name }}-${{ steps.getversion.outputs.version }}'
         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/ui-library/dist Frontend/ui-library/types Frontend/ui-library/node_modules Frontend/implementations/EpicGames/node_modules'
+        exclusions: '.git .github output Frontend/Docs Frontend/library/dist Frontend/library/types Frontend/library/node_modules Frontend/ui-library/dist Frontend/ui-library/types Frontend/ui-library/node_modules Frontend/implementations/typescript/node_modules'
 
     - name: Archive Release .zip
       uses: thedoctor0/zip-release@0.7.1

diff --git a/Frontend/Docs/Customizing the Player Webpage.md b/Frontend/Docs/Customizing the Player Webpage.md
@@ -1,5 +1,5 @@
 ## Recommended Reading
-We recommend starting with the [sample implementations](/Frontend/implementations/EpicGames/src) in order to judge how to put a new player page together and integrate it with your Unreal Engine application. Additionally, if you have cloned the Pixel Streaming Infrastructure repository and made upstream changes, you can fork the repo and make a pull request.
+We recommend starting with the [sample implementations](/Frontend/implementations/typescript/src) in order to judge how to put a new player page together and integrate it with your Unreal Engine application. Additionally, if you have cloned the Pixel Streaming Infrastructure repository and made upstream changes, you can fork the repo and make a pull request.
 
 ## Using the default Player Webpage
 The Pixel Streaming Signalling 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.

diff --git a/Frontend/Docs/HTML Page Requirements.md b/Frontend/Docs/HTML Page Requirements.md
@@ -1,6 +1,6 @@
 ## HTML Page Requirements
 
-Most of the HTML that will end up on the final page will actually be introduced by the Pixel Streaming application itself. Several example HTML pages are provided in the [sample implementations](/Frontend/implementations/EpicGames/src) where you can see the base page is very minimal, only serving as a space for the application to attach to and fill. The only concrete requirements are for ensuring there's sufficient space taken up by the element being attached to for the viewport to be visible on screen. In the sample implementations this is simply a `<body>` tag set to fill the screen without scrolling.
+Most of the HTML that will end up on the final page will actually be introduced by the Pixel Streaming application itself. Several example HTML pages are provided in the [sample implementations](/Frontend/implementations/typescript/src) where you can see the base page is very minimal, only serving as a space for the application to attach to and fill. The only concrete requirements are for ensuring there's sufficient space taken up by the element being attached to for the viewport to be visible on screen. In the sample implementations this is simply a `<body>` tag set to fill the screen without scrolling.
 
 ```html
 <!-- Copyright Epic Games, Inc. All Rights Reserved. -->
@@ -20,14 +20,14 @@ Most of the HTML that will end up on the final page will actually be introduced
 </html>
 ```
 
-As can be seen in the [sample implementations](/Frontend/implementations/EpicGames/src/player.ts), you must specify which element on the page the Pixel Streaming viewport is to be appended to. In the sample implementations this is typically done in the `document.body.onload` event listener and in this case appended to the `document.body` element in the DOM, causing it to fill the whole page.
+As can be seen in the [sample implementations](/Frontend/implementations/typescript/src/player.ts), you must specify which element on the page the Pixel Streaming viewport is to be appended to. In the sample implementations this is typically done in the `document.body.onload` event listener and in this case appended to the `document.body` element in the DOM, causing it to fill the whole page.
 
 [//]: # (This has yet to be done)
 ### Player File Location and URL
 
 You have a few options for where you can place your custom HTML player page, and how client browsers can access it.
 
-*	You can create a new implementation page and place it in [`/Frontend/implementations/EpicGames/src/`](/Frontend/implementations/EpicGames/src) alongside the sample implementations. This must consist of both a base `.html` page and the `.ts` source for your application's entrypoint. This will then be accessible by appending the name of the `html` file to IP address or hostname of the computer running the Signalling Server.
+*	You can create a new implementation page and place it in [`/Frontend/implementations/typescript/src/`](/Frontend/implementations/typescript/src) alongside the sample implementations. This must consist of both a base `.html` page and the `.ts` source for your application's entrypoint. This will then be accessible by appending the name of the `html` file to IP address or hostname of the computer running the Signalling Server.
 	For example, the sample `stresstest` page can be accessed on a locally-running infrastructure at `http:/127.0.0.1/stresstest.html`.
 *   You can customize the `HomepageFile` parameter for the Signaling and Web Server, and set the path to the filename of your custom HTML player page relative to the [Frontend implementations source folder](/Frontend/implementations/src). It will then be accessible when you access the IP address or hostname of the computer running the Signaling and Web Server.
 *   You can also use the **AdditionalRoutes** parameter for the Signaling and Web Server to customize the mapping between URL paths and local folders on your computer.

diff --git a/Frontend/README.md b/Frontend/README.md
@@ -5,7 +5,7 @@ The **frontend** refers to the HTML, CSS, images, and JavaScript/TypeScript code
 The frontend consists of two packages:
 
 1. [lib-pixelstreamingfrontend](/Frontend/library/): the core Pixel Streaming frontend for WebRTC, settings, input, and general functionality.
-2. [lib-pixelstreamingfrontend-ui](/Frontend/implementations/EpicGames): the reference UI that users can either optionally apply on top of the core library or build on top of.
+2. [lib-pixelstreamingfrontend-ui](/Frontend/implementations/typescript): the reference UI that users can either optionally apply on top of the core library or build on top of.
 
 
 ## Docs
@@ -29,7 +29,7 @@ The TypeScript libraries are provided as both an [NPM](https://www.npmjs.com/set
 ## Usage from source
 
 When developing your own Pixel Streaming experience the intent is you will start with this library and extend it through the use of 
-its public API. We have provided an example of this workflow in our [implementations/EpicGames](/Frontend/implementations/EpicGames), which is an implementation of this library.
+its public API. We have provided an example of this workflow in our [implementations/typescript](/Frontend/implementations/typescript), which is an implementation of this library.
 
 ## Contributing
 
@@ -53,7 +53,7 @@ This will produce `player.js` under the `SignallingWebServer/Public` directory -
 
 ### Making your own UI
 
-We recommend studying [/ui-library](/Frontend/ui-library) and [player.ts](/Frontend/implementations/EpicGames/src/player.ts)/[player.html](/Frontend/implementations/EpicGames/src/player.html), or alternatively the sample React implementation in [implementations/react](/Frontend/implementations/react), then once you have copied and modified the [package.json](/Frontend/implementations/EpicGames/package.json) and `.ts` into your own `implementation/your_implementation` directory, the process is similar:
+We recommend studying [/ui-library](/Frontend/ui-library) and [player.ts](/Frontend/implementations/typescript/src/player.ts)/[player.html](/Frontend/implementations/typescript/src/player.html), or alternatively the sample React implementation in [implementations/react](/Frontend/implementations/react), then once you have copied and modified the [package.json](/Frontend/implementations/typescript/package.json) and `.ts` into your own `implementation/your_implementation` directory, the process is similar:
 
 - `cd implementation/your_implementation`
 - `npm build-all`

diff --git a/Frontend/implementations/EpicGames/docs/configuration.md b/Frontend/implementations/EpicGames/docs/configuration.md
diff --git a/Frontend/implementations/EpicGames/docs/images/frontend.jpg b/Frontend/implementations/EpicGames/docs/images/frontend.jpg
diff --git a/Frontend/implementations/EpicGames/docs/images/images.md b/Frontend/implementations/EpicGames/docs/images/images.md
diff --git a/...plementations/EpicGames/package-lock.json → ...lementations/typescript/package-lock.json b/...plementations/EpicGames/package-lock.json → ...lementations/typescript/package-lock.json
diff --git a/...nd/implementations/EpicGames/package.json → ...d/implementations/typescript/package.json b/...nd/implementations/EpicGames/package.json → ...d/implementations/typescript/package.json
@@ -9,8 +9,8 @@
     "watch": "npx webpack --watch",
     "serve": "webpack serve --config webpack.dev.js",
     "serve-prod": "webpack serve --config webpack.prod.js",
-    "build-all": "npm link ../../library ../../ui-library && cd ../../library && npm run build && cd ../ui-library && npm run build-all && cd ../implementations/EpicGames && npm run build",
-    "build-dev-all": "npm link ../../library ../../ui-library && cd ../../library && npm run build-dev && cd ../ui-library && npm run build-dev-all && cd ../implementations/EpicGames && npm run build-dev"
+    "build-all": "npm link ../../library ../../ui-library && cd ../../library && npm run build && cd ../ui-library && npm run build-all && cd ../implementations/typescript && npm run build",
+    "build-dev-all": "npm link ../../library ../../ui-library && cd ../../library && npm run build-dev && cd ../ui-library && npm run build-dev-all && cd ../implementations/typescript && npm run build-dev"
   },
   "devDependencies": {
     "webpack-cli": "^5.0.1",

diff --git a/Frontend/implementations/EpicGames/readme.md → ...tend/implementations/typescript/readme.md b/Frontend/implementations/EpicGames/readme.md → ...tend/implementations/typescript/readme.md
@@ -4,7 +4,7 @@ A plugin library that can be optionally applied on top of the core library to cr
 
 **This is great starting point for building your UI or studying the Pixel Streaming feature set.**
 
-![Frontend](/Frontend/implementations/EpicGames/docs/images/frontend.jpg)
+![Frontend](/Frontend/implementations/typescript/docs/images/frontend.jpg)
 
 ### Key features
 - An info panel (screen right) that provides a UI for displaying live statistics to the user.

diff --git a/...ations/EpicGames/src/assets/css/login.css → ...tions/typescript/src/assets/css/login.css b/...ations/EpicGames/src/assets/css/login.css → ...tions/typescript/src/assets/css/login.css