Skip to content

Latest commit

 

History

History
142 lines (106 loc) · 12.7 KB

README.md

File metadata and controls

142 lines (106 loc) · 12.7 KB
Raw

Experimental Pixel Streaming 2 plugin release in 5.5

From UE 5.5 onwards, Epic Games introduced a layer that makes it easier to maintain WebRTC internally. As the original Pixel Streaming plugin used WebRTC directly, this change meant that we had to introduce a new plugin to ensure a better transition phase for the developers who have developed custom solutions on top of the PixelStreaming plugin. For now, both the original Pixel Streaming plugin and the Pixel Streaming 2 plugin will be shipped with Unreal Engine to give users time to migrate.

We have created a migration guide to ensure a smooth transition for all licensees using the plugin and to highlight all major changes between the plugins.

Repository helth checks and actions

Health Checks
Libraries
Platform Scripts
Signalling Protocol
Signalling Server Image
SFU Docker Image
Documentation Links
Action UE5.5 UE5.4 UE5.3
Common Lib Publish common lib Publish common lib Publish common lib
Signalling Lib Publish signalling lib
Publish Containers Publish container images
Frontend lib Publish frontend lib Publish frontend lib Publish frontend lib
Frontend ui-lib Publish ui-lib Publish ui-lib Publish ui-lib
Release Releases Releases Releases

The official home for the Pixel Streaming servers and frontend!

The frontend and web server elements for Unreal Pixel Streaming (previously located in Samples/PixelStreaming/WebServers) are now in this repository, for all to contribute to. They are referred to as the Pixel Streaming Infrastructure.

Getting Started

To build and run everything you need to connect to the Pixel Streaming plugin simply run the following in the root of your PixelStreamingInfrastructure directory:

Windows

.\SignallingWebServer\platform_scripts\cmd\start.bat

Linux or Mac

./SignallingWebServer/platform_scripts/bash/start.sh

Goals

The goals of this repository are to:

  • Increase the release cadence for the Pixel Streaming servers (to mitigate browser breaking changes sooner).
  • Encourage easier contribution of these components by Unreal Engine licensees.
  • Facilitate a more standard web release mechanism.
  • Grant a permissive license to distribute and modify this code wherever you see fit (MIT licensed).

Contributing

If you would like to contribute to our repository, please reference our contribution guide. Thank you for your time and your efforts!

Contents

The Pixel Streaming Infrastructure contains reference implementations for all the components needed to run a pixel streaming application. They are structured as separate projects, which work together, but are designed to be modular and interoperable with other implementations which use WebRTC technology. These implementations include:

  • A signalling web server, called Cirrus, found in SignallingWebServer/.
  • An SFU (Selective Forwarding Unit), found in SFU/.
  • A common library for frontend applications, found in Common/.
  • Several frontend projects for the WebRTC player and input, found in Frontend/:
  • A signalling protocol test application that validates implementations of the signalling protocol, found in SS_Test/.

Releases

We release a number of different components under this repository, specifically:

  • 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

Container images

The following container images are built from this repository:

NPM Packages

The following are unofficial NPM packages (official ones coming soon):

NPM Package 5.5 5.4 5.3
Frontend lib lib-pixelstreamingfrontend-ue5.5 lib-pixelstreamingfrontend-ue5.4 lib-pixelstreamingfrontend-ue5.3
Frontend-ui lib lib-pixelstreamingfrontend-ui-ue5.5 lib-pixelstreamingfrontend-ui-ue5.4 lib-pixelstreamingfrontend-ui-ue5.3
Signalling lib lib-pixelstreamingsignalling-ue5.5 N/A N/A

NPM getting started

#frontend (core lib)
npm i @epicgames-ps/lib-pixelstreamingfrontend-ue5.5
#frontend ui
npm i @epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5

Documentation

Tagged source releases + built typescript frontend

Github releases

Versions

We maintain versions of the servers and frontend that are compatible with existing and in-development version of Unreal Engine.

⚠️ There are breaking changes between UE versions - so make sure you get the right version. ⚠️

For a list of major changes between versions please refer to the changelog.

This repository contains the following in branches that track Unreal Engine versions:

Branch Status
Master Dev
UE5.5 Pre-release
UE5.4 Current
UE5.3 Supported
UE5.2 End of life
UE5.1 Unsupported
UE5.0 Unsupported
UE4.27 Unsupported
UE4.26 Unsupported
Legend Meaning
Dev This is our dev branch, intended to be paired with ue5-main - experimental.
Pre-release Code in here will be paired with the next UE release, we periodically update this branch from master.
Current Supported and this is the branch tracking the latest released version of UE.
Supported We will accept bugfixes/issues for this version.
End of life Once the next UE version is released we will not support this version anymore.
Unsupported We will not be supporting this version with bugfixes.

Legal

© 2004-2024, Epic Games, Inc. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.