upgraded to SpatialOS 10.3.0

Author: johnprobable

README.md

@@ -1,9 +1,9 @@
 # Starter Project
 ---
 
-*Copyright Improbable 2017*
+*Copyright Improbable Worlds Ltd, 2017*
 
-- *GitHub Repository*: [github.com/spatialos/StarterProject](https://github.com/spatialos/StarterProject)
+- *GitHub repository*: [https://github.com/spatialos/StarterProject](https://github.com/spatialos/StarterProject)
 
 ---
 
@@ -13,12 +13,14 @@ This is a SpatialOS starter project with useful core features that you can exten
 
 It contains:
 
-* A Player spawned on client connection.
-* A Cube spawned through a snapshot via an entity template method and Unity prefab.
-* Other features of the [BlankProject](https://github.com/spatialos/BlankProject).
+* A Player spawned on client connection as per the [Unity Client Lifecycle Guide](https://spatialos.improbable.io/docs/reference/latest/tutorials/client-lifecycle).
+* A Cube spawned through a snapshot via an entity template method and an Unity prefab.
+* The rest of the features included in the [BlankProject](https://github.com/spatialos/BlankProject).
 
-## Using the Starter Project
+If you run into problems, or want to give us feedback, please visit the [SpatialOS forums](https://forums.improbable.io/).
 
-[SpatialOS documentation](https://spatialos.improbable.io/docs/).
+## Running the project
 
-To report bugs or to give feedback on this project, please contact SpatialOS Support.
+To run the project locally, first build it by running `spatial worker build`, then start the server with `spatial local start`. You can connect a client by opening the Unity project and pressing the play button, or by running `spatial local worker launch UnityClient default`. See the [documentation](https://spatialos.improbable.io/docs/reference/latest/developing/local/run) for more details.
+
+To deploy the project to the cloud, first build it by running `spatial worker build -t=deployment`, then upload the assembly with `spatial cloud upload <assembly name>`, and finally deploy it with `spatial cloud launch <assembly name> <launch configuration file> <deployment name> --snapshot=<snapshot file>`. You can obtain and share links to connect to the deployment from the [console](http://console.improbable.io/projects). See the [documentation](https://spatialos.improbable.io/docs/reference/latest/developing/deploy-an-application) for more details.

…bable/global/ClientAuthorityCheck.schema …robable/core/ClientAuthorityCheck.schemaschema/improbable/global/ClientAuthorityCheck.schema renamed to schema/improbable/core/ClientAuthorityCheck.schema schema/improbable/global/ClientAuthorityCheck.schema renamed to schema/improbable/core/ClientAuthorityCheck.schema

@@ -1,4 +1,4 @@
-package improbable.global;
+package improbable.core;
 
 component ClientAuthorityCheck {
   id = 1002;

…/improbable/global/PlayerCreation.schema …ma/improbable/core/PlayerCreation.schemaschema/improbable/global/PlayerCreation.schema renamed to schema/improbable/core/PlayerCreation.schema schema/improbable/global/PlayerCreation.schema renamed to schema/improbable/core/PlayerCreation.schema

@@ -1,4 +1,4 @@
-package improbable.global;
+package improbable.core;
 
 type CreatePlayerRequest {}
 type CreatePlayerResponse {}

…hema/improbable/global/Quaternion.schema schema/improbable/core/Quaternion.schemaschema/improbable/global/Quaternion.schema renamed to schema/improbable/core/Quaternion.schema schema/improbable/global/Quaternion.schema renamed to schema/improbable/core/Quaternion.schema

@@ -1,4 +1,4 @@
-package improbable.global;
+package improbable.core;
 
 type Quaternion {
   float x = 1;

schema/improbable/core/WorldTransform.schema

@@ -0,0 +1,9 @@
+package improbable.core;
+
+import "improbable/core/Quaternion.schema";
+
+component WorldTransform {
+    id = 1000;
+    EntityPosition position = 1;
+    improbable.core.Quaternion rotation = 2;
+}

schema/improbable/global/WorldTransform.schema

@@ -47,4 +47,5 @@ sysinfo.txt
 *.apk
 *.unitypackage
 
-.idea/
+.idea/
+.vs/

workers/gsim/spatialos.gsim.build.json

@@ -1,52 +1,81 @@
-using System;
+using Assets.Gamelogic.Core;
+using Improbable.Unity;
+using Improbable.Unity.EditorTools.Build;
+using System;
 using System.IO;
 using System.Linq;
-using Assets.Gamelogic.Global;
-using Improbable.Unity;
 using UnityEditor;
-using Improbable.Unity.EditorTools.Build;
 
 namespace Assets.Editor
 {
     [InitializeOnLoad]
     public class PlayerBuildProcess : IPlayerBuildEvents
     {
+        // Install the custom event handler
+        static PlayerBuildProcess()
+        {
+            /* Each time you use Build development players or Build deployment players, SimpleBuildSystem.CreatePlayerBuildEventsAction
+               is called, and a new PlayerBuildProcess event handler will be created */
+            SimpleBuildSystem.CreatePlayerBuildEventsAction = () => new PlayerBuildProcess();
+            // Configure the Unity editor build settings for running multiple scenes with the editor
+            EditorBuildSettings.scenes = FormatAsBuildSettingsScenes(GetAllScenes());
+        }
+
         #region Implement IPlayerBuildEvents
 
+        // Overridden function to load (and optionally modify) scenes, then return an array of scene paths to be built into the worker
         public string[] GetScenes(WorkerPlatform workerType)
         {
+            string[] scenePaths;
+
             switch (workerType)
             {
                 case WorkerPlatform.UnityClient:
-                    return FormatSceneList(BuildSettings.ClientScenes, BuildSettings.ClientDefaultActiveScene);
+                    scenePaths = FormatSceneList(BuildSettings.ClientScenes, BuildSettings.ClientDefaultActiveScene);
+                    break;
                 case WorkerPlatform.UnityWorker:
-                    return FormatSceneList(BuildSettings.WorkerScenes, BuildSettings.WorkerDefaultActiveScene);
+                    scenePaths = FormatSceneList(BuildSettings.WorkerScenes, BuildSettings.WorkerDefaultActiveScene);
+                    break;
                 default:
                     throw new Exception("Attempting to get scenes for unrecognised worker platform");
             }
-        }
-
-        private string[] FormatSceneList(string[] sceneList, string defaultActiveScene)
-        {
-            return sceneList.OrderBy(scene => scene != defaultActiveScene).Select(FormatSceneName).ToArray();
-        }
 
-        private string FormatSceneName(string sceneName)
-        {
-            return Path.Combine(BuildSettings.SceneDirectory, sceneName) + ".unity";
+            return scenePaths;
         }
 
+        // Overridden function called before any workers are built - use to do preliminary work such as saving scenes
         public void BeginBuild() { }
 
+        // Overridden function called after all workers are built, even if errors occurred - use to clean up anything done in BeginBuild
         public void EndBuild() { }
 
+        // Overridden function - use to do work such as copying additional files that need to be packaged with the worker
         public void BeginPackage(WorkerPlatform workerType, BuildTarget target, Config config, string packagePath) { }
 
         #endregion
 
-        static PlayerBuildProcess()
+        // Map array of scene paths to custom Unity type for saving as editor build settings
+        private static EditorBuildSettingsScene[] FormatAsBuildSettingsScenes(string[] scenePaths)
         {
-            SimpleBuildSystem.CreatePlayerBuildEventsAction = () => new PlayerBuildProcess();
+            return scenePaths.Select(scenePath => new EditorBuildSettingsScene(scenePath, true)).ToArray();
+        }
+
+        // Get all scenes for the purposes of adding to the Unity editor build settings
+        private static string[] GetAllScenes()
+        {
+            return BuildSettings.ClientScenes.Union(BuildSettings.WorkerScenes).Select(FormatSceneName).ToArray();
+        }
+
+        // Ensures scene specified as default is listed (and therefore loaded) first
+        private static string[] FormatSceneList(string[] sceneList, string defaultActiveScene)
+        {
+            return sceneList.OrderBy(scene => scene != defaultActiveScene).Select(FormatSceneName).ToArray();
+        }
+
+        // Formats scene name as it appears in your Unity project directory
+        private static string FormatSceneName(string sceneName)
+        {
+            return Path.Combine(BuildSettings.SceneDirectory, sceneName) + ".unity";
         }
     }
-}
+}

workers/unity/.gitignore

@@ -1,12 +1,12 @@
-using System.Collections.Generic;
-using System.IO;
+using Assets.Gamelogic.Core;
 using Assets.Gamelogic.EntityTemplates;
 using Improbable;
 using Improbable.Worker;
-using UnityEngine;
 using JetBrains.Annotations;
+using System.Collections.Generic;
+using System.IO;
 using UnityEditor;
-using Assets.Gamelogic.Global;
+using UnityEngine;
 
 namespace Assets.Editor 
 {