|
1 |
| -# The SpatialOS GDK for Unity Blank Starter Project |
| 1 | +<div align="center"> |
| 2 | + <img src="./.github/readme-header.png" width="450" /> |
2 | 3 |
|
3 |
| -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). |
| 4 | + <h1>The GDK for Unity Blank Project</h1> |
4 | 5 |
|
5 |
| -## Prerequisites |
| 6 | + <p> |
| 7 | + <strong>A blank starter project for the <a href="https://github.com/spatialos/gdk-for-unity">GDK for Unity.</a></strong> |
| 8 | + </p> |
6 | 9 |
|
7 |
| -Before using this project, make sure to follow the [setup guide](https://documentation.improbable.io/gdk-for-unity/docs/setup-and-dependencies). |
| 10 | + <p> |
| 11 | + <img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg"/> |
| 12 | + <img alt="Build status" src="https://badge.buildkite.com/708ac824cba2fd9db027ac8bafe4ab3f230a5d46d0ef336d45.svg?branch=develop"/> |
| 13 | + <a href="https://github.com/spatialos/gdk-for-unity-blank-project/releases"><img alt="Current release" src="https://img.shields.io/github/release/spatialos/gdk-for-unity-blank-project.svg"/></a> |
| 14 | + </p> |
8 | 15 |
|
9 |
| -## Setup |
| 16 | + <h4> |
| 17 | + <a href="https://documentation.improbable.io/gdk-for-unity/docs/blank-project-tutorial-overview">Tutorial</a> |
| 18 | + <span> | </span> |
| 19 | + <a href="https://github.com/spatialos/gdk-for-unity-blank-project/blob/master/CHANGELOG.md">Changelog</a> |
| 20 | + </h4> |
| 21 | +</div> |
10 | 22 |
|
11 |
| -1. Checkout this repository. |
12 |
| -2. Open the Unity project. |
| 23 | +# About |
13 | 24 |
|
14 |
| -© 2020 Improbable |
| 25 | +This is a blank project that you can use to as a base for your own game with the [SpatialOS GDK for Unity](https://github.com/spatialos/gdk-for-unity). It has the GDK boilerplate required to start developing games for SpatialOS: |
| 26 | + |
| 27 | +- A Unity project already setup with the [SpatialOS GDK for Unity](https://github.com/spatialos/gdk-for-unity). |
| 28 | +- Sample [deployment](https://documentation.improbable.io/gdk-for-unity/docs/gdk-glossary#section-deploying) configurations for local and cloud. |
| 29 | +- [Client-worker and server-worker](https://documentation.improbable.io/gdk-for-unity/docs/gdk-glossary#section-worker) JSON [configuration files](https://documentation.improbable.io/spatialos-overview/docs/spl-worker-configuration-file). |
| 30 | +- Client-worker and server-worker [connectors](https://documentation.improbable.io/gdk-for-unity/docs/worker-connectors) & worker prefabs. |
| 31 | +- A set of Unity Scenes to use in development. |
| 32 | +- [Build configuration](https://documentation.improbable.io/gdk-for-unity/docs/your-unity-project-2-build-your-workers) with sensible defaults. |
| 33 | +- An empty [snapshot](https://documentation.improbable.io/gdk-for-unity/docs/snapshots) and stub code for generating new snapshots in the Unity Editor. |
| 34 | + |
| 35 | +## Contributions |
| 36 | + |
| 37 | +We are not currently accepting public contributions - see our [contributions](https://documentation.improbable.io/gdk-for-unity/docs/contribution-policy-on-github) policy. However, we are accepting issues and will gratefully appreciate your feedback. |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +* 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. |
| 42 | + |
| 43 | +© 2020 Improbable |
0 commit comments