The official home for the Pixel Streaming servers and frontend!

The Pixel Streaming servers and web frontend that was in Samples/PixelStreaming/WebServers is now here for all to contribute to.

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).

Repository contents

Reference implementations for the various pieces needed to support a PixelStreaming application:

• SignallingWebServer (Cirrus)
• SFU (Selective Forwarding Unit)
• Matchmaker
• Frontend (the JS/TS frontend library for the WebRTC player and input)

Releases

We release a number of different things under this repository, currently they are:

• 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:

• ghcr.io/epicgames/pixel-streaming-signalling-server (since Unreal Engine 5.1)

NPM Packages

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

Branch	Frontend library	Frontend reference ui
UE5.2	lib-pixelstreamingfrontend-ue5.2	lib-pixelstreamingfrontend-ui-ue5.2

NPM getting started

# Add Github packages repo to your NPM for @epicgames
npm config set @epicgames:registry https://npm.pkg.github.com/
# Install the frontend (core lib)
npm install @epicgames/libpixelstreamingfrontend
# Install the TypeScript frontend ui
npm install @epicgames/libpixelstreamingfrontend-ui

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.2	Pre-release
UE5.1	Current
UE5.0	Supported
UE4.27	End of life
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 versions with bugfixes.

Legal

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