Skip to content

acoross/UnityGDK

 
 

Repository files navigation

The SpatialOS Unity GDK readme (pre-alpha)

Welcome to the SpatialOS and Unity GDK community.

Our SpatialOS community shapes the functionality of the Unity GDK, so make sure you are part of the conversation. Come and find us on Discord or talk to us on the feedback section in our forums (use the unity-gdk tag - this link takes you there and pre-fills the category and tag).

What's the Unity GDK all about?

The Unity Game Development Kit (GDK) enables game developers to build multiplayer games with SpatialOS. It will be made up of three parts:

  • the GDK Core, a performant, data-driven SpatialOS multiplayer integration based on the new Unity Entity Component System (ECS).

  • a library of solutions for hard or common networked game development problems via Feature Modules.

  • the example game, which both tests and demonstrates the Feature Modules; for use as a starting point or resource for game development.

In the future you will be able to use the Unity GDK to make multiplayer games with Unity and SpatialOS. This is a pre-alpha release of the GDK Core which is the foundation of the product (currently it's Windows only but later releases will also support MacOS). To find out more see the Unity GDK blogpost.

You can sign up for SpatialOS Unity GDK updates direct to your mailbox.

Recommended use

This pre-alpha version software and its documentation is, by its very nature, rough and ready; every part of it is subject to change, including the APIs, and it isn’t optimised for performance. In addition, the GDK is based on Unity’s experimental Entity Component System and Job System. Currently it's Windows only but later releases will also support MacOS.

This release is for evaluation and feedback only, with limited documentation; we aren’t supporting any game development on the pre-alpha version of the Unity GDK.

Who is it for?

This pre-alpha release is for experienced Unity developers who have some understanding of SpatialOS concepts, are interested in Unity's Entity Component System, and want to give early feedback.

Installation and setup

For prerequisites, installation and setup, see the Installation and setup documentation.

Questions?

Check out our FAQs or head over to our discussion forums, listed below.

Give us feedback

We have released the Unity 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. You may need to grab Discord here.

The SpatialOS forums
Visit the feedback section in our forums and use the unity-gdk tag. This link takes you there and pre-fills the category and tag.

Github issues
Create an issue in this repository.

Contributions

Public contributors
We are not currently accepting public contributions - see our contributions policy. However, we are accepting issues and we do want your feedback.

Improbable developers
See the Contributions guide.

Documentation

See the documentation in this GitHub repository.

Support

We are not supporting the pre-alpha release for game development, as this version is for evaluation only. However, please give us your feedback.

Migration from the SpatialOS Unity SDK

Currently the Unity GDK is in its early development, so there is no migration path from the Unity SDK to the Unity GDK. There will be a migration path in later releases.

Roadmap

See the latest roadmap Trello board and let us know what you'd like to see in there.

Email updates

You can sign up for SpatialOS Unity GDK updates direct to your mailbox.

© 2018 Improbable

Releases

No releases published

Packages

No packages published

Languages

  • C# 97.9%
  • Shell 1.3%
  • PowerShell 0.8%