Skip to content
This repository has been archived by the owner on Mar 1, 2024. It is now read-only.

Latest commit

 

History

History
205 lines (180 loc) · 23.2 KB

CHANGELOG.md

File metadata and controls

205 lines (180 loc) · 23.2 KB
Raw

Pixel Streaming Infrastructure Changelog

The changelog is a summary of commits between releases of Unreal Engine.

As a reminder each UE-X branch/tag in this repository corresponds to a version of Unreal Engine.

UE 5.3 (Current)

Features

  • Protocol structures can now contain strings by @Belchy06 in #336
  • Added the ability for the frontend peer to auto connect when a new streamer is available by @mcottontensor in #358

Enhancements

  • Upgrade 5.2 to 5.3 in libraries, docs, log messages, build pipelines by @lukehb in #262
  • Include create, reconnect, and update events (with associated tests) by @jibranabsarulislam in #273
  • Add github action for PR and Issue management by @Belchy06 in #304
  • Update stale.yml by @Belchy06 in #305
  • Update stale workflow to also auto close stale issues and PRs by @Belchy06 in #306
  • Show player count in stats panel by @Belchy06 in #303
  • Change implementations/EpicGames to implementations/typescript #166 by @gunsha in #177
  • Refactor SignallingWebServer to a single docker file by @Belchy06 in #337
  • Update LatencyTest handler to accept input data by @Belchy06 in #340
  • Add contribution guideline CONTRIBUTING.md by @DenisTensorWorks in #352
  • New matchmaker queue screen with easy customization by @kasp1 in #211
  • Updated CONTRIBUTING.md with backport rules by @Belchy06 in #357

Documentation

  • Signaling message reference doc by @mcottontensor in #271
  • Update SignallingProtocol.md by @mcottontensor in #288

Bug fixes

  • Fixed auto reconnect to not reconnect when the page is refreshed. by @mcottontensor in #285
  • Fixed iOS touch when settings panel is open by @Belchy06 in #274
  • Fixed Firefox console errors TypeError: this.preferredCodec.split is not a function by @Belchy06 in #310
  • Fixed ensuring touch is relative to absolute location of parent rect by @StomyPX in #316
  • Fixed injecting new params into SDP to get stereo back on Chrome by @StomyPX in #332
  • Fixed matchmaker asking for OS authentication instead of erroring out with EACCESS by @StomyPX in #333
  • Fixed consuming the context menu event instead of sending a mouse up by @StomyPX in #354

Security

  • Bump tough-cookie from 4.1.2 to 4.1.3 in /Frontend/library by @dependabot in #290
  • Bump word-wrap from 1.2.3 to 1.2.4 in /Frontend/library by @dependabot in #320
  • Bump word-wrap from 1.2.3 to 1.2.5 in /Frontend/ui-library by @dependabot in #327
  • Bump Node.js to latest LTS by @StomyPX in #321

UE 5.2

Features

  • Added minimal sample React implementation by @hmuurine in #159
  • Added a new frontend for the Pixel Streaming Demo showcase project by @lukehb in #158
  • Added multiple streamer support by @mcottontensor in #74
  • Added DefaultToHover being parsed as a config option in InitialSettings message by @StomyPX in #68
  • Added indication to the signalling server when the browser intends to send the offer by @Belchy06 in #75
  • Added experimental support for WebXR based experiences by @Belchy06 in #85

Docs

  • New general docs page/ToC + new security page. by @MWillWallT in #254
  • Update README to mention container images require being part of Epic's Github org by @mcottontensor in #248
  • Update platform_scripts readme.md to explain the different scripts by @lukehb in #224
  • Improve signalling Server readme @DenisTensorWorks in #223
  • Adding microphone feature documentation for UE5.2 by @DenisTensorWorks in #228
  • Adding microphone feature documentation by @DenisTensorWorks in #208
  • Added new general docs page/ToC + new security page. by @MWillWallT in #254
  • Settings Panel Documentation by @MWillWallT in #135
  • Customised Pixel Streaming Player Page by @MWillWallT in #90
  • Updated Signalling Server docs by @DenisTensorWorks in #223
  • Updated docs for frontend for settings and TURN by @lukehb in #224
  • Adding docs for microphone feature by @DenisTensorWorks in #228
  • Updated README to mention container images require being part of Epic's Github org by @mcottontensor in #248
  • Updated the Frontend Docs to move some material from UE docs official to this repo by @StomyPX in #152
  • Update Docs to remove broken links by @Belchy06 in #122

Enhancements

  • Add repository health status in the form of Github badges table on readme.md by @lukehb in #265
  • Re-enable iOS and iPadOS fullscreen by @Belchy06 in #266
  • Changed forwarded logs to Cyan, added warning for missing playerId by @StomyPX in #253
  • Added "media-playout" to prevent spam in Aggregated Stats by @chasse20 in #232
  • Added 'stat PixelStreamingGraphs' to showcase frontend #229 by @devrajgadhvi in #238
  • Bump socket.io-parser from 4.2.2 to 4.2.4 in /Matchmaker by @dependabot in #244
  • Bump engine.io from 6.4.0 to 6.4.2 in /Matchmaker by @mcottontensor in #220
  • Allow inheritance of webrtcPlayerController and webXrController by @Belchy06 in #209
  • Pass command line args when calling run_local.bat by @lukehb in #109
  • Customize frontend styles through UI API by @hmuurine in #133
  • Force URL param settings when receiving initial application settings by @Belchy06 in #134
  • Added ability to pass HTTPS certificate locations via Cirrus configuration by @marcinbiegun in #149
  • Added unit tests for library by @hmuurine in #156
  • Converted frontend javascript to typescript and refactor. by @lukehb in #63
  • Removed useless code, make code style more consistent by @Senseme in #59
  • Multi-streamer QOL improvements by @Belchy06 in #88
  • Removing the player id from forwarded messages by @mcottontensor in #91
  • Added a QOL message when multiple streamers are detected by @Belchy06 in #94
  • Added dev and prod configs to webpack by @lukehb in #102
  • Added github actions to create an NPM package for frontend library and make a release for the repo by @lukehb in #103
  • Neaten up install scripts by @Belchy06 in #106
  • Added 'stat PixelStreamingGraphs' to showcase frontend #229 by @devrajgadhvi in #238
  • Changed forwarded logs to Cyan, added warning for missing playerId by @StomyPX in #253
  • Allow inheritance of webrtcPlayerController and webXrController by @Belchy06 in #209
  • Alter reconnection flow to request streamer message list and fail out after N attempts. by @Belchy06 in #195
  • Added exports for UI configuration types by @kass-kass in #193
  • Added ability to optionally disable certain frontend elements by @kass-kass in #161
  • Added support for programmatically changing peer layers when using the SFU by @Belchy06 in #179
  • Improved frontend API support for UE communication by @hmuurine in #132
  • Added ability in frontend to Enable/disable user input devices by @hmuurine in #136
  • Exposed websocketController and webXRController to public API by @lukehb in #124
  • Added XR events: xrSessionStarted, xrSessionEnded, xrFrame by @lukehb in #125
  • Decouple UI from the frontend library by @hmuurine in #110
  • Replaced hardcoded log path with given parameter path by @Mirmidion in #39

Bug fixes

  • Fixed viewport resizing not always working due to improperly calling timer. by @mcottontensor in #247
  • Fixed hovering mouse mode set in URL being overridden on refresh. by @mcottontensor in #246
  • Fixed matchmaker directing users to http when the signalling server is using https by @mcottontensor in #245
  • Fixed reconnects will be attempted even when a disconnect is triggered by afk timeout by @Belchy06 in #215
  • Fixed datachannels not working when using the SFU by @mcottontensor in #137
  • Fixed SFU having clashing datachannel/stream ids, now using mediasoup's internal stream ids for SCTP by @StomyPX in #129
  • Fixed controller indices from multiple peers would clash by @Belchy06 in #165
  • Fixed Connecting to Unreal 5.1 app with the 5.2 frontend crashes on connect by @Belchy06 in #180
  • Fixed sfu player would try subscribing when sfu disconnected by @Belchy06 in #172
  • Fixed bug where stress tester would leave orphaned Pixel Streaming connections by @lukehb in #185
  • Fixed bug where reconnects were being attempted even when a disconnect is triggered by afk timeout by @Belchy06 in #215
  • Fixed viewport resizing not always working due to improperly calling timer. by @mcottontensor in #247
  • Fixed log spam caused by missing "media-playout" in Aggregated Stats by @chasse20 in #232
  • Fixed hovering mouse mode set in URL being overridden on refresh. by @mcottontensor in #246
  • Fixed matchmaker directing users to http when the signalling server is using https by @mcottontensor in #245
  • Fixed frontend library not building on Linux due to incorrect casing by @StomyPX in #96
  • Fixed SFU peer datachannels aren't being created by @Belchy06 in #95 and #97
  • Fixed crash on browsers where the xr object wasn't on the navigator by @Belchy06 in #93
  • Fixed Preferred codec selector causes no stream if application launched without -PixelStreamingNegotiateCodecs by @Belchy06 in #83
  • Fixed adding the rest of the browsers supported codecs after setting the preferred codec (#83) by @lukehb in #84
  • Fixed delayed mic input by @Belchy06 in #77 and @lukehb in #78
  • Fixed syntax error by @mcianni in #44
  • Fixed check if KeyboardEvent.keyCode deprecated then use KeyboardEvent.code + mapping instead. by @lukehb in #48
  • Fixed bug when negating property in and removing duplicate property by @lukehb in #49
  • Fixed incorrect login page path when using authentication by @Belchy06 in #55
  • Fixed handling of "defaultToHover" field in offer by @StomyPX in #60
  • Fixed Pixel Streaming session disconnecting entirely when using the new frontend by @hmuurine in #141
  • Fixed input would not entirely unregister when using the new frontend by @lukehb in #144
  • Fixed frontend not working with older NodeJS versions due ts-jest and jest by @hmuurine in #168
  • Fixed webpack was double bundling frontend lib into the final bundle (#117) by @lukehb in #118 @hmuurine in #117
  • Fixed cirrus Dockerfile that resulting in a non-functional signalling server by @Belchy06 in #123

Security

  • Various security updates by @mcottontensor in #220
  • Security updates for default turn server configuration. by @gingernaz in #196
  • Bumped qs and express in /SignallingWebServer by @dependabot in #69
  • Bumped qs and express in /Matchmaker by @dependabot in #70
  • Bumped passport from 0.4.1 to 0.6.0 in /SignallingWebServer by @dependabot in #71
  • Bumped engine.io and socket.io in /Matchmaker by @dependabot in #72
  • Bumped socket.io-parser from 4.2.2 to 4.2.4 in /Matchmaker by @dependabot in #244
  • Patched Uncaught exception in PixelStreamingInfrastructure via engine by @imhunterand in #61
  • Fixed insufficient validation when decoding a Socket packet by @iot-defcon in #57
  • @ CVE-2022-25896 by @mik-patient in #35
  • Bump webpack from 5.75.0 to 5.76.0 in /Frontend/library by @dependabot in #153
  • Bump webpack from 5.75.0 to 5.76.0 in /Frontend/ui-library by @dependabot in #155
  • Bump webpack from 5.75.0 to 5.76.0 in /Frontend/implementations/EpicGames by @dependabot in #154
  • Fixing security warnings. by @mcottontensor in #163
  • Moved all package.json under @epicgames-ps scope to avoid package confusion by @lukehb in #187

UE 5.1

Bug fixes

  • 3b1b84 Fix black screen flickering when receiving freeze frames.
  • 853625 Fix CSS to show AFK overlay.
  • c897e1 Fix pointerlock errors on platforms like iOS where it doesn't exist.

Features

  • 980208 Add handling for mouse double click.
  • 6b8f31 Expose freeze frame delay as a configurable option.
  • fe5c4c Added Dockerfile for the 5.1 Signalling Server container.

UE 5.0

Bug fixes

  • 3d641a Fixed MatchViewportWidth not working if toggled repeatedly.
  • ca6644 Fix controller button messages not being sent.
  • bb4063 Fix missing let in loops.
  • b59bfb Fix removeResponseEventListener using remove instead of delete.
  • 4fee8a Fix missing initialization for unquantizeAndDenormalizeUnsigned.
  • 42fa91 Move to standardized onwheel browser event.

Features

  • b23cba Added a MaxPlayerCount configuration option to the signalling server to restrict participant numbers (default -1: no upper limit).
  • e46c4d Added support for handling websocket messages sent as binary.
  • 616f07 Added offerToReceive toggle/flag to indicate browser should/or should not make the SDP offer.
  • 845ab1 Added ability to send handle a "input protocol", which is a protocol specification for data channel messages sent by the UE side. This allows the frontend need no extra handling to support custom data channel messages (of course the user must still bind a handler if they wish to do anything with the message).
  • 1c1fe0 Added ability to request keyframes on the frontend.

UE 4.27 (End of life)

Backported 5.0 frontend to support 4.27:

  • Removed SFU support as this is not supported in 4.27.
  • Ignore playerConnected message as not supported in 4.27.
  • Force frontend to generate the WebRTC offer as 4.27 expects this.

UE 4.26 (Unsupported)

Backported 5.0 frontend to support 4.26:

  • Removed SFU support as this is not supported in 4.26.
  • Ignore playerConnected message as not supported in 4.26.
  • Force frontend to generate the WebRTC offer as 4.26 expects this.
  • Remove Linux scripts as Linux Pixel Streaming was not supported in 4.26.
  • Force the removal of extmap-allow-mixed from the SDP as WebRTC version UE used in 4.26 did not support it.

Previous versions

Versions prior to UE 4.26 are not tracked here as this repository has never supported those versions.