improbable-eng / ims-unreal-demo

Demo of IMS features (zeuz, Matchmaking, Session Manager) in Unreal sample game.

IMS Unreal Demo Game

Overview

This demo game was adapted from the Unreal Engine ShooterGame and is built in UE 4.27. The goal is to demonstrate:

1. How to support IMS zeuz orchestration in your game.
2. How to integrate IMS Session Manager functionality into your game.

Table of Contents

1 - Support IMS Zeuz orchestration in your game

• Hosting your game on IMS zeuz
  1. Set Payload to Ready upon Initialization
  2. Publish image to IMS Image Manager
  3. Create allocation
  4. Reserve and join a game
  5. Next steps
• Server Waiting & Shutdown
  1. Server Waiting
  2. Server Shutdown

2 - Integrate IMS Session Manager functionality into your game

• Before Getting Started
• Connecting players to IMS Session Manager (Client-Side)
  1. Authenticate players with PlayFab
  2. Generate Session Manager API Client with OpenAPI
  3. Allow players to create sessions
  4. Allow players to browse sessions
  5. Allow players to join sessions
  6. Set Project Id and Session Type from the CLI
  7. Next steps
• Configuring your game server to work with IMS Session Manager (Server-Side)
  1. Check for payload status updates
  2. Shutdown server if no players join a reserved session
  3. Retrieve session config and apply to the game server
  4. Set session status
• Conclusion

Before Getting Started

Before getting started, please read through the IMS documentation. Follow the tutorial to run your first game server to familiarize yourself with IMS. Each section addresses a different behaviour missing from the unmodified ShooterGame project. You should use this project as an example of what changes you need to make to your game to support IMS services.

Lastly, if you are following along, making similar changes to the ShooterGame project, then you should first ensure that you are able to package the unmodified game as a dedicated server and connect with a client. There is an Unreal Engine tutorial for this. To run the dedicated server, you can run the command ShooterServer.exe /Game/Maps/Sanctuary -log, which by default will run your game on port 7777. Similarly, the client can be run with ShooterClient.exe -log.

In order to start, you must already have:

• An IMS project
• An account linked to IMS,
• The IMS CLI downloaded
• IMS zeuz cluster.

If you do not have any of these please reach out on your Improbable Slack channel.