Skip to content

Latest commit

 

History

History
57 lines (33 loc) · 5.63 KB

README.md

File metadata and controls

57 lines (33 loc) · 5.63 KB

SpatialOS Unreal GDK Example Project

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

This project requires the Online Services (available here) in order for the party and deployment connection systems to work. Follow the Quickstart guide to set these up. We also recommend using a deployment pool to manage your deployments, available from here.

We provide a custom matcher here to replace the default SampleMatcher contained in the Online Services. This exists as Matcher.cs in this directory, to use this matcher instead of the default then replace the services/csharp/SampleMatcher/Matcher.cs in the online-services repository.

Database Sync Worker

The Database Sync Worker is included as a submodule located within spatial/workers/database-sync-worker. Go to this directory and initialise the submodule by doing git submodule init then git submodule update. Once the submodule has been initialised copy spatial/provided/spatialos.DatabaseSyncWorker.worker.json into spatial/workers/database-sync-worker, as the Database Sync Worker uses a different SpatialOS project layout than the GDK. Make sure that the submodule has checked out the release tag 0.1.0 rather then master branch.

For the Database Sync Worker to work you will need to set up a Postgres database, ideally within the same Google Cloud Project as the Online Services. If you want to configure the worker connect to a remote hosted ProgrestSQL instance, check here.

You may need to install .NET Core 2.2.402 if you haven't already got it installed.

Player Authentication

In this project we give examples of how to authenticate a player account via both Google and PlayFab, with the latter linking directly to our Online Services. Google authentication is handled by a plugin included with Unreal Engine, however you will need to create credentials within your Google Cloud Project which the client can use. These can be created from the GCP menu via APIs & Services > Credentials.

For PlayFab, we have modified the PlayFab marketplace plugin to support necessary functionality for our Google login flow. The modified plugin is available in this GitHub Repo, you will need to include the 4.22 version of the plugin within the Game/Plugins directory.

Configuration

There are some values in the game configuration files which will need to be filled in with details once the Online Services Quickstart has been completed. These can be found here, in a section which looks like this:

[/Script/GDKShooter.OnlineServicesLibrary]
PlayFabTitleID=<your playfab title id>
PlayFabSecretKey=<your playfab secret key>
GoogleCloudProjectID=<your google cloud project id>

[OnlineSubsystemGoogle]
bEnabled=true
ClientId=<your client id>
ClientSecret=<your client secret>

You will need to replace these values with your PlayFab game, GCP project, and GCP credentials created in the steps outlined above.

Current Matcher Issues:

The matcher can match players into games that are in-progress.

This is because the matcher has no communication from the game server of what state the match is in. The Unreal GDK currently cannot set any deployment tags or worker flags which would let the matcher know this information and relies on an external solution instead. One possible implementation would be to replace the Deployment Pool currently used with the currently unsupported Deployment Manager which can be set up to communicate with the game server and update deployment tags accordingly (e.g. status_lobby, status_ingame, etc). The matcher logic could then be easily modified to only look for deployments in a certain game state. The game mode logic would likely need to be modified to wait for more players before automatically starting a game so the matcher has time to fill up the deployment.

The game server currently doesn't know which players are in which party.

While every player in the same party will be put into the same match, the game server doesn't know which players belong in which party and assigns them to teams individually. One potential solution for this is for the matcher to maintain a data structure of parties in each match which it then assigns to a worker flag. The Unreal GDK can get (but not set) worker flags through the Worker SDK so it would be able to use this flag to determine which parties should be kept together. The worker flags must be set by the matcher before the deployment is assigned to players so the game server has the information before any clients connect.

Public contributors

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

© 2019 Improbable