diff --git a/README.md b/README.md index 1c8506a..31dbd7b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ -# Starter Project ---- +# SpatialOS Unity SDK Starter Project -*Copyright (C) 2017 Improbable Worlds Limited. All rights reserved.* -- *GitHub repository*: [https://github.com/spatialos/StarterProject](https://github.com/spatialos/StarterProject) +- *GitHub repository*: [github.com/spatialos/StarterProject](https://github.com/spatialos/StarterProject) + ---- ## Introduction -This is a SpatialOS starter project with useful core features that you can extend to build your own SpatialOS application. +This is a [SpatialOS](https://docs.improbable.io/reference/latest/shared/concepts/spatialos) starter project to use with the [Unity SDK](https://github.com/spatialos/UnitySDK) with useful core features that you can extend to build your own SpatialOS application. It contains: @@ -19,8 +17,18 @@ It contains: If you run into problems, or want to give us feedback, please visit the [SpatialOS forums](https://forums.improbable.io/). +--- +**New from June 2018: The SpatialOS Unity GDK**
+Check out the pre-alpha release of our new Unity GDK: [source code on GitHub](http://github.com/spatialos/UnityGDK). Using the Unity Entity Component System (ECS), the GDK is the next evolution in SpatialOS Unity game development. See our [blog post on ECS-powered multiplayer](https://improbable.io/games/blog/unity-gdk-our-first-steps) for more information.

+**Note:** The pre-alpha GDK version is available for evaluation and feedback only. It's not yet game-development ready. + +---- + ## Running the project 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://docs.improbable.io/reference/13.0/shared/deploy/deploy-local) 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 `, and finally deploy it with `spatial cloud launch --snapshot=`. 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/13.0/shared/deploy/deploy-cloud) for more details. + +---- +*Copyright (C) 2017 Improbable Worlds Limited. All rights reserved.* \ No newline at end of file