Permalink
Switch branches/tags
Find file Copy path
84 lines (57 sloc) 6.63 KB

The SpatialOS GDK for Unreal (pre-alpha)

Welcome to the SpatialOS and GDK for Unreal community.

Our SpatialOS community shapes the functionality of the GDK for Unreal, 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 unreal-gdk tag - this link takes you there and pre-fills the category and tag). You can also sign up for SpatialOS GDK for Unreal updates direct to your mailbox.

What's the GDK for Unreal all about?

The SpatialOS GDK for Unreal is an Unreal Engine 4 (UE4) plugin made by Improbable. You can use the GDK for Unreal to integrate persistent multiplayer worlds into your Unreal game using the SpatialOS platform. Find out more about the GDK for Unreal in our blogpost.

Documentation

Recommended use

We are releasing the GDK in pre-alpha so we can react to feedback and iterate on development quickly. To facilitate this, during our pre-alpha stage we don't have a formal deprecation cycle for APIs and workflows. This means that everything and anything can change. In addition, documentation is limited and some aspects of the GDK are not optimized.

Given this, we don’t recommend using the the GDK for Unreal for games in the production phase just yet.

Who is it for?
We recommend you start using the GDK if:

  • You don’t mind the rough edges and are interested in contributing to the GDK (see our contributions policy).
  • You want to start evaluating the GDK or prototyping on it for a future project.

Although every feature you need to build your optimal SpatialOS game may not be ready yet, this is a great time to get involved and shape the GDK for Unreal. We are committed to improving the GDK rapidly, aiming for an alpha release in Fall 2018.

Feature List

See the full feature list for what is supported in the GDK for Unreal.

Give us feedback

We have released the GDK for Unreal 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 #unreal channel. You may need to grab Discord here.

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

GitHub issues
Create an issue in this repository.

Where to get the GDK and starter projects

The GDK and its starter projects are available on GitHub.

Installation and setup

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

Known issues

See the Known issues documentation.

Contributions

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

Troubleshooting

Run into problems? See the troubleshooting documentation.

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.

Roadmap

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

Unreal Engine changes

In order to transform Unreal from a single server engine to a distributed model, we had to make a small number of changes to UE4 code. We will attempt to consolidate and remove (or submit as PR to Epic) as many of these changes as possible. You can see the changes in our forked Unreal Engine repo, 4.20-SpatialOSUnrealGDK branch.

You may get a 404 error from this link. To get access, see these instructions.

Email updates

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

(c) 2018 Improbable