Merge pull request #38 from spatialos/0.6.0-rc

Example project release for UnrealGDK `0.6.0`

BuildProject.bat

@@ -1,7 +1,35 @@
 @echo off
+
 call "%~dp0ProjectPaths.bat"
-call %~dp0%PROJECT_PATH%\"Plugins/UnrealGDK/SpatialGDK/Build/Scripts/BuildWorker.bat" %GAME_NAME%Server Linux Development %GAME_NAME%.uproject || goto :error
-call %~dp0%PROJECT_PATH%\"Plugins/UnrealGDK/SpatialGDK/Build/Scripts/BuildWorker.bat" %GAME_NAME% Win64 Development %GAME_NAME%.uproject || goto :error
+
+setlocal EnableDelayedExpansion
+
+set GDK_DIRECTORY=""
+
+rem If a project plugin exists. Use this for building.
+if exist "%~dp0\%PROJECT_PATH%\Plugins\UnrealGDK" (
+    set GDK_DIRECTORY="%~dp0\%PROJECT_PATH%\Plugins\UnrealGDK\"
+    goto :BuildWorkers
+)
+
+rem If there is no project plugin. Find the engine plugin.
+call "%~dp0FindEngine.bat"
+
+if %UNREAL_ENGINE%=="" (
+    echo Error: Could not find the Unreal Engine. Please associate your '.uproject' with an engine version or ensure this game project is nested within an engine build.
+    pause
+    exit /b 1
+)
+
+set GDK_DIRECTORY=%UNREAL_ENGINE%\Engine\Plugins\UnrealGDK
+
+
+:BuildWorkers
+echo Building worker with GDK located at %GDK_DIRECTORY%
+
+call %GDK_DIRECTORY%\SpatialGDK\Build\Scripts\BuildWorker.bat %GAME_NAME%Server Linux Development "%~dp0\%PROJECT_PATH%\%GAME_NAME%.uproject" || goto :error
+call %GDK_DIRECTORY%\SpatialGDK\Build\Scripts\BuildWorker.bat %GAME_NAME%SimulatedPlayer Linux Development "%~dp0\%PROJECT_PATH%\%GAME_NAME%.uproject" || goto :error
+call %GDK_DIRECTORY%\SpatialGDK\Build\Scripts\BuildWorker.bat %GAME_NAME% Win64 Development "%~dp0\%PROJECT_PATH%\%GAME_NAME%.uproject" || goto :error
 echo All builds succeeded.
 
 pause

DeployGame.bat

@@ -18,8 +18,6 @@ spatial cloud launch %deploymentname% one_worker_test.json %deploymentname% --sn
 spatial project deployment tags add %deploymentname% dev_login || goto :error
 spatial project deployment tags add %deploymentname% status_lobby || goto :error
 
-
-
 echo Deployment succeeded.
 cd ../
 pause

FindEngine.bat

@@ -0,0 +1,84 @@
+@echo off
+
+setlocal EnableDelayedExpansion
+
+rem Get the Unreal Engine used by this project by querying the registry for the engine association found in the .uproject.
+set UNREAL_ENGINE=""
+set UPROJECT=""
+
+rem First find the .uproject
+for /f "delims=" %%A in (' powershell -Command "Get-ChildItem %~dp0 -Depth 1 -Filter *.uproject -File | %% {$_.FullName}" ') do set UPROJECT="%%A"
+
+if %UPROJECT%=="" (
+    echo Error: Could not find uproject. Please make sure you have passed in the project directory correctly.
+    pause
+    exit /b 1
+)
+
+echo Using uproject: %UPROJECT%
+
+rem Get the Engine association from the uproject.
+for /f "delims=" %%A in (' powershell -Command "(Get-Content %UPROJECT% | ConvertFrom-Json).EngineAssociation" ') do set ENGINE_ASSOCIATION=%%A
+
+echo Engine association for uproject is: %ENGINE_ASSOCIATION%
+
+rem If the engine association is a path then use this. If the path is relative then it will be relative to the uproject, thus we must change directory to the uproject folder.
+
+rem Grab the project path from the .uproject file.
+for %%i in (%UPROJECT%) do (
+	rem file drive + file directory
+	set UNREAL_PROJECT_DIR="%%~di%%~pi"
+)
+
+pushd %UNREAL_PROJECT_DIR%
+
+if exist "%ENGINE_ASSOCIATION%" (
+    cd /d "%ENGINE_ASSOCIATION%"
+    set UNREAL_ENGINE="!cd!"
+)
+
+popd
+
+rem Try and use the engine association as a key in the registry to get the path to Unreal.
+if %UNREAL_ENGINE%=="" (
+    if not "%ENGINE_ASSOCIATION%"=="" (
+        rem Query the registry for the path to the Unreal Engine using the engine association.
+        for /f "usebackq tokens=1,2* skip=2" %%A in (`reg query "HKCU\Software\Epic Games\Unreal Engine\Builds" /v %ENGINE_ASSOCIATION%`) do (
+            set UNREAL_ENGINE="%%C"
+        )
+    )
+)
+
+rem If there was no engine association then we need to climb the directory path of the project to find the Engine.
+if %UNREAL_ENGINE%=="" (
+    pushd "%~dp0"
+
+    :climb_parent_directory
+    if exist Engine (
+        rem Check for the Build.version file to be sure we have found a correct Engine folder.
+        if exist "Engine\Build\Build.version" (
+            set UNREAL_ENGINE="!cd!"
+        )
+    ) else (
+        rem This checks if we are in a root directory. If so we cannot check any higher and so should error out.
+        if "%cd:~3,1%"=="" (
+            echo Error: Could not find Unreal Engine folder. Please set a project association or ensure your game project is within an Unreal Engine folder.
+            pause
+            exit /b 1
+        )
+        cd ..
+        goto :climb_parent_directory
+    )
+
+    popd
+)
+
+if %UNREAL_ENGINE%=="" (
+    echo Error: Could not find the Unreal Engine. Please associate your '.uproject' with an engine version or ensure this game project is nested within an engine build.
+    pause
+    exit /b 1
+)
+
+endlocal & set UNREAL_ENGINE=%UNREAL_ENGINE%
+
+echo Unreal engine found at: %UNREAL_ENGINE%

Game/Config/DefaultEngine.ini

@@ -1,7 +1,7 @@
 [/Script/EngineSettings.GameMapsSettings]
 GameDefaultMap=/Game/Maps/Deployments.Deployments
 EditorStartupMap=/Game/Maps/FPS-Start_Tiny.FPS-Start_Tiny
-GlobalDefaultGameMode=/Game/GameMode/BP_GDKGameMode.BP_GDKGameMode_C
+GlobalDefaultGameMode=/Game/GameMode/BP_DeathmatchGameMode.BP_DeathmatchGameMode_C
 GameInstanceClass=/Script/SpatialGDK.SpatialGameInstance
 GlobalDefaultServerGameMode=None
 ServerDefaultMap=/Game/Maps/FPS-Start_Medium.FPS-Start_Medium
@@ -57,13 +57,12 @@ DefaultFluidFriction=0.300000
 SimulateScratchMemorySize=262144
 RagdollAggregateThreshold=4
 TriangleMeshTriangleMinAreaThreshold=5.000000
-bEnableAsyncScene=False
 bEnableShapeSharing=False
 bEnablePCM=False
 bEnableStabilization=False
 bWarnMissingLocks=True
 bEnable2DPhysics=False
-PhysicErrorCorrection=(PingExtrapolation=0.100000,ErrorPerLinearDifference=1.000000,ErrorPerAngularDifference=1.000000,MaxRestoredStateError=1.000000,PositionLerp=0.000000,AngleLerp=0.400000,LinearVelocityCoefficient=100.000000,AngularVelocityCoefficient=10.000000,ErrorAccumulationSeconds=0.500000,ErrorAccumulationDistanceSq=15.000000,ErrorAccumulationSimilarity=100.000000)
+PhysicErrorCorrection=(PingExtrapolation=0.100000,PingLimit=100.000000,ErrorPerLinearDifference=1.000000,ErrorPerAngularDifference=1.000000,MaxRestoredStateError=1.000000,MaxLinearHardSnapDistance=400.000000,PositionLerp=0.000000,AngleLerp=0.400000,LinearVelocityCoefficient=100.000000,AngularVelocityCoefficient=10.000000,ErrorAccumulationSeconds=0.500000,ErrorAccumulationDistanceSq=15.000000,ErrorAccumulationSimilarity=100.000000)
 LockedAxis=Invalid
 DefaultDegreesOfFreedom=Full3D
 BounceThresholdVelocity=200.000000
@@ -90,9 +89,10 @@ bSubsteppingAsync=False
 MaxSubstepDeltaTime=0.016667
 MaxSubsteps=6
 SyncSceneSmoothingFactor=0.000000
-AsyncSceneSmoothingFactor=0.990000
 InitialAverageFrameRate=0.016667
 PhysXTreeRebuildRate=10
 DefaultBroadphaseSettings=(bUseMBPOnClient=False,bUseMBPOnServer=False,MBPBounds=(Min=(X=0.000000,Y=0.000000,Z=0.000000),Max=(X=0.000000,Y=0.000000,Z=0.000000),IsValid=0),MBPNumSubdivs=2)
 
+[/Script/NavigationSystem.NavigationSystemV1]
+bAllowClientSideNavigation=True
 

Game/Config/DefaultInput.ini

@@ -70,11 +70,11 @@ FOVScale=0.011110
 DoubleClickTime=0.200000
 +ActionMappings=(ActionName="Jump",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=SpaceBar)
 +ActionMappings=(ActionName="Jump",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=Gamepad_FaceButton_Bottom)
-+ActionMappings=(ActionName="Fire",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=LeftMouseButton)
++ActionMappings=(ActionName="Primary",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=LeftMouseButton)
 +ActionMappings=(ActionName="Sprint",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=LeftShift)
 +ActionMappings=(ActionName="ShowScoreboard",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=Tab)
 +ActionMappings=(ActionName="Crouch",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=LeftControl)
-+ActionMappings=(ActionName="Aim",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=RightMouseButton)
++ActionMappings=(ActionName="Secondary",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=RightMouseButton)
 +ActionMappings=(ActionName="1",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=One)
 +ActionMappings=(ActionName="2",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=Two)
 +ActionMappings=(ActionName="3",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=Three)
@@ -90,6 +90,10 @@ DoubleClickTime=0.200000
 +ActionMappings=(ActionName="ShowMenu",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=BackSpace)
 +ActionMappings=(ActionName="ShowMenu",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=Escape)
 +ActionMappings=(ActionName="ShowMenu",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=F12)
++ActionMappings=(ActionName="ScrollUp",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=MouseScrollUp)
++ActionMappings=(ActionName="ScrollDown",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=MouseScrollDown)
++ActionMappings=(ActionName="QuickToggle",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=Q)
++ActionMappings=(ActionName="ToggleMode",bShift=False,bCtrl=False,bAlt=False,bCmd=False,Key=X)
 +AxisMappings=(AxisName="MoveForward",Scale=1.000000,Key=W)
 +AxisMappings=(AxisName="MoveForward",Scale=-1.000000,Key=S)
 +AxisMappings=(AxisName="MoveForward",Scale=1.000000,Key=Up)

Game/Config/DefaultSpatialGDKEditorSettings.ini

@@ -0,0 +1,8 @@
+[/Script/SpatialGDKEditor.SpatialGDKEditorSettings]
+bDeleteDynamicEntities=True
+bGenerateDefaultLaunchConfig=True
+bStopSpatialOnExit=False
+SpatialOSSnapshotFile=default.snapshot
+LaunchConfigDesc=(Template="w2_r0500_e5",World=(Dimensions=(X=2000,Y=2000),ChunkEdgeLengthMeters=5,StreamingQueryIntervalSeconds=4,SnapshotWritePeriodSeconds=0,LegacyFlags=(("bridge_qos_max_timeout", "0"),("bridge_soft_handover_enabled", "false"),("enable_chunk_interest", "false")),LegacyJavaParams=()),ServerWorkers=((WorkerTypeName="UnrealWorker"),(WorkerTypeName="AIWorker"),(WorkerTypeName="CrashBotWorker")))
+bGeneratePlaceholderEntitiesInSnapshot=True
+

Game/Config/DefaultSpatialGDKSettings.ini

@@ -1,5 +1,34 @@
-
-
 [/Script/SpatialGDK.SpatialGDKSettings]
+EntityPoolInitialReservationCount=3000
+EntityPoolRefreshThreshold=1000
+EntityPoolRefreshCount=2000
+HeartbeatIntervalSeconds=2.000000
+HeartbeatTimeoutSeconds=10.000000
+ActorReplicationRateLimit=0
+EntityCreationRateLimit=0
+OpsUpdateRate=1000.000000
+bEnableHandover=True
 bUsingQBI=True
+PositionUpdateFrequency=1.000000
+PositionDistanceThreshold=100.000000
+bEnableMetrics=True
+bEnableMetricsDisplay=False
+MetricsReportRate=2.000000
+bUseFrameTimeAsLoad=False
+bCheckRPCOrder=False
+bBatchSpatialPositionUpdates=True
+bEnableServerQBI=True
+bPackUnreliableRPCs=True
+bUseDevelopmentAuthenticationFlow=False
+DevelopmentAuthenticationToken=
+DevelopmentDeploymentToConnect=
+DefaultWorkerType=(WorkerTypeName="UnrealWorker")
+bEnableOffloading=True
+ActorGroups=(("AI", (OwningWorkerType=(WorkerTypeName="AIWorker"),ActorClasses=(/Game/Characters/Turret/BP_Turret_Base.BP_Turret_Base_C,/Game/Controllers/BP_TurretController.BP_TurretController_C,/Game/Characters/Turret/BP_TurretShield.BP_TurretShield_C,/Game/Blueprints/Weapons/BP_HeavyMachineGun_ForTurret.BP_HeavyMachineGun_ForTurret_C,/Game/Blueprints/Weapons/Grenades/Turret_Rocket_Propelled.Turret_Rocket_Propelled_C,/Game/Blueprints/Weapons/BP_RocketLauncher_Continuous.BP_RocketLauncher_Continuous_C))),("CrashBot", (OwningWorkerType=(WorkerTypeName="CrashBotWorker"),ActorClasses=(/Game/Characters/BP_CrashBot.BP_CrashBot_C,/Game/Controllers/BP_CrashBotController.BP_CrashBotController_C))))
+ServerWorkerTypes=("UnrealWorker","AIWorker","CrashBotWorker")
+MaxDynamicallyAttachedSubobjectsPerClass=3
+bPackRPCs=True
+DefaultReceptionistHost=127.0.0.1
+MaxNetCullDistanceSquared=900000000.000000
+
 

Game/Source/GDKShooter.Target.cs

@@ -9,5 +9,7 @@ public GDKShooterTarget(TargetInfo Target) : base(Target)
 	{
 		Type = TargetType.Game;
 		ExtraModuleNames.Add("GDKShooter");
+		// TODO: UNR-1791 for long-term fix
+		GlobalDefinitions.Add("UE_ALLOW_MAP_OVERRIDE_IN_SHIPPING=1");
 	}
 }

Game/Source/GDKShooter/GDKShooter.Build.cs

@@ -23,7 +23,8 @@ public GDKShooter(ReadOnlyTargetRules Target) : base(Target)
 				"SlateCore",
 				"SpatialGDK",
                 "Json",
-                "HTTP"
+                "HTTP",
+                "AIModule"
 			});
 	}
 }