Skip to content
This repository has been archived by the owner on Mar 1, 2024. It is now read-only.

Commit

Permalink
Upgrade 5.2 to 5.3 in libraries, docs, log messages, build pipelines (#…
Browse files Browse the repository at this point in the history
…262)

* Updated github actions to work on UE5.3 branch and reset release version to 0.0.1 for the UE5.3 branch.

* Update bug report template to include UE5.X prefix.

* Refactored frontend deps to move from 5.2 to 5.3

* Update container-images Github action to use 5.3 tag

* Bump 5.2 t 5.3 in various docs and log strings.
  • Loading branch information
lukehb authored Jun 12, 2023
1 parent 32873a4 commit 464e8a0
Show file tree
Hide file tree
Showing 36 changed files with 63 additions and 5,228 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ assignees: ''
E.g. UE 5.1.1

**Frontend Version: **
E.g. 0.3.0
E.g. UE5.3-0.3.0

**Problem component**
E.g. Signalling Server, Frontend, Pixel Streaming C++ plugin
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/container-images.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: Publish the Signalling Server container image from our dev branch
name: Publish the Signalling Server container image

on:
push:
branches: ['UE5.2']
branches: ['UE5.3']
paths: ['SignallingWebServer/**']

jobs:
Expand All @@ -23,10 +23,10 @@ jobs:
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
-
name: Build and push the Signalling Server container image for Unreal Engine based on our development branch
name: Build and push the Signalling Server container image
uses: docker/build-push-action@v3
with:
context: .
tags: 'ghcr.io/epicgames/pixel-streaming-signalling-server:5.2'
tags: 'ghcr.io/epicgames/pixel-streaming-signalling-server:5.3'
push: true
file: SignallingWebServer/Dockerfile
2 changes: 1 addition & 1 deletion .github/workflows/create-gh-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Releases

on:
push:
branches: ['UE5.2']
branches: ['UE5.3']
paths: ['RELEASE_VERSION']

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish-library-to-npm.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Publish library package to npmjs
on:
push:
branches: ['UE5.2']
branches: ['UE5.3']
paths: ['Frontend/library/package.json']
jobs:
build:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish-ui-library-to-npm.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Publish ui-library package to npmjs
on:
push:
branches: ['UE5.2']
branches: ['UE5.3']
paths: ['Frontend/ui-library/package.json']
jobs:
build:
Expand Down
4 changes: 1 addition & 3 deletions Frontend/Docs/HTML Page Requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ You have a few options for where you can place your custom HTML player page, an
* 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.

For additional details on these parameters, see also the [Pixel Streaming Reference](https://docs.unrealengine.com/5.2/en-US/unreal-engine-pixel-streaming-reference/).

### Building the Frontend
When starting the infrastructure Signalling Server, the Frontend should be built automatically. If not, you can run the [`setup script`](/SignallingWebServer/platform_scripts/) for your platform to do so. If you subsequently make any changes to your local copy of the frontend, you will need to run the script again, appending `--build` as an argument to force a rebuild.
When starting the infrastructure Signalling Server, the Frontend should be built automatically. If not, you can run the [`setup_frontend`](/SignallingWebServer/platform_scripts/) script for your platform to do so. If you subsequently make any changes to your local copy of the frontend, you will need to run the script again, appending `--build` as an argument to force a rebuild.

4 changes: 2 additions & 2 deletions Frontend/implementations/EpicGames/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Frontend/implementations/EpicGames/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@epicgames-ps/reference-pixelstreamingfrontend-ue5.2",
"name": "@epicgames-ps/reference-pixelstreamingfrontend-ue5.3",
"version": "0.0.1",
"description": "",
"main": "./src/player.ts",
Expand Down
2 changes: 1 addition & 1 deletion Frontend/implementations/EpicGames/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ A plugin library that can be optionally applied on top of the core library to cr


### Adding it to your project
`npm i @epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2`
`npm i @epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.3`
4 changes: 2 additions & 2 deletions Frontend/implementations/EpicGames/src/player.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright Epic Games, Inc. All Rights Reserved.

import { Config, PixelStreaming } from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.2';
import { Application, PixelStreamingApplicationStyle } from '@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2';
import { Config, PixelStreaming } from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.3';
import { Application, PixelStreamingApplicationStyle } from '@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.3';
const PixelStreamingApplicationStyles =
new PixelStreamingApplicationStyle();
PixelStreamingApplicationStyles.applyStyleSheet();
Expand Down
4 changes: 2 additions & 2 deletions Frontend/implementations/EpicGames/src/showcase.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright Epic Games, Inc. All Rights Reserved.

import { Config, PixelStreaming } from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.2';
import { Application, PixelStreamingApplicationStyle } from '@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2';
import { Config, PixelStreaming } from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.3';
import { Application, PixelStreamingApplicationStyle } from '@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.3';
export const PixelStreamingApplicationStyles = new PixelStreamingApplicationStyle();
PixelStreamingApplicationStyles.applyStyleSheet();

Expand Down
4 changes: 2 additions & 2 deletions Frontend/implementations/EpicGames/src/stresstest.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright Epic Games, Inc. All Rights Reserved.

import { Config, Flags, PixelStreaming } from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.2';
import { Application, PixelStreamingApplicationStyle } from '@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2';
import { Config, Flags, PixelStreaming } from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.3';
import { Application, PixelStreamingApplicationStyle } from '@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.3';
const PixelStreamingApplicationStyles =
new PixelStreamingApplicationStyle();
PixelStreamingApplicationStyles.applyStyleSheet();
Expand Down
2 changes: 1 addition & 1 deletion Frontend/implementations/EpicGames/src/uiless.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Copyright Epic Games, Inc. All Rights Reserved.

import { Config, PixelStreaming } from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.2';
import { Config, PixelStreaming } from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.3';

document.body.onload = function() {
// Example of how to set the logger level
Expand Down
4 changes: 2 additions & 2 deletions Frontend/implementations/react/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Frontend/implementations/react/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@epicgames-ps/reference-pixelstreamingfrontend-react-ue5.2",
"name": "@epicgames-ps/react-pixelstreamingfrontend-react-ue5.3",
"version": "0.0.1",
"description": "",
"main": "./src/index.tsx",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
Config,
AllSettings,
PixelStreaming
} from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.2';
} from '@epicgames-ps/lib-pixelstreamingfrontend-ue5.3';

export interface PixelStreamingWrapperProps {
initialSettings?: Partial<AllSettings>;
Expand Down
Loading

0 comments on commit 464e8a0

Please sign in to comment.