This repository has been archived by the owner on Mar 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 259
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Readme to new repo: https://github.com/EpicGamesExt/PixelStreamingInf…
…rastructure More details can be found here: https://forums.unrealengine.com/t/migrating-optional-epic-games-git-repositories-to-new-github-organization/1718666 Signed-off-by: Luke Bermingham <[email protected]>
- Loading branch information
Showing
1 changed file
with
2 additions
and
110 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,111 +1,3 @@ | ||
| | Branch | | | | | | ||
| | -------|--|--|--|--| | ||
| | UE5.4 | [](https://github.com/EpicGames/PixelStreamingInfrastructure/actions/workflows/publish-library-to-npm.yml) | [](https://github.com/EpicGames/PixelStreamingInfrastructure/actions/workflows/publish-ui-library-to-npm.yml) | [](https://github.com/EpicGames/PixelStreamingInfrastructure/actions/workflows/container-images.yml) | [](https://github.com/EpicGames/PixelStreamingInfrastructure/actions/workflows/create-gh-release.yml) | | ||
| | UE5.3 | [](https://github.com/EpicGames/PixelStreamingInfrastructure/actions/workflows/publish-library-to-npm.yml) | [](https://github.com/EpicGames/PixelStreamingInfrastructure/actions/workflows/publish-ui-library-to-npm.yml) | [](https://github.com/EpicGames/PixelStreamingInfrastructure/actions/workflows/container-images.yml) | [](https://github.com/EpicGames/PixelStreamingInfrastructure/actions/workflows/create-gh-release.yml) | | ||
| | Master | [](https://github.com/EpicGames/PixelStreamingInfrastructure/actions/workflows/run-library-unit-tests.yml) | | ||
|
|
||
| # 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**. | ||
| # PixelStreamingInfrastructure has moved [here!](https://github.com/EpicGamesExt/PixelStreamingInfrastructure) | ||
|
|
||
| ## 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](CONTRIBUTING.md). 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/`](SignallingWebServer/). | ||
| - An SFU (Selective Forwarding Unit), found in [`SFU/`](SFU/). | ||
| - A matchmaker, found in [`Matchmaker/`](Matchmaker/). | ||
| - Several frontend projects for the WebRTC player and input, found in [`Frontend/`](Frontend/): | ||
| - shared libraries for [communication](Frontend/library/) and [UI](Frontend/ui-library/) functionality | ||
| - separate [implementations](Frontend/implementations/) using different technologies such as TypeScript or React/JSX | ||
|
|
||
| For detailed information, see the [/frontend](/Frontend/). | ||
|
|
||
| ## 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: | ||
|
|
||
| - [ghcr.io/epicgames/pixel-streaming-signalling-server](https://github.com/orgs/EpicGames/packages/container/package/pixel-streaming-signalling-server) (since Unreal Engine 5.1) | ||
| ( This link requires you to join Epic's Github org ) | ||
| - [ghcr.io/epicgames/pixel-streaming-sfu](https://github.com/orgs/EpicGames/packages/container/package/pixel-streaming-sfu) (since Unreal Engine 5.4) | ||
| ( This link requires you to join Epic's Github org ) | ||
|
|
||
| ### NPM Packages | ||
| The following are `unofficial` NPM packages (official ones coming soon): | ||
|
|
||
| | Branch | Frontend library | Frontend reference ui | | ||
| |--------|------------------|-----------------------| | ||
| | UE5.3 |[lib-pixelstreamingfrontend-ue5.3](https://www.npmjs.com/package/@epicgames-ps/lib-pixelstreamingfrontend-ue5.3)|[lib-pixelstreamingfrontend-ui-ue5.3](https://www.npmjs.com/package/@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.3)| | ||
| | UE5.4 |[lib-pixelstreamingfrontend-ue5.4](https://www.npmjs.com/package/@epicgames-ps/lib-pixelstreamingfrontend-ue5.4)|[lib-pixelstreamingfrontend-ui-ue5.4](https://www.npmjs.com/package/@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.4)| | ||
|
|
||
| ### NPM getting started | ||
|
|
||
| ```bash | ||
| #frontend (core lib) | ||
| npm i @epicgames-ps/lib-pixelstreamingfrontend-ue5.3 | ||
| #frontend ui | ||
| npm i @epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.3 | ||
| ``` | ||
|
|
||
| ## Documentation | ||
| * [General Docs](/Docs/README.md) | ||
| * [Frontend Docs](/Frontend/README.md) | ||
| * [Signalling Server Docs](/SignallingWebServer/README.md) | ||
| * [Matchmaker Docs](/Matchmaker/README.md) | ||
| * [SFU Docs](/SFU/README.md) | ||
|
|
||
| ### Tagged source releases + built typescript frontend | ||
|
|
||
| [Github releases](https://github.com/EpicGames/PixelStreamingInfrastructure/releases) | ||
|
|
||
| ## 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: | ||
|
|
||
| <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: | ||
|
|
||
| | Branch | Status | | ||
| |--------|--------| | ||
| |[Master](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/master)| Dev | | ||
| |[UE5.5](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE5.5)| Pre-release | | ||
| |[UE5.4](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE5.4)| Pre-release | | ||
| |[UE5.3](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE5.3)| Current | | ||
| |[UE5.2](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE5.2)| Supported | | ||
| |[UE5.1](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE5.1)| End of life | | ||
| |[UE5.0](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE5.0)| Unsupported | | ||
| |[UE4.27](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE4.27)| Unsupported | | ||
| |[UE4.26](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/UE4.26)| Unsupported | | ||
|
|
||
| | Legend | Meaning | | ||
| |---------|-----------| | ||
| | 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`. | | ||
| | 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. | ||
| For more details read [here](https://forums.unrealengine.com/t/migrating-optional-epic-games-git-repositories-to-new-github-organization/1718666). |