- LICENSE: Use of the contents of this repository is subject to the license
The SpatialOS Game Development Kit (GDK) for Unreal is an Unreal Engine fork and plugin with associated projects. It gives you the features of SpatialOS, within the familiar workflows and APIs of Unreal Engine. For more information, please see the GDK's documentation website.
The SpatialOS GDK for Unreal is in alpha. It is ready to use for development of single-server games, but not recommended for public releases. We are committed to rapid development of the GDK to provide a performant release - for information on this, see our development roadmap and Unreal features support pages, and contact us via our forums, or on Discord.
This is the repository for the Example Project, an example shooter game that uses the GDK.
In addition to the Example Project, the GDK also contains:
-
The SpatialOS Unreal Engine fork
You must be a member of the Epic Games organization on GitHub to access this. If you aren't, the link returns a 404 error.
The Example Project contains gameplay and assets that are representative of a basic first-person shooter running on SpatialOS. If you want to make your own project from scratch, use the Starter Template by following the Starter Template guide in the GDK for Unreal documentation.
For setup instructions, follow the Example Project guide in the GDK for Unreal documentation.
For more information, see the SpatialOS GDK for Unreal documentation.
The following controls are bound in-game, for gameplay and testing.
| Key Binding | Function |
|---|---|
| W,A,S,D | Standard movement |
| Space | Jump |
| Shift | Sprint |
| Left Click | Fire |
| Number keys 1 - 0 | Select weapon |
This repository contains a set of helper scripts to get you started.
| Helper script | Description |
|---|---|
LaunchSpatial.bat |
Starts a local SpatialOS deployment with the default launch configuration. |
LaunchServer.bat |
Starts an Unreal server-worker, and connects it to the local deployment. |
LaunchClient.bat |
Starts an Unreal client-worker, and connects it to the local deployment. |
ProjectPaths.bat |
Used by the LaunchClient.bat, LaunchServer.bat and LaunchSpatial.bat to specify the project environment when those scripts are run |
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 - Forums - GitHub issues in this repository.
We are not currently accepting public contributions. However, we are accepting issues and we do want your feedback.
© 2019 Improbable