diff --git a/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/FallbackIndentLevelScope.cs b/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/FallbackIndentLevelScope.cs deleted file mode 100644 index 182f797..0000000 --- a/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/FallbackIndentLevelScope.cs +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright (c) Improbable Worlds Ltd, All Rights Reserved - -#if !UNITY_2017_3_OR_NEWER -using System; -using UnityEditor; - -namespace Improbable.Unity.MinimalBuildSystem.Configuration -{ - /// - /// Fallback for Unity 2017.3f1 feature: EditorGUI.IndentLevelScope - /// - public class FallbackIndentLevelScope : IDisposable - { - private readonly int indent; - - public FallbackIndentLevelScope(int increment) - { - indent = EditorGUI.indentLevel; - EditorGUI.indentLevel += indent; - } - - public void Dispose() - { - EditorGUI.indentLevel = indent; - } - } -} -#endif diff --git a/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/FallbackIndentLevelScope.cs.meta b/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/FallbackIndentLevelScope.cs.meta deleted file mode 100644 index 87422a5..0000000 --- a/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/FallbackIndentLevelScope.cs.meta +++ /dev/null @@ -1,13 +0,0 @@ -fileFormatVersion: 2 -guid: ad8fd511165f02a4b87eba70852032fe -timeCreated: 1516634254 -licenseType: Pro -MonoImporter: - externalObjects: {} - serializedVersion: 2 - defaultReferences: [] - executionOrder: 0 - icon: {instanceID: 0} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/SpatialOSBuildConfigurationEditor.cs b/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/SpatialOSBuildConfigurationEditor.cs index 00e64c4..f38d617 100644 --- a/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/SpatialOSBuildConfigurationEditor.cs +++ b/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/SpatialOSBuildConfigurationEditor.cs @@ -409,11 +409,7 @@ private static void SwapInList(IList list, int indexA, int indexB) private static IDisposable IndentLevelScope(int increment) { -#if UNITY_2017_3_OR_NEWER return new EditorGUI.IndentLevelScope(increment); -#else - return new FallbackIndentLevelScope(increment); -#endif } } } diff --git a/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/WorkerBuildData.cs b/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/WorkerBuildData.cs index 79d783a..ab6fbdb 100644 --- a/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/WorkerBuildData.cs +++ b/Assets/Plugins/Improbable/.Modules/MinimalBuildSystem/Editor/Configuration/WorkerBuildData.cs @@ -9,12 +9,7 @@ namespace Improbable.Unity.MinimalBuildSystem.Configuration { public class WorkerBuildData { - internal const BuildTarget OSXBuildTarget = -#if UNITY_2017_3_OR_NEWER - BuildTarget.StandaloneOSX; -#else - BuildTarget.StandaloneOSXIntel64; -#endif + internal const BuildTarget OSXBuildTarget = BuildTarget.StandaloneOSX; private readonly WorkerPlatform workerPlatform; private readonly BuildTarget buildTarget; diff --git a/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.dll.meta b/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.dll.meta index cf343ad..7a5af20 100644 --- a/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.dll.meta +++ b/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.dll.meta @@ -1,7 +1,5 @@ fileFormatVersion: 2 -guid: 38634bd06f0d74b9fbb7b77b2a08b5d0 -timeCreated: 1527179045 -licenseType: Pro +guid: f44fb4b626fe048998e488cfd2923afe PluginImporter: externalObjects: {} serializedVersion: 2 diff --git a/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.xml.meta b/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.xml.meta index 93b66cc..087474d 100644 --- a/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.xml.meta +++ b/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.Framework.xml.meta @@ -1,7 +1,5 @@ fileFormatVersion: 2 -guid: 8afb126da30e84bc58795da5a9707494 -timeCreated: 1527179057 -licenseType: Pro +guid: 3814222838dbb497b92c44beb19b01f1 TextScriptImporter: externalObjects: {} userData: diff --git a/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.dll.meta b/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.dll.meta index bea2ba8..04bcedc 100644 --- a/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.dll.meta +++ b/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.dll.meta @@ -1,7 +1,5 @@ fileFormatVersion: 2 -guid: f50f3aee2e72440c190d326f6bbc58b0 -timeCreated: 1527179045 -licenseType: Pro +guid: 7752f3da0b6ef45b9bdd962b12aaf6ac PluginImporter: externalObjects: {} serializedVersion: 2 diff --git a/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.xml.meta b/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.xml.meta index 2f179dd..14bf5e4 100644 --- a/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.xml.meta +++ b/Assets/Plugins/Improbable/Sdk/Dll/Improbable.WorkerSdkCsharp.xml.meta @@ -1,7 +1,5 @@ fileFormatVersion: 2 -guid: 316c715d468cf44e6be0a43c27cfe5f5 -timeCreated: 1527179057 -licenseType: Pro +guid: 138032453b3de44b6a1cb0f47d379d98 TextScriptImporter: externalObjects: {} userData: diff --git a/Assets/Plugins/Improbable/Sdk/Src/Editor/Build/DefaultPlayerBuildConfiguration.cs b/Assets/Plugins/Improbable/Sdk/Src/Editor/Build/DefaultPlayerBuildConfiguration.cs index 06ad55a..330e42b 100644 --- a/Assets/Plugins/Improbable/Sdk/Src/Editor/Build/DefaultPlayerBuildConfiguration.cs +++ b/Assets/Plugins/Improbable/Sdk/Src/Editor/Build/DefaultPlayerBuildConfiguration.cs @@ -32,11 +32,7 @@ internal static PlayerBuildConfiguation Generate() Targets = new List { BuildTarget.StandaloneWindows.ToString(), -#if UNITY_2017_3_OR_NEWER BuildTarget.StandaloneOSX.ToString() -#else - BuildTarget.StandaloneOSXIntel64.ToString() -#endif } } }, diff --git a/Assets/Plugins/Improbable/Sdk/Src/Editor/Build/UnityPlayerBuilder.cs b/Assets/Plugins/Improbable/Sdk/Src/Editor/Build/UnityPlayerBuilder.cs index 494f60d..01d6929 100644 --- a/Assets/Plugins/Improbable/Sdk/Src/Editor/Build/UnityPlayerBuilder.cs +++ b/Assets/Plugins/Improbable/Sdk/Src/Editor/Build/UnityPlayerBuilder.cs @@ -8,6 +8,9 @@ using Improbable.Unity.EditorTools.Util; using Improbable.Unity.Util; using UnityEditor; +#if UNITY_2018_1_OR_NEWER +using UnityEditor.Build.Reporting; +#endif using UnityEngine; namespace Improbable.Unity.EditorTools.Build @@ -51,15 +54,6 @@ private static BuildTarget ToRuntimePlatform(string platform) if (platform.ToLower() != "current") { var value = (BuildTarget) Enum.Parse(typeof(BuildTarget), platform); -#if UNITY_2017_3_OR_NEWER -#pragma warning disable 618 - if (value == BuildTarget.StandaloneOSXIntel64) - { - Debug.LogWarningFormat("{0} is deprecated and will be removed. Please update {1} to use {2} instead.", BuildTarget.StandaloneOSXIntel64, UnityPlayerBuilders.PlayerConfigurationFilePath, BuildTarget.StandaloneOSX); - value = BuildTarget.StandaloneOSX; - } -#pragma warning restore 618 -#endif return value; } @@ -73,11 +67,7 @@ internal static BuildTarget CurrentPlatform() case RuntimePlatform.WindowsEditor: return BuildTarget.StandaloneWindows; case RuntimePlatform.OSXEditor: -#if UNITY_2017_3_OR_NEWER return BuildTarget.StandaloneOSX; -#else - return BuildTarget.StandaloneOSXIntel64; -#endif case RuntimePlatform.LinuxEditor: return BuildTarget.StandaloneLinux64; default: @@ -120,11 +110,7 @@ internal string AssemblyDirectory { switch (BuildTarget) { -#if UNITY_2017_3_OR_NEWER case BuildTarget.StandaloneOSX: -#else - case BuildTarget.StandaloneOSXIntel64: -#endif { return PathUtil.Combine(PackagePath, string.Format("{0}.app", PackageName), "Contents", "Resources", "Data", "Managed"); } @@ -202,11 +188,7 @@ private static PlatformData CreatePlatformData(BuildTarget buildTarget) return new PlatformData("Managed", "Windows", "_Data", ".exe"); case BuildTarget.StandaloneWindows64: return new PlatformData("Managed", "Windows", "_Data", ".exe"); -#if UNITY_2017_3_OR_NEWER case BuildTarget.StandaloneOSX: -#else - case BuildTarget.StandaloneOSXIntel64: -#endif return new PlatformData("Contents/Data/Managed", "Mac", ".app", ""); case BuildTarget.StandaloneLinux64: return new PlatformData("Managed", "Linux", "_Data", ""); @@ -228,12 +210,19 @@ internal void BuildPlayer() var playerOptions = new BuildPlayerOptions { target = BuildTarget, locationPathName = tempExecutablePath, options = options, scenes = scenes }; var buildErrorMessage = BuildPipeline.BuildPlayer(playerOptions); +#if UNITY_2018_1_OR_NEWER + if (buildErrorMessage.summary.result != BuildResult.Succeeded) + { + throw new ApplicationException(string.Format("Failed to build player {0} due to {1} errors", BuildConfigComment, + buildErrorMessage.summary.totalErrors)); + } +#else if (!string.IsNullOrEmpty(buildErrorMessage)) { throw new ApplicationException(string.Format("Failed to build player {0} due to {1}", BuildConfigComment, buildErrorMessage)); } - +#endif Debug.LogFormat("Built player {0} into {1}", BuildConfigComment, PackagePath); } diff --git a/Assets/Plugins/Improbable/Sdk/Src/Editor/Core/SpatialOsWindow.cs b/Assets/Plugins/Improbable/Sdk/Src/Editor/Core/SpatialOsWindow.cs index 3a6e21e..9c6ceea 100644 --- a/Assets/Plugins/Improbable/Sdk/Src/Editor/Core/SpatialOsWindow.cs +++ b/Assets/Plugins/Improbable/Sdk/Src/Editor/Core/SpatialOsWindow.cs @@ -16,8 +16,8 @@ namespace Improbable.Unity.EditorTools [InitializeOnLoad] public class SpatialOsWindow : EditorWindow { - private const string MinVersion = "5.6.0"; - private const string MaxVersion = "2017.3.0"; + private const string MinVersion = "2017.3.0"; + private const string MaxVersion = "2018.1.3"; private static SharedGuiContent sharedContent; private static string versionMessage; diff --git a/Assets/Plugins/Improbable/Sdk/Src/Editor/PrefabExport/EntityPrefabExporter.cs b/Assets/Plugins/Improbable/Sdk/Src/Editor/PrefabExport/EntityPrefabExporter.cs index ee1fce4..e1bbd6f 100644 --- a/Assets/Plugins/Improbable/Sdk/Src/Editor/PrefabExport/EntityPrefabExporter.cs +++ b/Assets/Plugins/Improbable/Sdk/Src/Editor/PrefabExport/EntityPrefabExporter.cs @@ -20,13 +20,7 @@ public class EntityPrefabExporter { { BuildTarget.StandaloneWindows, Platform.BuildPlatform.Windows }, { BuildTarget.StandaloneWindows64, Platform.BuildPlatform.Windows }, -#if UNITY_2017_3_OR_NEWER { BuildTarget.StandaloneOSX, Platform.BuildPlatform.OSX }, -#else - { BuildTarget.StandaloneOSXIntel, Platform.BuildPlatform.OSX }, - { BuildTarget.StandaloneOSXIntel64, Platform.BuildPlatform.OSX }, - { BuildTarget.StandaloneOSXUniversal, Platform.BuildPlatform.OSX }, -#endif { BuildTarget.StandaloneLinux, Platform.BuildPlatform.Linux }, { BuildTarget.StandaloneLinux64, Platform.BuildPlatform.Linux }, { BuildTarget.iOS, Platform.BuildPlatform.iOS } diff --git a/docs/assets/setup/setup-unity-build-support-mac.png b/docs/assets/setup/setup-unity-build-support-mac.png deleted file mode 100644 index 02c7238..0000000 Binary files a/docs/assets/setup/setup-unity-build-support-mac.png and /dev/null differ diff --git a/docs/assets/setup/setup-unity-build-support-win.png b/docs/assets/setup/setup-unity-build-support-win.png deleted file mode 100644 index c531445..0000000 Binary files a/docs/assets/setup/setup-unity-build-support-win.png and /dev/null differ diff --git a/docs/assets/setup/setup-unity-just-build-support-win.png b/docs/assets/setup/setup-unity-just-build-support-win.png deleted file mode 100644 index 514bc99..0000000 Binary files a/docs/assets/setup/setup-unity-just-build-support-win.png and /dev/null differ diff --git a/docs/get-started/requirements.md b/docs/get-started/requirements.md index e5ffaf5..c850c01 100644 --- a/docs/get-started/requirements.md +++ b/docs/get-started/requirements.md @@ -9,7 +9,7 @@ Up-to-date versions of Windows 7 and 10 work with SpatialOS. | Required for | | | --- | --- | | All SpatialOS development | `spatial` CLI ([download directly](setup/win.md#2-set-up-the-spatialos-cli))
PowerShell 3.0 and later / Windows Command Prompt / Git BASH (For local deployments, you must use PowerShell or Command Prompt.)
[Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-gb/download/details.aspx?id=48145) | -| [Unity SDK](../introduction.md) | [Unity 2017.3.0](https://unity3d.com/get-unity/download/archive), including `Linux Build Support` and `Mac Build Support`
Unity versions **5.6.0** and **2017.3.0** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. | +| [Unity SDK](../introduction.md) | [Unity 2018.1.3](https://unity3d.com/get-unity/download/archive), including `Linux Build Support` and `Mac Mono Scripting Backend Support`
Unity versions **2017.3.0** and **2018.1.3** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. | You can find installation instructions for the basic requirements in the [setup guide for Windows](setup/win.md). @@ -20,23 +20,10 @@ Up-to-date versions of macOS Sierra, El Capitan and High Sierra work with Spati | Required for | | | --- | --- | | All SpatialOS development | `spatial` CLI [download directly](setup/mac.md#2-set-up-the-spatialos-cli)
Any Bash terminal | -| [Unity SDK](../introduction.md) | [Unity 2017.3.0](https://unity3d.com/get-unity/download/archive), including `Linux Build Support` and `Windows Build Support` | +| [Unity SDK](../introduction.md) | [Unity 2018.1.3](https://unity3d.com/get-unity/download/archive), including `Linux Build Support` and `Windows Build Support` | You can find installation instructions for the basic requirements in the [setup guide for macOS](setup/mac.md). -### Linux requirements - -Major distributions (e.g,. Ubuntu, Fedora, CentOS) on machines with an AMD64 processor should work with the C++, C# and Java SDKs. The Launcher will not work. - -Unity themselves only experimentally support Linux. - -| Required for | | -| --- | --- | -| All SpatialOS development | `spatial` CLI ([download directly](setup/linux.md#2-set-up-the-spatialos-cli))
Any Bash terminal | -| [Unity SDK](../introduction.md) | You can try [experimental Unity 2017.3.0](https://forum.unity3d.com/threads/unity-on-linux-release-notes-and-known-issues.350256/#post-3017538)
[Mono latest](http://www.mono-project.com/docs/getting-started/install/linux/) | - -You can find installation instructions for the basic requirements in the [setup guide for Linux](setup/linux.md). - ### Browsers To access the Console and Inspector, you'll need one of the following: diff --git a/docs/get-started/setup/linux.md b/docs/get-started/setup/linux.md deleted file mode 100644 index 8ffa6ce..0000000 --- a/docs/get-started/setup/linux.md +++ /dev/null @@ -1,55 +0,0 @@ -> SpatialOS only works with Linux experimentally. The Launcher does not work -on Linux. - -# Setup guide for Linux - -This guide will prepare your machine for local development with the SpatialOS SDK. - -> **Note**: You need to [have access to SpatialOS](https://spatialos.improbable.io/get-spatialos) to download the SDK. - -## 1. System requirements - -Before following the setup guide check that your machine meets the -[hardware requirements](../../get-started/requirements.md#linux-requirements). - -## 2. Set up the SpatialOS `spatial` CLI - -To set up the `spatial` CLI (`spatial`): - -0. Download the `spatial` CLI for Linux (64bit): [Improbable GitHub Spatial CLI download for Linux](https://console.improbable.io/toolbelt/download/latest/linux). - - By downloading `spatial`, you agree to the [SpatialOS EULA](https://auth.improbable.io/auth/v1/eula). -2. Put `spatial` in a directory. - - For example, `bin` in your home directory: `mkdir -p $HOME/bin && mv $HOME/Downloads/spatial $HOME/bin`. -3. Add the directory to your `PATH`. -4. Make sure `spatial` is executable: run `chmod +x `. -0. Check this succeeded by running `spatial update` in your terminal. You should get the output: - - `Current version of the 'spatial' command-line tool: ` - - `Attempting to download the latest version...` - -## 3. Set up Unity (unsupported) - -> Note that Unity only 'experimentally' supports Linux, so you're in a real den -of dragons if you decide to play around with this! - -Install Unity version **2017.3.0**: - -1. Go to the [experimental Unity build for -2017.3.0](https://forum.unity3d.com/threads/unity-on-linux-release-notes-and-known-issues.350256/#post-3017538). -2. Download the installer of your choice. -3. Run the installer. -4. Install Unity into the directory `/opt/Unity`. - - [`spatial worker build` (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/spatial-cli/spatial-worker-build) expects to find Unity in this directory. -5. Set the environment variable `UNITY_HOME` to `/opt/Unity`. -6. Launch Unity and complete the registration process. - -> Some users have found, to get Unity to work, they need to install Postgres -(`sudo apt-get install libpq5`). - -## Next steps - -You've now set up your experimental Linux development environment with SpatialOS! diff --git a/docs/get-started/setup/mac-alternative.md b/docs/get-started/setup/mac-alternative.md deleted file mode 100644 index d7d2ef2..0000000 --- a/docs/get-started/setup/mac-alternative.md +++ /dev/null @@ -1,181 +0,0 @@ -# Alternative setup steps for macOS - -If you don't want to use the [installer](../../get-started/setup/mac.md) to set up your Mac for development with SpatialOS, you can either: - -* use [Homebrew](#set-up-your-machine-using-homebrew) -* set up your machine [manually](#set-up-your-machine-manually) - -> You need to [have access to SpatialOS](https://spatialos.improbable.io/get-spatialos) to download the SDK. - -## Set up your machine using Homebrew - -### 1. System requirements - -We support up-to-date versions of macOS Sierra, El Capitan and High Sierra. - -Before following the setup guide check that your machine meets the -[hardware requirements](../../get-started/requirements.md#hardware). - -> If you’re using a corporate network with a strict firewall, raise a [support request](https://improbableio.atlassian.net/servicedesk/customer/portal/5) (for customers with a service agreement) or ask on our [forums](https://forums.improbable.io) and we’ll take you through some custom setup steps. - -### 2. Set up the `spatial` CLI - -To set up the `spatial` CLI (`spatial`), and other prerequisites for the next step: - -1. Install the Homebrew package manager. - - ``` - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - ``` - -1. In a terminal, run: - - ``` - brew tap caskroom/cask - brew tap improbable-io/spatialos - brew update - brew cask install spatial - ``` - - By installing `spatial`, you agree to the [SpatialOS EULA](https://auth.improbable.io/auth/v1/eula). - -1. Check this succeeded by running `spatial update` in your terminal. You should get the output: - - `Current version of the 'spatial' command-line tool: ` - - `Attempting to download the latest version...` - -> Permission denied? -> -> This is because the `spatial` command-line tool isn't executable. Try this: -> -> 1. Run `which spatial` to get the path to `spatial`. -> 2. Run `chmod +x `. This will make the tool executable. -> -> For example, `chmod +x /usr/local/bin/spatial` - -### 3. Set up Unity - -To use the Unity SDK, **even if you've already got Unity installed**, -you **must** follow these steps, because SpatialOS only supports specific versions of Unity, and -requires specific build support. - -> Unity versions **5.6.0** and **2017.3.0** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. - -1. Choose one of the options below: - - * **If you already have Unity 2017.3.0 installed**: - - In a terminal, run the following: - - ``` - brew cask install unity-ios-support-for-editor@2017.3.0 - brew cask install unity-linux-support-for-editor@2017.3.0 - brew cask install unity-windows-support-for-editor@2017.3.0 - ``` - - * **If you have another version of Unity**, or don't have it installed at all: - - In a terminal, run the following: - - ``` - brew cask install unity@2017.3.0 - brew cask install unity-ios-support-for-editor@2017.3.0 - brew cask install unity-linux-support-for-editor@2017.3.0 - brew cask install unity-standard-assets@2017.3.0 - brew cask install unity-windows-support-for-editor@2017.3.0 - ``` - - This installs Unity in the default installation directory, `/Applications/Unity`. - - If you want to use more than one version of Unity, you must: - - 1. Rename this directory (for example, `mv /Applications/Unity /Applications/Unity2017.3.0`). - This path cannot have spaces in it. - 1. Set the `UNITY_HOME` environment variable to point at your chosen Unity installation. - -1. Launch Unity and complete the registration process. - -### 4. (optional) Install the Launcher - -If you want to run a game client to connect to a SpatialOS game running in the cloud, you must install the [Launcher](https://docs.improbable.io/reference/13.0/shared/operate/launcher). - -1. Download the Launcher. -2. Follow the instructions in the installation wizard. - -## Set up your machine manually - -### 1. System requirements - -We support up-to-date versions of macOS Sierra, El Capitan and High Sierra. - -Before following the setup guide check that your machine meets the -[hardware requirements](../../get-started/requirements.md#hardware). - -> If you’re using a corporate network with a strict firewall, raise a [support request](https://improbableio.atlassian.net/servicedesk/customer/portal/5) (for customers with a service agreement) or ask on our [forums](https://forums.improbable.io) and we’ll take you through some custom setup steps. - -### 2. Set up the `spatial` CLI - -To set up the `spatial` CLI (`spatial`): - -1. Download `spatial` for macOS (64bit): Download. - - By downloading `spatial`, you agree to the [SpatialOS EULA](https://auth.improbable.io/auth/v1/eula). -1. Put `spatial` in a directory. - - For example, `bin` in your home directory: `mkdir -p $HOME/bin && mv $HOME/Downloads/spatial $HOME/bin`. -1. Add the directory to your `PATH`. To do so: - - 1. Open a terminal window. - 1. Move into home directory: run `cd`. - 1. Determine which configuration file to use (you will need to know your configuration file again in later steps): run `ls -a ~` - - * If you have a `.bash_profile`, that's your configuration file. - * Otherwise, if you have a `.bash_login`, that's your configuration file. - * Otherwise, if you have a `.profile`, that's your configuration file. - * If you don't have any of these files, you can use `.bash_profile` (which you'll create in the next step). - 1. Add the location of spatial to the `PATH` variable: run `echo 'export PATH=$PATH:/path_to_spatial_here' >> ~/your_config_file_here` - - For example: `echo 'export PATH=$PATH:$HOME/bin' >> ~/.bash_profile` -1. Make sure `spatial` is executable: run `chmod +x /path_to_spatial_here`. -1. Restart your terminal window to register the changes made to the path. -1. Check this succeeded by running `spatial update` in your terminal. You should get the output: - - `Current version of the 'spatial' command-line tool: ` - - `Attempting to download the latest version...` - -### 3. (optional) Set up Unity - -To use the Unity SDK, **even if you've already got Unity installed**, -you **must** follow these steps, because SpatialOS only supports specific versions of Unity, and -requires specific build support. - -> Unity versions **5.6.0** and **2017.3.0** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. - -Install Unity version **2017.3.0** and the optional extras that SpatialOS requires: - -1. Go to the [Unity Download Archive](https://unity3d.com/get-unity/download/archive). -1. Next to version 2017.3.0, from the "Downloads (Mac)" dropdown, select "Unity Installer". -1. Run the installer. In addition to the defaults, select `Linux Build Support` and `Windows Build Support`: - - ![Unity screenshot](../../assets/setup/setup-unity-build-support-mac.png) - -1. Install Unity into the default installation directory. - - Alternatively, you can set the environment variable `UNITY_HOME` to your customized Unity installation folder. -For example, if you installed Unity to `/Applications/Unity2017.3.0`, -then set `UNITY_HOME` to `/Applications/Unity2017.3.0`. __This path cannot have spaces in it.__ - -1. Launch Unity and complete the registration process. - -> **Important**: Once you've set up a project, you'll need to set the path to `spatial` from the SpatialOS window in the Unity Editor. -See the [Unity SpatialOS window](../../reference/spatialos-window.md#settings) page for instructions. - -### 4. (optional) Install the Launcher - -If you want to run a game client to connect to a SpatialOS game running in the cloud, you must install the -[Launcher](https://docs.improbable.io/reference/13.0/shared/operate/launcher). - -1. Download the Launcher. -1. Follow the instructions in the installation wizard. \ No newline at end of file diff --git a/docs/get-started/setup/mac.md b/docs/get-started/setup/mac.md index 2ccf39c..70ae683 100644 --- a/docs/get-started/setup/mac.md +++ b/docs/get-started/setup/mac.md @@ -1,48 +1,30 @@ # Setup guide for macOS -## 1. System requirements +> Unity versions **2017.3.0** and **2018.1.3** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. -SpatialOS works with up-to-date versions of macOS Sierra, El Capitan and High Sierra. +## 1. Set up SpatialOS -Before following the setup guide check that your machine meets the -[hardware requirements](../../get-started/requirements.md#hardware). +Follow the [SpatialOS setup guide](https://docs.improbable.io/reference/13.0/shared/get-started/setup/mac). -> If you’re using a corporate network with a strict firewall, raise a [support request](https://improbableio.atlassian.net/servicedesk/customer/portal/5) (for customers with a service agreement) or ask on our [forums](https://forums.improbable.io) and we’ll take you through some custom setup steps. - -## 2. Install SpatialOS - -Download the [SpatialOS installer](https://console.improbable.io/installer/download/stable/latest/mac) and follow the steps. - -This installs: - -* the `spatial` CLI -* the SpatialOS Launcher - -> If you don’t want to set up SpatialOS using the installer, see the [alternative setup steps for macOS](../../get-started/setup/mac-alternative.md). - -## 3. Set up Unity +## 2. Set up Unity To use the Unity SDK, **even if you've already got Unity installed**, you **must** follow these steps, because SpatialOS only works with specific versions of Unity, and requires specific build support. -> Unity versions **5.6.0** and **2017.3.0** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. - -Install Unity version **2017.3.0** and the optional extras that SpatialOS requires: - 1. Go to the [Unity Download Archive](https://unity3d.com/get-unity/download/archive). -2. Next to version 2017.3.0, from the "Downloads (Mac)" dropdown, select "Unity Installer". -3. Run the installer. In addition to the defaults, select `Linux Build Support` and `Windows Build Support`: - - ![Unity screenshot](../../assets/setup/setup-unity-build-support-mac.png) +1. Next to version 2018.1.3, from the "Downloads (Mac)" dropdown, select "Unity Installer". +1. Run the installer. In addition to the defaults, select + * [x] `Linux Build Support` + * [X] `Windows Mono Scripting Backend Support` -4. Install Unity into the default installation directory. +1. Install Unity into the default installation directory. Alternatively, you can set the environment variable `UNITY_HOME` to your customized Unity installation folder. -For example, if you installed Unity to `/Applications/Unity2017.3.0`, -then set `UNITY_HOME` to `/Applications/Unity2017.3.0`. + For example, if you installed Unity to `/Applications/Unity2018.1.3`, + then set `UNITY_HOME` to `/Applications/Unity2018.1.3`. -5. Launch Unity and complete the registration process. +1. Launch Unity and complete the registration process. > **Important**: Once you've set up a project, you'll need to set the path to `spatial` from the SpatialOS window in the Unity Editor. See the [Unity SpatialOS window](../../reference/spatialos-window.md#settings) page for instructions. @@ -52,4 +34,4 @@ See the [Unity SpatialOS window](../../reference/spatialos-window.md#settings) p You've now set up your machine for development with SpatialOS! To learn how to use SpatialOS and experiment with its main APIs, try the -[Pirates tutorial](../../tutorials/pirates/overview.md). \ No newline at end of file +[Pirates tutorial](../../tutorials/pirates/overview.md). diff --git a/docs/get-started/setup/win-alternative.md b/docs/get-started/setup/win-alternative.md deleted file mode 100644 index 5fe68c8..0000000 --- a/docs/get-started/setup/win-alternative.md +++ /dev/null @@ -1,161 +0,0 @@ -# Alternative setup steps for Windows - -If you don't want to use the [installer](../../get-started/setup/win.md) to set up your Windows machine for development with SpatialOS, you can either: - -* use [Chocolatey](#set-up-your-machine-using-chocolatey) -* set up your machine [manually](#set-up-your-machine-manually) - -> You need to [have access to SpatialOS](https://spatialos.improbable.io/get-spatialos) to download the SDK. - -## Set up your machine using Chocolatey - -### 1. System requirements - -We support up-to-date versions of Windows 7 and 10. - -Before following the setup guide check that your machine meets the -[hardware requirements](../../get-started/requirements.md#hardware). - -> If you’re using a corporate network with a strict firewall, raise a [support request](https://improbableio.atlassian.net/servicedesk/customer/portal/5) (for customers with a service agreement) or ask on our [forums](https://forums.improbable.io) and we’ll take you through some custom setup steps. - -### 2. Set up the `spatial` CLI - -To set up the `spatial` CLI (`spatial`): - -1. Install Chocolatey, the package manager, following the instructions at -chocolatey.org/install. - -1. Open a terminal (PowerShell or cmd) and run: - - ``` - choco install spatial --yes - ``` - - This will install the CLI and put it in your `PATH`. By installing it, - you agree to the [SpatialOS EULA](https://auth.improbable.io/auth/v1/eula). - -1. Close and re-open your console, then check the install succeeded by running `spatial update` in your terminal. You should get the output: - - `Current version of the 'spatial' command-line tool: ` - - `Attempting to download the latest version...` - - -### 3. Set up Unity - -To use the Unity SDK, **even if you've already got Unity installed**, -you **must** follow these steps, because SpatialOS only supports specific versions of Unity, and -requires specific build support. - -> Unity versions **5.6.0** and **2017.3.0** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. - -1. Choose one of the options below: - - * **If you already have Unity 2017.3.0 installed**: - - In a terminal, run the following commands to install Unity build support for Linux and Mac, and MSVC - Redistributable: - - ``` - spatial setup install-dependencies --sdk-version=13.0 - choco install --yes unity-linux --version 2017.3.0 - choco install --yes unity-mac --version 2017.3.0 - ``` - - * **If you have another version of Unity**, or don't have it installed at all: - - In a terminal, run the following command to install Unity 2017.3.0, - and MSVC Redistributable: - - ``` - spatial setup install-dependencies --sdk-version=13.0 --with_unity - ``` - - By running these commands you agree with the individual terms of each separate dependency. - - Run `spatial setup install-dependencies --sdk-version=13.0 --help` - for more information. - -1. Restart your computer to complete the install process. - -1. If you didn't already have Unity installed, run it and register or activate your license. - -### 4. (optional) Install the Launcher - -If you want to run a game client to connect to a SpatialOS game running in the cloud, you must install the -[Launcher](https://docs.improbable.io/reference/13.0/shared/operate/launcher). - -1. Download the Launcher. -1. Follow the instructions in the installation wizard. - -## Set up your machine manually - -### 1. System requirements - -We support up-to-date versions of Windows 7 and 10. - -Before following the setup guide check that your machine meets the -[hardware requirements](../../get-started/requirements.md#hardware). - -> If you’re using a corporate network with a strict firewall, raise a [support request](https://improbableio.atlassian.net/servicedesk/customer/portal/5) (for customers with a service agreement) or ask on our [forums](https://forums.improbable.io) and we’ll take you through some custom setup steps. - -### 2. Set up the `spatial` CLI - -To set up the `spatial` CLI (`spatial`): - -1. Download `spatial` for Windows (64bit): Download. - - By downloading `spatial`, you agree to the [SpatialOS EULA](https://auth.improbable.io/auth/v1/eula). -1. Put `spatial.exe` in a directory where you have *administrator privileges*. -1. Add the directory containing `spatial.exe` to your `PATH` by following -[these instructions](https://www.java.com/en/download/help/path.xml). - -1. Check this succeeded by running `spatial update` in your terminal. You should get the output: - - `Current version of the 'spatial' command-line tool: ` - - `Attempting to download the latest version...` - -### 3. Set up Unity - -To use the Unity SDK, **even if you've already got Unity installed**, -you **must** follow these steps, because SpatialOS only supports specific versions of Unity, and -requires specific build support. - -> Unity versions **5.6.0** and **2017.3.0** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. - -1. If you haven’t got it installed already, download and install [Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-gb/download/details.aspx?id=48145). - > We recommend you download both the x64 and x86 versions of the the Visual C++ Redistributable. The Unity Editor requires x64, and the Wizards demo and Pirates tutorial produce 32-bit workers by default (which require x86). - -1. Go to the [Unity Download Archive](https://unity3d.com/get-unity/download/archive). -1. Next to version 2017.3.0, from the "Downloads (Win)" dropdown, click "Unity Installer" -(which downloads the installer). -1. Run the installer. - - * **If you already have Unity 2017.3.0 installed**: - - Select `Linux Build Support` and `Mac Build Support`. De-select all the other checkboxes: - - ![Unity screenshot](../../assets/setup/setup-unity-just-build-support-win.png) - - * **If you have another version of Unity**, or don't have it installed at all: - - **IMPORTANT**: In addition to the defaults, select `Linux Build Support` and `Mac Build Support`: - - ![Unity screenshot](../../assets/setup/setup-unity-build-support-win.png) - -1. Install Unity into the default installation directory: `%PROGRAMFILES%\Unity`. - - Alternatively, you can set the environment variable `UNITY_HOME` to your customized Unity installation folder. - For example, if you installed Unity to `C:\Unity 2017.3.0`, then set `UNITY_HOME` - to `C:\Unity 2017.3.0`. - -1. Launch Unity and complete the registration process. - -### 4. (optional) Install the Launcher - -If you want to run a game client to connect to a SpatialOS game running in the cloud, you must install the -[Launcher (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#launcher). - -1. [Download the Launcher](https://console.improbable.io/launcher/download/stable/latest/win). -1. Follow the instructions in the installation wizard. \ No newline at end of file diff --git a/docs/get-started/setup/win.md b/docs/get-started/setup/win.md index 90cea69..56d8d90 100644 --- a/docs/get-started/setup/win.md +++ b/docs/get-started/setup/win.md @@ -1,61 +1,28 @@ # Setup guide for Windows -This guide will prepare your Windows machine for local development with the SpatialOS SDK. +> Unity versions **2017.3.0** and **2018.1.3** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. -## 1. System requirements +## 1. Set up SpatialOS -SpatialOS works with up-to-date versions of Windows 7 and 10. +Follow the [SpatialOS setup guide](https://docs.improbable.io/reference/13.0/shared/get-started/setup/win). -Before following the setup guide check that your machine meets the -[hardware requirements](../../get-started/requirements.md#hardware). - -> If you’re using a corporate network with a strict firewall, raise a [support request](https://improbableio.atlassian.net/servicedesk/customer/portal/5) (for customers with a service agreement) or ask on our [forums](https://forums.improbable.io) and we’ll take you through some custom setup steps. - -## 2. Install SpatialOS - -Download the [SpatialOS installer](https://console.improbable.io/installer/download/stable/latest/win) and follow the steps. - -This installs: - -* the `spatial` CLI -* the SpatialOS Launcher - -> If you don’t want to set up SpatialOS using the installer, see the [alternative setup steps for Windows](../../get-started/setup/win-alternative.md). - -## 3. Set up Unity +## 2. Set up Unity To use the Unity SDK, **even if you've already got Unity installed**, -you **must** follow these steps, because SpatialOS only works with specific versions of Unity, and -requires specific build support. - -> Unity versions **5.6.0** and **2017.3.0** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. - -1. If you haven’t got it installed already, download and install [Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-gb/download/details.aspx?id=48145). - > We recommend you download both the x64 and x86 versions of the the Visual C++ Redistributable. The Unity Editor requires x64, and the Wizards demo - and Pirates tutorial produce 32-bit workers by default (which require x86). +you **must** follow these steps, because SpatialOS only works with specific versions of Unity, and requires specific build support. 1. Go to the [Unity Download Archive](https://unity3d.com/get-unity/download/archive). -1. Next to version 2017.3.0, from the "Downloads (Win)" dropdown, click "Unity Installer" +1. Next to version 2018.1.3, from the "Downloads (Win)" dropdown, click "Unity Installer" (which downloads the installer). 1. Run the installer. - - * **If you already have Unity 2017.3.0 installed**: - - Select `Linux Build Support` and `Mac Build Support`. De-select all the other checkboxes: - - ![Unity screenshot](../../assets/setup/setup-unity-just-build-support-win.png) - - * **If you have another version of Unity**, or don't have it installed at all: - - **IMPORTANT**: In addition to the defaults, select `Linux Build Support` and `Mac Build Support`: - - ![Unity screenshot](../../assets/setup/setup-unity-build-support-win.png) +2. **IMPORTANT**: In addition to the defaults, select + * [x] `Linux Build Support` + * [x] `Mac Mono Scripting Backend Support` 1. Install Unity into the default installation directory: `%PROGRAMFILES%\Unity`. Alternatively, you can set the environment variable `UNITY_HOME` to your customized Unity installation folder. - For example, if you installed Unity to `C:\Unity 2017.3.0`, then set `UNITY_HOME` - to `C:\Unity 2017.3.0`. + For example, if you installed Unity to `C:\Unity 2018.1.3`, then set `UNITY_HOME` to `C:\Unity 2018.1.3`. 1. Launch Unity and complete the registration process. diff --git a/docs/introduction.md b/docs/introduction.md index 98eceaa..b7e50b1 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -4,21 +4,20 @@ > You need to set up SpatialOS before you can work on a project using the SpatialOS Unity SDK. To set up SpatialOS, download and set up the `spatial` CLI. For more information, see the setup guides: [Windows](get-started/setup/win.md), -[macOS](get-started/setup/mac.md), -[Linux](get-started/setup/linux.md). +[macOS](get-started/setup/mac.md). You can use the game engine [Unity](https://unity3d.com/) as a [worker (SpatialOS documentation)](https://docs.improbable.io/reference/13.0/shared/glossary#worker) in a SpatialOS project, to add physics, game logic, and visualization to a SpatialOS simulated world. We provide a Unity SDK to make it easier to use Unity as a worker. -> **Compatible Unity versions**: Unity versions **5.6.0** and **2017.3.0** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. +> **Compatible Unity versions**: Unity versions **2017.3.0** and **2018.1.3** have been tested with SpatialOS. Other versions may work fine, but have not been extensively tested. **License** * See the [license](../LICENSE.md). **Documentation** * The SpatialOS documentation is on the [SpatialOS documentation website](https://docs.improbable.io). -* The Unity SDK documentation is on [GitHub](start-here-table-of-contents.md). +* The Unity SDK documentation is on [GitHub](start-here-table-of-contents.md). ## The relationship between SpatialOS and Unity diff --git a/docs/reference/project-anatomy.md b/docs/reference/project-anatomy.md index 2cea775..669fd9c 100644 --- a/docs/reference/project-anatomy.md +++ b/docs/reference/project-anatomy.md @@ -10,8 +10,8 @@ running `spatial build`. Set the `UNITY_HOME` environment variable to the folder For example: - * On Windows, set `UNITY_HOME` to `C:\Program Files\Unity 2017.3.0`. - * On macOS, set `UNITY_HOME` `/Applications/Unity2017.3.0`. __This path cannot contain any spaces.__ + * On Windows, set `UNITY_HOME` to `C:\Program Files\Unity 2018.1.3`. + * On macOS, set `UNITY_HOME` `/Applications/Unity2018.1.3`. __This path cannot contain any spaces.__ ## Directory structure diff --git a/docs/releases/release-notes.md b/docs/releases/release-notes.md index cb0451b..d234055 100644 --- a/docs/releases/release-notes.md +++ b/docs/releases/release-notes.md @@ -1,14 +1,24 @@ # Release notes +## SpatialOS Unity SDK 2.0.0 +_Released: 2018-06-06_ + +### New features +* We have added support for Unity 2018.1.3. + +### Breaking changes +* We have removed support for Unity 5.6 and below. The minimum version supported is now 2017.3.0. +* We have removed the `Improbable.Unity.MinimalBuildSystem.Configuration.FallbackIndentLevelScope` class, +which provided backwards compatibility with Unity 5.6 and below. +In the unlikely event that you've used this class, please use `UnityEditor.EditorGUI.IndentLevelScope` instead. It should drop into place with no other changes necessary. +* We have removed the Unity 5.6 build target `StandaloneOSXIntel64` in `player-build-config.json`. +You should change this to `StandaloneOSX`. + ## SpatialOS Unity SDK 1.0.1 _Released: 2018-05-24_ - ### Fixes * Deregistering a command response twice will no longer throw an exception. * When a user exits a game while trying to connect, the connection failure callback reason now says "An application quit signal was received." Previously the reason was blank. * The worker now sends component updates correctly including when its authority loss is imminent. - - - diff --git a/docs/start-here-table-of-contents.md b/docs/start-here-table-of-contents.md index ac1684d..8706631 100644 --- a/docs/start-here-table-of-contents.md +++ b/docs/start-here-table-of-contents.md @@ -29,7 +29,6 @@ have a combined SpatialOS and SpatialOS Unity SDK bundle. To get the separated v - Setup guides - [Windows](get-started/setup/win.md) - [macOS](get-started/setup/mac.md) - - [Linux](get-started/setup/linux.md) - [System requirements](get-started/requirements.md) ### Learning - [Learning resources](tutorials/learning-resources.md) diff --git a/docs/unity-ios/introduction.md b/docs/unity-ios/introduction.md index b89da3d..840abd8 100644 --- a/docs/unity-ios/introduction.md +++ b/docs/unity-ios/introduction.md @@ -1,5 +1,7 @@ > Building Unity iOS workers is experimental. +> iOS support has not been tested with Unity 2018.x. + # Unity iOS Building Unity client workers for iOS platforms is experimental. @@ -8,7 +10,7 @@ You can run your SpatialOS Unity client workers on both iOS devices and simulato ## Requirements * At least MacOS 10.12.6 (Sierra) and with Xcode 9 installed. -* Unity 2017.3.0 installed. +* Unity 2018.1.3 installed. * "iOS Build Support" installed as an additional Unity component (specified when you install Unity). * Active enrolment in the [Apple Developer Program for iOS](https://developer.apple.com/programs/), either as a team or as an individual. @@ -33,4 +35,4 @@ See how to resolve these issues in our ## Getting started The next section describes the steps required to getting with -[using SpatialOS with Unity iOS builds](../unity-ios/using.md). \ No newline at end of file +[using SpatialOS with Unity iOS builds](../unity-ios/using.md). diff --git a/docs/unity-ios/using.md b/docs/unity-ios/using.md index 75398ab..0a98f66 100644 --- a/docs/unity-ios/using.md +++ b/docs/unity-ios/using.md @@ -1,7 +1,9 @@ > Building Unity iOS workers is experimental. +> iOS support has not been tested with Unity 2018.x. + # Building for iOS targets in Unity - + This page describes the required steps for a SpatialOS Unity project to build for iOS build targets. It assumes that you have an existing SpatialOS project, which you are intending to add iOS support using Unity. While following this guide, you will adjust some of the SpatialOS scripts and Unity settings to prepare everything for iOS. This is needed to ensure that the Xcode project contains the necessary code to run your iOS worker successfully. The resulting Xcode project suffers from cyclic dependencies due to a bug in Unity and we provide you with a script to fix this. @@ -175,7 +177,7 @@ The following build settings are recommended for compatibility with SpatialOS. 1. Configure `Other Settings` with the following settings: + Configuration: * Scripting Backend: `IL2CPP` - * API Compatibility Level: `.NET 2.0` + * API Compatibility Level: `.NET 2.0` * Target SDK: `Device SDK` or `Simulator SDK` * Target minimum iOS Version: `10.2` or higher * Allow downloads over HTTP (nonsecure): Checked