unreal engine 5.1 update, level load fixed

2023-02-10 15:24:22 +05:00
parent e9f3169a6f
commit 32440ee90f
116 changed files with 10393 additions and 33 deletions
@@ -0,0 +1,13 @@
+How to use files in this directory:
+- Files with .ps1 extension can be run with PowerShell[.exe] in Windows.  Powershell needs to be started as Administrator to run setup.ps1 so it can run installation / installation check steps
+- Make sure that all of your dependencies are installed.  Use .\setup.ps1 what will install whatever is missing as long as you are on a supported operating system
+
+- Run a local instance of the Cirrus server by using the .\run_local.ps1 script
+
+- Use the following scripts to run locally or in your cloud instance:
+ - Start_SignallingServer.ps1 - Start only the Signalling (STUN) server
+ - Start_TURNServer.ps1 - Start only the TURN server
+ - Start_WithTURN_SignallingServer.ps1 - Start a TURN server and the Cirrus server together
+- The Start_Common.ps1 file contains shared functions for other Start_*.ps1 scripts and it is not supposed to run alone
+
+- The local/cloud Start_*.ps1 powershell scripts can be invoked with the  --help  command line option to see how those can be configured.  The following options can be supplied: --publicip, --turn, --stun.  Please read the --help
@@ -0,0 +1,89 @@
+# Copyright Epic Games, Inc. All Rights Reserved.
+
+# Parse $args into a string
+$params = $args[0]
+if ( $args.Count -gt 1 ) {
+  $params = $args[1..$($args.Count - 1)]
+  # Do setup as a common task, it is smart and will not reinstall if not required.
+  Start-Process -FilePath "$PSScriptRoot\setup.bat" -Wait -NoNewWindow -ArgumentList $params
+}
+else {
+  Start-Process -FilePath "$PSScriptRoot\setup.bat" -Wait -NoNewWindow
+}
+echo $params
+
+$global:ScriptName = $MyInvocation.MyCommand.Name
+$global:PublicIP = $null
+$global:StunServer = $null
+$global:TurnServer = $null
+$global:CirrusCmd = $null
+$global:BuildFrontend = $null
+
+function print_usage {
+ echo "
+ Usage (in MS Windows Power Shell):
+  $global:ScriptName [--help] [--publicip <IP Address>] [--turn <turn server>] [--stun <stun server>] [cirrus options...]
+ Where:
+  --help will print this message and stop this script.
+  --publicip is used to define public ip address (using default port) for turn server, syntax: --publicip ; it is used for 
+    default value: Retrieved from 'curl https://api.ipify.org' or if unsuccessful then set to  127.0.0.1.  It is the IP address of the Cirrus server and the default IP address of the TURN server
+  --turn defines what TURN server to be used, syntax: --turn 127.0.0.1:19303
+    default value: as above, IP address downloaded from https://api.ipify.org; in case if download failure it is set to 127.0.0.1
+  --stun defined what STUN server to be used, syntax: --stun stun.l.google.com:19302
+    default value as above
+  Other options: stored and passed to the Cirrus server.  All parameters printed once the script values are set.
+  Command line options might be omitted to run with defaults and it is a good practice to omit specific ones when just starting the TURN or the STUN server alone, not the whole set of scripts.
+ "
+ exit 1
+}
+
+function print_parameters {
+ echo ""
+ echo "$scriptname is running with the following parameters:"
+ echo "--------------------------------------"
+ if ($global:StunServer -ne $null) { echo "STUN server       : $global:StunServer" }
+ if ($global:TurnServer -ne $null) { echo "TURN server       : $global:TurnServer" }
+ echo "Public IP address : $global:PublicIP"
+ echo "Cirrus server command line arguments: $global:CirrusCmd"
+ echo ""
+}
+
+function set_start_default_values($SetTurnServerVar, $SetStunServerVar) {
+ # publicip and cirruscmd are always needed
+ $global:PublicIP = Invoke-WebRequest -Uri "https://api.ipify.org" -UseBasicParsing
+ if ($global:PublicIP -eq $null -Or $global:PublicIP.length -eq 0) {
+  $global:PublicIP = "127.0.0.1"
+ } else {
+    $global:PublicIP = ($global:PublicIP).Content
+ }
+ $global:cirruscmd = ""
+
+ if ($SetTurnServerVar -eq "y") {
+  $global:TurnServer = $global:PublicIP + ":19303"
+ }
+ if ($SetStunServerVar -eq "y") {
+  $global:StunServer = "stun.l.google.com:19302"
+ }
+}
+
+function use_args($arg) {
+ $CmdArgs = $arg -split (" ")
+ while($CmdArgs.count -gt 0) {
+  $Cmd, $CmdArgs = $CmdArgs
+  if ($Cmd -eq "--stun") {
+   $global:StunServer, $CmdArgs = $CmdArgs
+  } elseif ($Cmd -eq "--turn") {
+   $global:TurnServer, $CmdArgs = $CmdArgs
+  } elseif ($Cmd -eq "--publicip") {
+   $global:PublicIP, $CmdArgs = $CmdArgs
+   $global:TurnServer = $global:publicip + ":19303"
+  } elseif ($Cmd -eq "--build") {
+   $global:BuildFrontend, $CmdArgs = $CmdArgs
+  } elseif ($Cmd -eq "--help") {
+   print_usage
+  } else {
+   echo "Unknown command, adding to cirrus command line: $Cmd"
+   $global:CirrusCmd += " $Cmd"
+  }
+ }
+}
@@ -0,0 +1,19 @@
+# Copyright Epic Games, Inc. All Rights Reserved.
+
+. "$PSScriptRoot\Start_Common.ps1" $args
+
+set_start_default_values "n" "y" # Set both TURN and STUN server defaults
+use_args($args)
+print_parameters
+
+$peerConnectionOptions = "{ \""iceServers\"": [{\""urls\"": [\""stun:" + $global:StunServer + "\""]}] }"
+
+$ProcessExe = "platform_scripts\cmd\node\node.exe"
+$Arguments = @("cirrus", "--peerConnectionOptions=""$peerConnectionOptions""", "--PublicIp=$global:PublicIp")
+# Add arguments passed to script to Arguments for executable
+$Arguments += $global:CirrusCmd
+
+Push-Location $PSScriptRoot\..\..\
+Write-Output "Running: $ProcessExe $Arguments"
+Start-Process -FilePath $ProcessExe -ArgumentList "$Arguments" -Wait -NoNewWindow
+Pop-Location
@@ -0,0 +1,38 @@
+# Copyright Epic Games, Inc. All Rights Reserved.
+
+. "$PSScriptRoot\Start_Common.ps1" $args
+
+set_start_default_values "y" "n" # Set both TURN and STUN server defaults
+use_args($args)
+print_parameters
+#$LocalIp = Invoke-WebRequest -Uri "http://169.254.169.254/latest/meta-data/local-ipv4"
+$LocalIP = (Test-Connection -ComputerName (hostname) -Count 1  | Select IPV4Address).IPV4Address.IPAddressToString
+
+Write-Output "Private IP: $LocalIp"
+
+$TurnPort="19303"
+$Pos = $global:TurnServer.LastIndexOf(":")
+if ($Pos -ne -1) {
+ $TurnPort = $global:TurnServer.Substring($Pos+ 1)
+}
+echo "TURN port: ${turnport}"
+echo ""
+
+Push-Location $PSScriptRoot
+
+$TurnUsername = "PixelStreamingUser"
+$TurnPassword = "AnotherTURNintheroad"
+$Realm = "PixelStreaming"
+$ProcessExe = ".\turnserver.exe"
+$Arguments = "-p $TurnPort -r $Realm -X $PublicIP -E $LocalIP -L $LocalIP --no-cli --no-tls --no-dtls --pidfile `"C:\coturn.pid`" -f -a -v -n -u $TurnUsername`:$TurnPassword"
+
+# Add arguments passed to script to Arguments for executable
+$Arguments += $args
+
+Push-Location $PSScriptRoot\coturn\
+Write-Output "Running: $ProcessExe $Arguments"
+# pause
+Start-Process -FilePath $ProcessExe -ArgumentList $Arguments -NoNewWindow
+Pop-Location
+
+Pop-Location
@@ -0,0 +1,25 @@
+# Copyright Epic Games, Inc. All Rights Reserved.
+
+. "$PSScriptRoot\Start_Common.ps1" $args
+
+set_start_default_values "y" "y" # Set both TURN and STUN server defaults
+use_args($args)
+print_parameters
+
+Push-Location $PSScriptRoot
+
+Start-Process -FilePath "PowerShell" -ArgumentList ".\Start_TURNServer.ps1" -WorkingDirectory "$PSScriptRoot"
+
+$peerConnectionOptions = "{ \""iceServers\"": [{\""urls\"": [\""stun:" + $global:StunServer + "\"",\""turn:" + $global:TurnServer + "\""], \""username\"": \""PixelStreamingUser\"", \""credential\"": \""AnotherTURNintheroad\""}] }"
+
+$ProcessExe = "platform_scripts\cmd\node\node.exe"
+$Arguments = @("cirrus", "--peerConnectionOptions=""$peerConnectionOptions""", "--PublicIp=$global:PublicIp")
+# Add arguments passed to script to Arguments for executable
+$Arguments += $args
+
+Push-Location $PSScriptRoot\..\..\
+Write-Output "Running: $ProcessExe $Arguments"
+Start-Process -FilePath $ProcessExe -ArgumentList $Arguments -Wait -NoNewWindow
+Pop-Location
+
+Pop-Location
@@ -0,0 +1,39 @@
+@Rem Copyright Epic Games, Inc. All Rights Reserved.
+
+@echo off
+
+@Rem Set script directory as working directory.
+pushd "%~dp0"
+
+title Building Cirrus.exe
+
+@Rem Run setup to ensure we have node and cirrus installed.
+call setup.bat %*
+
+@Rem Look for a `nexe` directory next to this script
+if exist nexe\ (
+  echo nexe directory found...skipping install.
+) else (
+  echo nexe directory not found...beginning nexe install.
+
+  @Rem Make `nexe directory`
+  mkdir nexe
+
+  @Rem npm init and install nexe
+  pushd nexe
+  call ..\node\npm init -y
+  call ..\node\npm install nexe --save
+  popd
+)
+
+@Rem Move to cirrus directory.
+pushd ..\..
+
+@Rem Build cirrus.exe using `nexe` using node 14.5.0 (as that is one of the latest prebuilts node versions in the nexe repo)
+call platform_scripts\cmd\node\npx nexe cirrus.js --target "x64-14.15.3" -r "Public/*" -r "scripts/*" -r "images/*" -r "config.json"
+
+@Rem Pop cirrus directory.
+popd ..\..
+
+@Rem Pop working directory
+popd
@@ -0,0 +1,66 @@
+::
+:: RefreshEnv.cmd
+::
+:: Batch file to read environment variables from registry and
+:: set session variables to these values.
+::
+:: With this batch file, there should be no need to reload command
+:: environment every time you want environment changes to propagate
+
+::echo "RefreshEnv.cmd only works from cmd.exe, please install the Chocolatey Profile to take advantage of refreshenv from PowerShell"
+echo | set /p dummy="Refreshing environment variables from registry for cmd.exe. Please wait..."
+
+goto main
+
+:: Set one environment variable from registry key
+:SetFromReg
+    "%WinDir%\System32\Reg" QUERY "%~1" /v "%~2" > "%TEMP%\_envset.tmp" 2>NUL
+    for /f "usebackq skip=2 tokens=2,*" %%A IN ("%TEMP%\_envset.tmp") do (
+        echo/set "%~3=%%B"
+    )
+    goto :EOF
+
+:: Get a list of environment variables from registry
+:GetRegEnv
+    "%WinDir%\System32\Reg" QUERY "%~1" > "%TEMP%\_envget.tmp"
+    for /f "usebackq skip=2" %%A IN ("%TEMP%\_envget.tmp") do (
+        if /I not "%%~A"=="Path" (
+            call :SetFromReg "%~1" "%%~A" "%%~A"
+        )
+    )
+    goto :EOF
+
+:main
+    echo/@echo off >"%TEMP%\_env.cmd"
+
+    :: Slowly generating final file
+    call :GetRegEnv "HKLM\System\CurrentControlSet\Control\Session Manager\Environment" >> "%TEMP%\_env.cmd"
+    call :GetRegEnv "HKCU\Environment">>"%TEMP%\_env.cmd" >> "%TEMP%\_env.cmd"
+
+    :: Special handling for PATH - mix both User and System
+    call :SetFromReg "HKLM\System\CurrentControlSet\Control\Session Manager\Environment" Path Path_HKLM >> "%TEMP%\_env.cmd"
+    call :SetFromReg "HKCU\Environment" Path Path_HKCU >> "%TEMP%\_env.cmd"
+
+    :: Caution: do not insert space-chars before >> redirection sign
+    echo/set "Path=%%Path_HKLM%%;%%Path_HKCU%%" >> "%TEMP%\_env.cmd"
+
+    :: Cleanup
+    del /f /q "%TEMP%\_envset.tmp" 2>nul
+    del /f /q "%TEMP%\_envget.tmp" 2>nul
+
+    :: capture user / architecture
+    SET "OriginalUserName=%USERNAME%"
+    SET "OriginalArchitecture=%PROCESSOR_ARCHITECTURE%"
+
+    :: Set these variables
+    call "%TEMP%\_env.cmd"
+
+    :: Cleanup
+    del /f /q "%TEMP%\_env.cmd" 2>nul
+
+    :: reset user / architecture
+    SET "USERNAME=%OriginalUserName%"
+    SET "PROCESSOR_ARCHITECTURE=%OriginalArchitecture%"
+
+    echo | set /p dummy="Finished."
+    echo ...
@@ -0,0 +1,25 @@
+@Rem Copyright Epic Games, Inc. All Rights Reserved.
+
+@echo off
+
+@Rem Set script directory as working directory.
+pushd "%~dp0"
+
+title Cirrus
+
+@Rem Run setup to ensure we have node and cirrus installed.
+call setup.bat
+
+@Rem Move to cirrus directory.
+pushd ..\..
+
+@Rem Run node server and pass any argument along.
+platform_scripts\cmd\node\node.exe cirrus %*
+
+@Rem Pop cirrus directory.
+popd
+
+@Rem Pop script directory.
+popd
+
+pause
@@ -0,0 +1,24 @@
+License
+-------
+
+Copyright (C) 1999-2008 - Jonathan Wilkes
+http://www.xanya.net
+
+Installing and using this software (or source code) signifies acceptance of these terms and the conditions of the license.
+This license applies to everything in this package (Including any supplied Source Code), except where otherwise noted.
+
+License Agreement
+-----------------
+
+This software is provided 'as-is', without any express or implied warranty. 
+In no event will the author be held liable for any damages arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software/source code. 
+(If you use the supplied source code (if any) in a product, then an acknowledgment in the product documentation would be appreciated but is not required.)
+
+2. If you have downloaded the Source Code for this application (where available) then altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
+
+3. This notice may not be removed or altered from any distribution of the software.
+(If you use the supplied source code (if any) in a product, including commercial applications, then you do NOT need to distribute this license with your product.)
@@ -0,0 +1,46 @@
+
+SetEnv
+Version 1.09 - ( For Windows 9x/NT/2000/XP/S2K3/Vista )
+
+Copyright (C) 2005-2008 - Jonathan Wilkes - All Rights Reserved.
+http://www.xanya.net
+
+================================================================================
+
+1. Installation
+
+	Simply download and run the Setup_SetEnv.exe application to install SetEnv.
+
+2. Using SetEnv
+
+	The SetEnv is a free tool for setting/updating/deleting System Environment Variables.
+	Type the following at a command prompt (assumes SetEnv.exe is in current path), for command line usage information.
+
+		setenv -?
+
+	See our website for full usage details, http://www.xanya.net/site/utils/setenv.php
+
+3. Version History
+
+	1.09 [Fix] - (Feb 9, 2008) - Fixed a problem on Windows 98 where it sometimes failed to open the Autoexec.bat file.
+	1.08 [New] - (May 31, 2007) - Added how to delete a USER environment variable to the usage information.
+	1.07 [Fix] - (Jan 25, 2007) - Fixed a bug found by depaolim.
+	1.06 [New] - (Jan 14, 2007) - Added dynamic expansion support (same as using ~ with setx)
+		- Originally requested by Andre Amaral, further Request by Synetech
+	1.05 [New] - (Sep 06, 2006) - Added support to prepend (rather than append) a value to an expanded string 
+		- Requested by Masuia
+	1.04 [New] - (May 30, 2006) - Added support for User environment variables.
+	1.03 [Fix] - (Apr 20, 2006) - Bug fix in ProcessWinXP() discovered by attiasr 
+	1.01 [Fix] - (Nov 15, 2005) - Bug fix in IsWinME() discovered by frankd 
+	1.00 [New] - (Oct 29, 2005) - Initial Public Release.
+
+4. License and Terms of Use
+
+	Please see the License.txt file for licensing information.
+
+5. Reporting Problems
+
+	If you encounter any problems whilst using SetEnv, please try downloading the latest version from http://www.xanya.net to see if the problem has already been resolved.
+	If this does not help, then please send an e-mail to darka@xanya.net with details describing the problem.
+
+================================================================================
@@ -0,0 +1,23 @@
+@Rem Copyright Epic Games, Inc. All Rights Reserved.
+
+@echo off
+
+@Rem Set script location as working directory for commands.
+pushd "%~dp0"
+
+@Rem Ensure we have NodeJs available for calling.
+call setup_node.bat
+
+@Rem Ensure we have frontend built.
+call setup_frontend.bat %*
+
+@Rem Ensure we have CoTURN available for calling.
+call setup_coturn.bat
+
+@Rem Move to cirrus.js directory and install its package.json
+pushd %~dp0\..\..\
+call platform_scripts\cmd\node\npm install --no-save
+popd
+
+@Rem Pop working directory
+popd
@@ -0,0 +1,25 @@
+@Rem Copyright Epic Games, Inc. All Rights Reserved.
+
+@echo off
+
+@Rem Set script location as working directory for commands.
+pushd "%~dp0"
+
+@Rem Look for CoTURN directory next to this script
+if exist coturn\ (
+  echo CoTURN directory found...skipping install.
+) else (
+  echo CoTURN directory not found...beginning CoTURN download for Windows.
+
+  @Rem Download nodejs and follow redirects.
+  curl -L -o ./turnserver.zip "https://github.com/mcottontensor/coturn/releases/download/v4.5.2-windows/turnserver.zip"
+
+  @Rem Unarchive the .zip to a directory called "turnserver"
+  mkdir coturn & tar -xf turnserver.zip -C coturn
+
+  @Rem Delete the downloaded turnserver.zip
+  del turnserver.zip
+)
+
+@Rem Pop working directory
+popd
@@ -0,0 +1,74 @@
+:main
+  @Rem Copyright Epic Games, Inc. All Rights Reserved.
+  @echo off
+
+  @Rem Set root directory as working directory for commands.
+  pushd %~dp0\..\..\..\
+
+  @Rem By default don't build the frontend files
+  set "shouldbuild=false"
+
+  @Rem Check if --build is passed as argument and we will always build frontend files.
+  :parse
+  IF "%~1"=="" GOTO endparse
+  IF "%~1"=="--build" set "shouldbuild=true"
+  SHIFT
+  GOTO parse
+  :endparse
+
+  @Rem Look under /Public directory for player.html
+  if exist SignallingWebServer\Public\player.html (
+    @Rem If --build is passed then we should build
+    if "%shouldbuild%" == "true" (
+      call :buildFrontend
+    ) else (
+      echo Skipping rebuilding frontend... SignallingWebServer/Public has content already, use --build to force a frontend rebuild.
+    )
+  ) else (
+    call :buildFrontend
+  )
+
+  @Rem Pop working directory
+  popd
+
+  goto :eof
+
+:buildFrontend
+  echo Building frontend files...
+
+  @Rem Look for a node directory next to this script
+  if not exist node call SignallingWebServer\platform_scripts\cmd\setup_node.bat
+
+  @Rem NOTE: We want to use our NodeJS (not system NodeJS!) to build the web frontend files.
+  @Rem Save our current directory (the NodeJS dir) in a variable
+  set "NodeDir=%CD%\SignallingWebServer\platform_scripts\cmd\node"
+
+  @Rem Prepend NodeDir to PATH temporarily using a custom tool called SetEnv
+  call SignallingWebServer\platform_scripts\cmd\setenv\SetEnv.exe -uap PATH %%%%"%NodeDir%"
+  @Rem Refresh the cmd session with new PATH
+  call %~dp0\refreshenv.cmd
+
+  @Rem Do npm install in the Frontend\lib directory (note we use start because that loads PATH)
+  echo ----------------------------
+  echo Building frontend library...
+  pushd %CD%\Frontend\library
+  call ..\..\SignallingWebServer\platform_scripts\cmd\node\npm install
+  call ..\..\SignallingWebServer\platform_scripts\cmd\node\npx webpack
+  popd
+  echo End of build PS frontend lib step.
+
+  @Rem Do npm install in the Frontend\implementations\EpicGames directory (note we use start because that loads PATH)
+  echo ----------------------------
+  echo Building Epic Games reference frontend...
+  pushd %CD%\Frontend\implementations\EpicGames
+  call ..\..\..\SignallingWebServer\platform_scripts\cmd\node\npm install
+  call ..\..\..\SignallingWebServer\platform_scripts\cmd\node\npm link ../../library
+  call ..\..\..\SignallingWebServer\platform_scripts\cmd\node\npx webpack
+  popd
+  echo End of build reference frontend step.
+  echo ----------------------------
+
+  @Rem Remove our NodeJS from the PATH
+  call SignallingWebServer\platform_scripts\cmd\setenv\SetEnv.exe -ud PATH %%%%"%NodeDir%"
+
+  goto :eof
@@ -0,0 +1,35 @@
+@Rem Copyright Epic Games, Inc. All Rights Reserved.
+
+@echo off
+
+@Rem Set script location as working directory for commands.
+pushd "%~dp0"
+
+@Rem Name and version of node that we are downloading
+SET NodeVersion=v16.4.2
+SET NodeName=node-%NodeVersion%-win-x64
+
+@Rem Look for a node directory next to this script
+if exist node\ (
+  echo Node directory found...skipping install.
+) else (
+  echo Node directory not found...beginning NodeJS download for Windows.
+
+  @Rem Download nodejs and follow redirects.
+  curl -L -o ./node.zip "https://nodejs.org/dist/%NodeVersion%/%NodeName%.zip"
+
+  @Rem Unarchive the .zip
+  tar -xf node.zip
+
+  @Rem Rename the extracted, versioned, directory that contains the NodeJS binaries to simply "node".
+  ren "%NodeName%\" "node"
+
+  @Rem Delete the downloaded node.zip
+  del node.zip
+)
+
+@Rem Print node version
+echo Node version: & node\node.exe -v
+
+@Rem Pop working directory
+popd