2023-02-07 09:44:59 +08:00
# 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 the contribute to.
2022-06-15 10:54:37 +08:00
2022-07-07 08:52:27 +08:00
## Goals
2022-06-15 10:54:37 +08:00
2022-07-07 08:52:27 +08:00
The goals of this repository are to:
2022-07-07 08:55:16 +08:00
- 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 (e.g. NPM packages or similar... coming soon).
- Grant a permissive license to distribute and modify this code wherever you see fit (MIT licensed).
2022-07-07 08:52:27 +08:00
## Repository contents
2022-07-07 08:56:16 +08:00
Reference implementations for the various pieces needed to support a PixelStreaming application:
2022-07-07 08:52:27 +08:00
- SignallingWebServer (Cirrus)
2022-08-09 09:42:37 +08:00
- SFU (Selective Forwarding Unit)
2022-07-07 08:52:27 +08:00
- Matchmaker
2023-02-07 09:34:44 +08:00
- Frontend (the javascript frontend library for the WebRTC player and input)
2022-07-07 08:52:27 +08:00
2022-11-17 15:13:11 +08:00
## Container images
The following container images are built from this repository:
- [ghcr.io/epicgames/pixel-streaming-signalling-server ](https://github.com/orgs/EpicGames/packages/container/package/pixel-streaming-signalling-server ) (since Unreal Engine 5.1)
2022-10-05 07:49:01 +08:00
## Versions
We maintain versions of the servers and frontend that are compatible with existing and in-development version of Unreal Engine.
:warning: **There are breaking changes between UE versions - so make sure you get the right version** . :warning:
2023-02-06 15:45:36 +08:00
< ins > For a list of major changes between versions please refer to the [changelog ](https://github.com/EpicGames/PixelStreamingInfrastructure/blob/master/CHANGELOG.md ).</ ins >
This repository contains the following in branches that track Unreal Engine versions:
2022-10-05 07:49:01 +08:00
2023-02-06 15:57:33 +08:00
| Branch | Status |
|--------|--------|
|[Master](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/master)| Dev |
2023-02-08 14:37:31 +08:00
|[UE5.2](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE5.2)| Pre-release |
2023-02-06 15:57:33 +08:00
|[UE5.1](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE5.1)| Current |
|[UE5.0](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE5.0)| Supported |
|[UE4.27](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE4.27)| End of life |
|[UE4.26](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE4.26)| Unsupported |
| Legend | Meaning |
|---------|-----------|
2023-02-08 14:37:31 +08:00
| Dev | This is our dev branch, intended to be paired with [ue5-main ](https://github.com/EpicGames/UnrealEngine/tree/ue5-main ) - experimental. |
|Pre-release| Code in here will be paired with the next UE release, we periodically update this branch from `master` . |
2023-02-06 15:57:33 +08:00
| 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. |
2022-07-07 08:52:27 +08:00
## Legal
2023-02-07 09:45:53 +08:00
© 2004-2023, Epic Games, Inc. Unreal and its logo are Epic’
