Skip to content

spatialos/UnrealGDKReferenceProject

Repository files navigation

SpatialOS Unreal GDK Example Project

  • LICENSE: Use of the contents of this repository is subject to the license

This project is an example shooter game which uses the SpatialOS GDK for Unreal.

The 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.

For setup instructions, follow the Example Project guide in the GDK for Unreal documentation.

To setup the required Online Services with custom matchmaking, see the instructions in the CustomMatcher folder.

For more information, see the SpatialOS GDK for Unreal documentation.

Game controls

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

Helper scripts

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

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 - Forums - GitHub issues in this repository.

Where to get the GDK and related projects

The GDK and related projects are available on GitHub.

Public contributors

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

© 2019 Improbable

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published