Skip to content
This repository was archived by the owner on Dec 5, 2018. It is now read-only.

Added info about and link to Unity GDK #9

Merged
merged 2 commits into from
Jun 22, 2018
Merged

Added info about and link to Unity GDK #9

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
179d3a4
Added to Unity GDK
ElleEss Jun 22, 2018
fc34d67
Typo fix
ElleEss Jun 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/UnityGDK) with useful core features that you can extend to build your own SpatialOS application.
Copy link

@anne-edwards anne-edwards Jun 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the second link here should go to /spatialoos/UnitySDK, rather than UnityGDK?

Copy link
Contributor Author

@ElleEss ElleEss Jun 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! Got GDK on brain! Thanks.

Copy link
Contributor Author

@ElleEss ElleEss Jun 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


It contains:

Expand All @@ -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**<br/>
Check out the pre-alpha release of our new Unity GDK: [source code on GitHub](https://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.<br/><br/>
**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 <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/13.0/shared/deploy/deploy-cloud) for more details.

----
*Copyright (C) 2017 Improbable Worlds Limited. All rights reserved.*