From c38820ccb630d89b92f3ccc7b4f6c0eead9e30c8 Mon Sep 17 00:00:00 2001 From: Laura Date: Thu, 7 Oct 2021 11:39:47 +0100 Subject: [PATCH] Upate to readme file (#1506) Co-authored-by: Jamie Brynes --- README.md | 63 ++++++------------------------------------- developer-information | 25 +++++++++++++++++ 2 files changed, 33 insertions(+), 55 deletions(-) create mode 100644 developer-information diff --git a/README.md b/README.md index 61b91b100d..aaf2acee00 100644 --- a/README.md +++ b/README.md @@ -4,69 +4,22 @@ The SpatialOS Game Development Kit (GDK) for Unity allows you to quickly and easily build and host Unity multiplayer games. These games can use multiple server-side game engines across one seamless world to create new kinds of gameplay. -If you're a Unity game developer and ready to try out the GDK, follow the [Get started guide](https://documentation.improbable.io/gdk-for-unity/docs/get-started). +This is the repository for the last version of the GDK plugin that is compatible with the SpatialOS legacy platform. The GDK is frozen for users who have not yet migrated their project to SpatialOS running on zeuz. -> The SpatialOS GDK for Unity is in alpha. We are committed to rapid development of the GDK to improve stability, usability, and performance - for information on this, see our [development roadmap](https://github.com/spatialos/gdk-for-unity/projects/1) and contact us via our [forums](https://forums.improbable.io/latest?tags=unity-gdk), or on [Discord](https://discord.gg/SCZTCYm). Sign up to our [mailing list](http://go.pardot.com/l/169082/2018-06-25/27mhsb) to get updates about the GDK for Unity. +* If you have a current project using SpatialOS GDK for Unity and would like to discuss migrating your project to SpatialOS running on zeuz, please contact us at migration@improbable.io before 30th December 2021. -## Developing on the GDK +* If you would like to start development of your game on SpatialOS and would like access to the latest version of the GDK for Unity and are not currently using SpatialOS please contact us at [ims.improbable.io/contact](https://ims.improbable.io/contact) with details about your project. -We recommend that you start developing with the [**Blank Starter Project**](https://github.com/spatialos/gdk-for-unity-blank-project) or the [**First Person Shooter (FPS) Starter Project**](https://github.com/spatialos/gdk-for-unity-fps-starter-project/). -If you'd like to develop on this repository, there is a little bit of additional setup: +## Documentation -### Developer dependencies +Find high-level documentation about SpatialOS and the GDKs at [networking.docs.improbable.io](https://networking.docs.improbable.io). If you wish to get full access to the documentation please contact us at [ims.improbable.io/contact](https://ims.improbable.io/contact) with details about your project. -In addition to the dependencies listed [here](https://documentation.improbable.io/gdk-for-unity/docs/setup-and-dependencies#section-4-install-the-gdk-dependencies), you will need the following programs present on your `PATH`: - -* [`jq`](https://stedolan.github.io/jq/) - -### Setup - -1. Checkout this repository. -2. Run `init.sh` or `init.ps1` to download the dependencies. -3. Open the Unity project in `workers/unity`. - -> **Why do I need to hit init?** -> -> As of [release 0.2.5](https://github.com/spatialos/gdk-for-unity/releases/tag/0.2.5), we publish the dependencies as UPM (NPM) packages. This repository contains the source for these packages, but dependencies such as the Worker SDK and schema standard library are not committed to the repository. `init.sh`/`init.ps1` downloads these dependencies and puts them in the correct place. -> -> If you fail to run `init.sh`/`init.ps1` before opening Unity, Unity _will_ delete the `.meta` files associated with the files downloaded by `init.sh`/`init.ps1`. If this happens to you, run `git reset --hard` to reset the repostory back to a good state. Note that this is a destructive `git` operation, so any un-committed changes will be lost. - -## Having problems? - -* [Documentation](https://documentation.improbable.io/gdk-for-unity/docs/welcome) -* [Troubleshooting](https://documentation.improbable.io/gdk-for-unity/docs/troubleshooting) -* [Known issues](https://github.com/spatialos/gdk-for-unity/projects/2) - -If you are unable to resolve your issue, please raise an issue [in this repository](https://github.com/spatialos/gdk-for-unity/issues) or find us on the [forums](https://forums.improbable.io/latest?tags=unity-gdk) or [Discord](https://discord.gg/SCZTCYm). - -## Recommended use - -This is the alpha release of the SpatialOS GDK for Unity. We invite projects to start using it but warn that all APIs are subject to change as we learn from feedback. - -## Give us feedback - -We have released the GDK this early in development because we want your feedback. Please come and talk to us about the software and the documentation via: - -* **Discord** - - Find us in the [**#unity** channel](https://discord.gg/SCZTCYm). You may need to grab Discord [here](https://discordapp.com). - -* **The SpatialOS forums** - - Visit the **feedback** section in our [forums](https://forums.improbable.io) and use the `unity-gdk` tag. [This link](https://forums.improbable.io/new-topic?category=Feedback&tags=unity-gdk) takes you there and pre-fills the category and tag. - -* **Github issues** - - Create an issue [in this repository](https://github.com/spatialos/gdk-for-unity/issues). +--- -## Contributions +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. -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. +© 2021 Improbable ---- -* Version: [alpha](https://documentation.improbable.io/spatialos-overview/docs/release-policies) -* 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. -© 2020 Improbable diff --git a/developer-information b/developer-information new file mode 100644 index 0000000000..45e536e0d3 --- /dev/null +++ b/developer-information @@ -0,0 +1,25 @@ +![](spatialos_gdk_for_unity_header.png) + +## Developing on the GDK + +We recommend that you start developing with the [**Blank Starter Project**](https://github.com/spatialos/gdk-for-unity-blank-project) or the [**First Person Shooter (FPS) Starter Project**](https://github.com/spatialos/gdk-for-unity-fps-starter-project/). + +If you'd like to develop on this repository, there is a little bit of additional setup: + +### Developer dependencies + +In addition to the dependencies listed [here](https://documentation.improbable.io/gdk-for-unity/docs/setup-and-dependencies#section-4-install-the-gdk-dependencies), you will need the following programs present on your `PATH`: + +* [`jq`](https://stedolan.github.io/jq/) + +### Setup + +1. Checkout this repository. +2. Run `init.sh` or `init.ps1` to download the dependencies. +3. Open the Unity project in `workers/unity`. + +> **Why do I need to hit init?** +> +> As of [release 0.2.5](https://github.com/spatialos/gdk-for-unity/releases/tag/0.2.5), we publish the dependencies as UPM (NPM) packages. This repository contains the source for these packages, but dependencies such as the Worker SDK and schema standard library are not committed to the repository. `init.sh`/`init.ps1` downloads these dependencies and puts them in the correct place. +> +> If you fail to run `init.sh`/`init.ps1` before opening Unity, Unity _will_ delete the `.meta` files associated with the files downloaded by `init.sh`/`init.ps1`. If this happens to you, run `git reset --hard` to reset the repostory back to a good state. Note that this is a destructive `git` operation, so any un-committed changes will be lost. \ No newline at end of file