GDK for Unity Blank Project - Initial commit

Author: Paul Balaji

.gitattributes

@@ -0,0 +1,6 @@
+* text=auto
+*.meta text eol=lf
+*.prefab text eol=lf
+*.asset text eol=lf
+*.asmdef text eol=lf
+*.sh text eol=lf

.gitignore

@@ -0,0 +1,50 @@
+/build
+/workers/unity/build/
+/logs/
+.spatialos/
+.idea/
+.vs/
+.DS_Store
+
+#Unity Engine Gitignore (https://github.com/github/gitignore/blob/master/Unity.gitignore)
+workers/unity/[Ll]ibrary/
+workers/unity/[Tt]emp/
+workers/unity/Logs/
+[Oo]bj/
+[Bb]in/
+workers/unity/ProjectSettings/UnityConnectSettings.asset
+
+# Autogenerated VS/MD/Consulo solution and project files
+workers/unity/*.csproj
+workers/unity/*.sln
+*.unityproj
+*.suo
+*.tmp
+*.user
+*.userprefs
+*.svd
+*.DotSettings.user
+_ReSharper.Caches
+
+# Unity3D Generated File On Crash Reports
+sysinfo.txt
+
+# Builds
+*.apk
+*.unitypackage
+
+# Generated code
+# We need to include some of the generated code below, which means we can't use a `directory/` ignore.
+# Once a directory is ignored by git, nothing underneath it can ever be un-ignored.
+workers/unity/Assets/Generated/Source.meta
+workers/unity/Assets/Generated/Source/**/*.*
+
+workers/unity/Assets/Plugins/Editor/
+workers/unity/Assets/Plugins/Editor.meta
+
+workers/unity/Assets/Plugins/Improbable/
+workers/unity/Assets/Plugins/Improbable.meta
+
+# Schema from Unity Package Manager Packages (Copied via tools/CopySchema)
+schema/from_gdk_packages
+_ReSharper.Caches

LICENSE.md

@@ -0,0 +1,49 @@
+# Unity
+Your access to and use of the Unity Engine is governed by the Unity Engine End User License Agreement. Please ensure that you have agreed to those terms before you access or use the Unity Engine.
+
+# SpatialOS GDK for Unity License
+
+Copyright 2018 Improbable Worlds Limited (“Improbable”)
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+2. The Software and any derivative or modified versions may only be used in conjunction with Improbable’s SpatialOS platform and
+may not be used with any other platform or service providing equivalent or similar functionality.
+3. Improbable shall in all cases be identified as the original author of the Software, but individual users are free to impose
+such additional attribution requirements as they wish in relation to their own contributions.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+This licence is governed by the laws of England and Wales and the jurisdiction of the English courts.
+
+## Why yet another license?
+
+We believe that SpatialOS is unique in the capabilities that it gives you access to and our developers have put a
+significant amount of effort in shaping the code that helps you benefit from these capabilities. While we want to
+offer you the results of these efforts freely, we also feel that existing open source licenses do not provide
+the necessary protection against the misuse of our software by competing platforms. The result is this license
+which is as close to the open source spirit as possible while still providing us with the protection that we want.
+
+
+## Where does this license come from?
+
+This license draws for the largest part from open source licenses with their entrenched rights to copy, modify,
+share and commercialise derived projects. Additionally there are two clauses that make it clear that:
+
+* Our source code and anything derived from it is only intended for use on SpatialOS, thereby excluding any competing platforms.
+* Improbable should always be identified as author within any derived projects but that, as an author of a derived project, you should feel free to add your own name to the author listing.
+
+
+## How does this license affect my work and contributions?
+
+In most, if not all, cases this license should not affect your work and contributions in any significant way.
+You are more than welcome to use the published source code in your own projects, to modify it, improve it and
+redistribute it. You are even free to use it to build and sell your own product. The only thing we ask is that
+any projects derived from our source code are not used on a competing platform (but you are free to use them
+in a single player game if that’s what you fancy ;) ).

README.md

@@ -0,0 +1,5 @@
+# The SpatialOS GDK for Unity Blank Project readme (alpha)
+
+This is a blank project that you can use to build your own game with the [SpatialOS GDK for Unity](https://github.com/spatialos/gdk-for-unity).
+
+© 2018 Improbable

cloud_launch.json

@@ -0,0 +1,39 @@
+{
+  "template": "small",
+  "world": {
+    "chunkEdgeLengthMeters": 50,
+    "snapshots": {
+      "snapshotWritePeriodSeconds": 0
+    },
+    "dimensions": {
+      "xMeters": 5000,
+      "zMeters": 5000
+    }
+  },
+  "workers": [
+    {
+      "worker_type": "UnityGameLogic",
+      "permissions": [
+        {
+          "all": {}
+        }
+      ],
+      "load_balancing": {
+        "auto_hex_grid": {
+          "num_workers": 2
+        }
+      }
+    },
+    {
+      "worker_type": "UnityClient",
+      "permissions": [
+        {
+          "all": {}
+        }
+      ],
+      "load_balancing": {
+        "singleton_worker": {}
+      }
+    }
+  ]
+}

default_launch.json

@@ -0,0 +1,37 @@
+{
+  "template": "small",
+  "world": {
+    "chunkEdgeLengthMeters": 50,
+    "snapshots": {
+      "snapshotWritePeriodSeconds": 0
+    },
+    "dimensions": {
+      "xMeters": 5000,
+      "zMeters": 5000
+    }
+  },
+  "workers": [
+    {
+      "worker_type": "UnityGameLogic",
+      "permissions": [
+        {
+          "all": {}
+        }
+      ],
+      "load_balancing": {
+        "singleton_worker": {}
+      }
+    },
+    {
+      "worker_type": "UnityClient",
+      "permissions": [
+        {
+          "all": {}
+        }
+      ],
+      "load_balancing": {
+        "singleton_worker": {}
+      }
+    }
+  ]
+}

gdk.pinned

@@ -0,0 +1 @@
+0.1.1

scripts/powershell/setup.ps1

@@ -0,0 +1,91 @@
+$ErrorActionPreference = "Stop"
+
+function Select-Clone-Method
+{
+    $HTTPS_URI = "https://github.com/spatialos/gdk-for-unity.git"
+    $SSH_URI = "[email protected]:spatialos/gdk-for-unity.git"
+
+    Write-Host @"
+Select a cloning method.
+
+Press 1 for HTTPS ($($HTTPS_URI))
+Press 2 for SSH   ($($SSH_URI))
+Press 3 to Quit
+"@
+
+    do 
+    {
+        $Selection = Read-Host "Please make a selection "
+        switch ($Selection)
+        {
+            '1' {
+                return $HTTPS_URI
+            }
+            '2' {
+                return $SSH_URI
+            }
+        }
+    }
+    until ($selection -eq '3')
+
+    return -1
+}
+
+Write-Host @"
+
+Welcome to the SpatialOS GDK for Unity Blank Project setup script.
+"@
+
+$TargetDirectory = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($PSScriptRoot + "/../../../gdk-for-unity")
+
+Write-Warning @"
+
+This script will create the following directory to set up the SpatialOS GDK for Unity: $($TargetDirectory)
+*** If such a directory already exists it will be deleted. ***
+Are you ready to proceed? (y/n)
+"@
+$Confirmation = Read-Host
+
+if ($Confirmation -ne 'y')
+{
+    Write-Host "Stopping the setup process."
+    exit 0
+}
+
+$CloneUri = Select-Clone-Method
+
+if ($CloneUri -eq -1)
+{
+    Write-Host "Stopping the setup process."
+    exit 0
+}
+
+if (Test-Path -Path $TargetDirectory)
+{
+    Write-Host "Deleting existing directory at $($TargetDirectory)..." -ForegroundColor Yellow
+    Remove-Item $TargetDirectory -Force -Recurse
+}
+
+Write-Host "Cloning SpatialOS GDK for Unity" -ForegroundColor Yellow
+& git clone $CloneUri $TargetDirectory
+
+if ($LastExitCode -ne 0)
+{
+    exit 1
+} 
+
+$PinnedVersion = Get-Content ($PSScriptRoot + "/../../gdk.pinned")
+
+Write-Host "Checking out pinned version: $($PinnedVersion)" -ForegroundColor Yellow
+
+Push-Location -Path "$TargetDirectory"
+    & git checkout "$PinnedVersion"
+    
+    if ($LastExitCode -ne 0)
+    {
+        Pop-Location
+        exit 1
+    } 
+Pop-Location
+
+Write-Host "Finished!" -ForegroundColor Green

scripts/shell/setup.sh

@@ -0,0 +1,88 @@
+#!/usr/bin/env bash
+# -ET: propagate DEBUG/RETURN/ERR traps to functions and subshells
+# -e: exit on unhandled error
+# pipefail: any failure in a pipe causes the pipe to fail
+set -eET -o pipefail
+[[ -n "${DEBUG:-}" ]] && set -x
+
+LOG_SUCCESS='\033[0;32m'
+LOG_WARNING='\033[1;33m'
+LOG_EMPHASIS='\033[0;36m'
+NO_COLOR='\033[0m'
+
+echo_with_color()
+{
+    echo -e "${2}${1}${NO_COLOR}"
+}
+
+echo ""
+echo "Welcome to the SpatialOS GDK for Unity Blank Project setup script." 
+echo ""
+
+readonly RAW_DIR="$(dirname "${0}")/../../../gdk-for-unity"
+
+# Workaround for lack of realpath by default on MacOS
+#   1. Create the directory is it doesn't exist
+#   2. pushd there and record the directory through pwd
+#   3. This gives you a nice resolved path.
+mkdir -p "${RAW_DIR}"
+pushd "${RAW_DIR}" > /dev/null
+    readonly TARGET_DIRECTORY=$(pwd)
+popd > /dev/null
+
+echo_with_color "This script will create the following directory: ${TARGET_DIRECTORY}" "${LOG_WARNING}"
+echo_with_color "*** If such a directory already exists it will be deleted. ***" "${LOG_EMPHASIS}"
+echo_with_color "Are you ready to proceed? (y/n)" "${LOG_WARNING}"
+
+read -r -p "" response
+if [[ "${response}" =~ ^([yY][eE][sS]|[yY])+$ ]]
+then
+    echo "" > /dev/null
+else
+    echo "Stopping the setup process."
+    exit 0
+fi
+
+HTTPS_URI="https://github.com/spatialos/gdk-for-unity.git"
+SSH_URI="[email protected]:spatialos/gdk-for-unity.git"
+
+PS3="Please make a selection: "
+echo "Select a cloning method."
+echo ""
+HTTPS_OPTION="HTTPS (${HTTPS_URI})"
+SSH_OPTION="SSH   (${SSH_URI})"
+options=("${HTTPS_OPTION}" "${SSH_OPTION}" "Quit")
+select opt in "${options[@]}"
+do
+    case ${opt} in
+        "${HTTPS_OPTION}")
+            CLONE_URI=${HTTPS_URI}
+            break
+            ;;
+        "${SSH_OPTION}")
+            CLONE_URI=${SSH_URI}
+            break
+            ;;
+        "Quit")
+            echo "Stopping the setup process."
+            exit 0
+            ;;
+        *) echo "Invalid option ${REPLY}";;
+    esac
+done
+
+if [[ -d "${TARGET_DIRECTORY}" ]]; then
+    echo_with_color "Deleting existing directory at ${TARGET_DIRECTORY}..." "${LOG_WARNING}"
+    rm -rf "${TARGET_DIRECTORY}"
+fi
+
+echo "Cloning SpatialOS GDK for Unity"
+git clone ${CLONE_URI} "${TARGET_DIRECTORY}"
+
+PINNED_VERSION=$(cat "$(dirname "${0}")/../../gdk.pinned")
+
+pushd "${TARGET_DIRECTORY}"
+    git checkout "${PINNED_VERSION}"
+popd
+
+echo_with_color "Finished!" "${LOG_SUCCESS}"