revised blank project for SpatialOS 10.2.0

Author: johnprobable

README.md

@@ -1,9 +1,9 @@
-# BlankProject
+# Blank Project
 ---
 
-*Copyright Improbable 2016*
+*Copyright Improbable Worlds Ltd, 2017*
 
-- *GitHub Repository*: [github.com/spatialos/BlankProject](https://github.com/spatialos/BlankProject)
+- *GitHub repository*: [https://github.com/spatialos/BlankProject](https://github.com/spatialos/BlankProject)
 
 ---
 
@@ -14,14 +14,10 @@ This is a blank SpatialOS project that you can use to build your own SpatialOS a
 It contains:
 
 * A SpatialOS project descriptor.
-* Unity worker
+* A Unity worker.
 * Bare-bones Launch Configurations for automatically and manually launching workers.
 * Bare-bones Client and Physics Scenes with a `Bootstrap.cs` file.
-* An example deployment configuration, `deploy.json`.
+* An example deployment configuration, `default_launch.json`.
 * `.gitignore` files for a SpatialOS project.
 
-## Using the BlankProject
-
-[SpatialOS documentation](https://spatialos.improbable.io/docs/).
-
-To report bugs or to give feedback on this project, please contact SpatialOS Support.
+If you run into problems, or want to give us feedback, please visit the [SpatialOS forums](https://forums.improbable.io/).

default_launch.json

@@ -6,30 +6,17 @@
       "snapshotWritePeriodSeconds": 0
     },
     "dimensions": {
-      "xMeters": 8000,
-      "zMeters": 8000
+      "xMeters": 1500,
+      "zMeters": 1500
     }
   },
   "workers": [
     {
       "worker_type": "UnityWorker",
       "load_balancing": {
-        "dynamic_loadbalancer": {
-          "worker_scaler_config": {
-            "constant_config": {
-              "num_workers": 4
-            }
-          },
-          "worker_placer_config": {
-            "random_params": {}
-          },
-          "loadbalancer_config": {
-            "min_range_meters": 500.0,
-            "max_range_meters": 5000.0,
-            "speed_meters_per_second": 100.0,
-            "expansion_time_millis": 60000
-          }
-        } 
+        "auto_hex_grid": {
+          "num_workers": 1
+         }
       },
       "permissions": [{
         "all": {}
@@ -38,9 +25,19 @@
     {
       "worker_type": "UnityClient",
       "permissions": [{
-        "all": {}
+        "entity_creation": {
+          "allow": false
+        },
+        "entity_deletion": {
+          "allow": false
+        },
+        "entity_query": {
+          "allow": true,
+          "components": [
+              "*"
+          ]
         }
-      ]
+      }]
     }
   ]
 }

schema/improbable/general/WorldTransform.schema

@@ -0,0 +1,6 @@
+package improbable.global;
+
+component WorldTransform {
+    id = 1000;
+    EntityPosition position = 1;
+}

schema/improbable/global/WorldTransform.schema

@@ -1,8 +1,8 @@
 {
     "name": "your_project_name_here",
-    "project_version": "0.0.4",
+    "project_version": "1.0.0",
     "sdk_version": "10.2.0",
     "dependencies": [
-		{"name": "WorkerSdkSchema", "version": "10.2.0"}
+    	{"name": "WorkerSdkSchema", "version": "10.2.0"}
     ]
 }

schema/improbable/player/name.schema

@@ -1,41 +1,40 @@
 using System.Collections.Generic;
 using System.IO;
-using Assets.EntityTemplates;
 using Improbable;
 using Improbable.Worker;
 using UnityEngine;
 using JetBrains.Annotations;
 using UnityEditor;
+using Assets.Gamelogic.Global;
 
-public class SnapshotMenu : MonoBehaviour
+namespace Assets.Editor 
 {
-    private static readonly string InitialWorldSnapshotPath = Application.dataPath +
-                                                              "/../../../snapshots/initial_world.snapshot";
+	public class SnapshotMenu : MonoBehaviour
+	{
+		[MenuItem("Improbable/Snapshots/Generate Default Snapshot")]
+		[UsedImplicitly]
+		private static void GenerateDefaultSnapshot()
+		{
+			var snapshotEntities = new Dictionary<EntityId, SnapshotEntity>();
 
-    [MenuItem("Improbable/Snapshots/Generate Snapshot Programmatically")]
-    [UsedImplicitly]
-    private static void GenerateSnapshotProgrammatically()
-    {
-        var snapshotEntities = new Dictionary<EntityId, SnapshotEntity>();
-        var currentEntityId = 1;
+			// Add entity data to the snapshot
 
-        snapshotEntities.Add(new EntityId(currentEntityId++), ExampleEntityTemplate.GenerateExampleSnapshotEntityTemplate());
+			SaveSnapshot(snapshotEntities);
+		}
 
-        SaveSnapshot(snapshotEntities);
-    }
+		private static void SaveSnapshot(IDictionary<EntityId, SnapshotEntity> snapshotEntities)
+		{
+			File.Delete(SimulationSettings.DefaultSnapshotPath);
+			var maybeError = Snapshot.Save(SimulationSettings.DefaultSnapshotPath, snapshotEntities);
 
-    private static void SaveSnapshot(IDictionary<EntityId, SnapshotEntity> snapshotEntities)
-    {
-        File.Delete(InitialWorldSnapshotPath);
-        var maybeError = Snapshot.Save(InitialWorldSnapshotPath, snapshotEntities);
-
-        if (maybeError.HasValue)
-        {
-            Debug.LogErrorFormat("Failed to generate initial world snapshot: {0}", maybeError.Value);
-        }
-        else
-        {
-            Debug.LogFormat("Successfully generated initial world snapshot at {0}", InitialWorldSnapshotPath);
-        }
-    }
+			if (maybeError.HasValue)
+			{
+				Debug.LogErrorFormat("Failed to generate initial world snapshot: {0}", maybeError.Value);
+			}
+			else
+			{
+				Debug.LogFormat("Successfully generated initial world snapshot at {0}", SimulationSettings.DefaultSnapshotPath);
+			}
+		}
+	}
 }

snapshots/default.snapshot

@@ -0,0 +1,7 @@
+namespace Assets.Gamelogic.EntityTemplates
+{
+    public static class EntityTemplateFactory
+    {
+        // Add methods to define entity templates
+    }
+}

snapshots/initial_world.snapshot

@@ -0,0 +1,40 @@
+using Improbable.Unity;
+using Improbable.Unity.Configuration;
+using Improbable.Unity.Core;
+using UnityEngine;
+
+// Placed on a GameObject in the ClientScene to execute connection logic on client startup.
+namespace Assets.Gamelogic.Global
+{
+    public class Bootstrap : MonoBehaviour
+    {
+        public WorkerConfigurationData Configuration = new WorkerConfigurationData();
+
+        private void Start()
+        {
+            SpatialOS.ApplyConfiguration(Configuration);
+
+            Time.fixedDeltaTime = 1.0f / SimulationSettings.FixedFramerate;
+
+            // Distinguishes between when the Unity is running as a client or a server.
+            switch (SpatialOS.Configuration.WorkerPlatform)
+            {
+                case WorkerPlatform.UnityWorker:
+                    Application.targetFrameRate = SimulationSettings.TargetServerFramerate;
+                    SpatialOS.OnDisconnected += reason => Application.Quit();
+                    break;
+                case WorkerPlatform.UnityClient:
+                    Application.targetFrameRate = SimulationSettings.TargetClientFramerate;
+                    SpatialOS.OnConnected += OnSpatialOsConnection;
+                    break;
+            }
+
+            SpatialOS.Connect(gameObject);
+        }
+
+        private static void OnSpatialOsConnection()
+        {
+            // Add code to handle SpatialOS connection
+        }
+    }
+}

spatialos.json

@@ -0,0 +1,13 @@
+using UnityEngine;
+
+namespace Assets.Gamelogic.Global
+{
+    public static class SimulationSettings
+    {
+        public static readonly int TargetClientFramerate = 60;
+        public static readonly int TargetServerFramerate = 60;
+        public static readonly int FixedFramerate = 20;
+
+        public static readonly string DefaultSnapshotPath = Application.dataPath + "/../../../snapshots/default.snapshot";
+    }
+}