Pixel Streaming Infrastructure

The Pixel Streaming Infrastructure contains the servers and frontend components of the Pixel Streaming plugin. It contains the scripts needed to run Pixel Streaming (the Signalling Server, Matchmaker and SFU) and is designed to be both easy to access and modify. Additionally, it contains the foundation that developers can modify and extend to suit the needs of their Pixel Streaming experience. Previously, these scripts were found in the Samples/PixelStreaming directory of your project and engine. If you want to continue using Pixel Streaming moving forward, we recommended using the new infrastructure as all the latest frontend updates to Pixel Streaming will be made there.

Why?

We moved the Pixel Streaming frontend to its own repository for a number of reasons:

1. To improve the release cadence of Pixel Streaming. With the infrastructure existing in its own repository, it is not bound to updates to Unreal Engine.

2. Encourage and allow easier contribution from Unreal Engine licensees and users.

Acquiring the Infrastructure

There are 3 different ways to acquire the Pixel Streaming infrastructure. The methods below are the most commonly used and should cover most use cases.

Download the ZIP

You can directly download the infrastructure in ZIP format by heading to: https://github.com/EpicGames/PixelStreamingInfrastructure. Navigate to the branch of the infrastructure you need and press the green code button. You should see the option to download ZIP.

Use Git Command

If you have Git installed locally, you can acquire the infrastructure using the command line, for example:

git clone --branch UE5.1 https://github.com/EpicGames/PixelStreamingInfrastructure.git in your preferred terminal (make sure you have git installed).

The git command mentioned above will pull the 5.1 branch of the infrastructure. If you need a different branch, please modify the git command accordingly.

Use the Provided Scripts

With the Pixel Streaming plugin enabled, you will find scripts to automatically pull the required branch of the infrastructure.

Navigate to \Engine\Plugins\Media\PixelStreaming\Resources\WebServers and run the get_ps_servers command (make sure to use the .bat script for Windows and .sh script for Linux accordingly). This will automatically pull the relevant branch of the Pixel Streaming infrastructure into that folder.

This method is recommended because the downloaded infrastructure will be automatically packaged with your Pixel Streaming enabled project. If you don't use this method, you can still ensure the infrastructure packages with your project by manually placing the infrastructure in the above location.

Infrastructure Layout

After pulling the infrastructure through one of the methods above, you'll end up with a local file setup as shown below. You can browse the infrastructure directly on GitHub as well.

The Pixel Streaming component locations are as follows:

1. Frontend: This directory contains the HTML, CSS, images, and JavaScript / TypeScript code that runs in web browsers and allows them to connect to Unreal Engine Pixel Streaming applications and interact with them, as well as documentation on how to implement these interactions.

   

2. Matchmaker: This directory contains all the scripts required to configure and run the Matchmaker.

   

3. SFU: This directory contains everything needed to configure and run the Selective Forwarding Unit.

   

4. SignallingWebServer: This is the directory for your mandatory Pixel Streaming elements, such as the Signalling Server, Web Server and frontend.

   

The platform_scripts directory is the go to location for all the scripts used to start each Pixel Streaming element. You will find scripts for Windows and Linux in cmd and bash respectively.

For information about using the Matchmaker and the Selective Forwarding Unit, refer to the Hosting and Networking Guide.

For help setting up a basic Pixel Stream, refer to Getting Started with Pixel Streaming.

For guidance on customising the frontend, refer to the Frontend/Docs/ directory.

Engine Versions

There are different branches of the Pixel Streaming Infrastructure for each different version of the engine. As the Pixel Streaming plugin has variances between each version of the engine, it's vital that you use the compatible version of the Pixel Streaming infrastructure (e.g. branch 5.0 for Unreal Engine 5.0) There is also a master branch available that is used for our active development. This will have the latest features, but is also experimental and is not guaranteed to be stable.

Refer to the versions section of the frontend repo for the list of Unreal Engine versions that are currently supported: