Add FlexMatch to a game client - Amazon GameLift
Prerequisite client-side tasks
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Add FlexMatch to a game client

This topic describes how to add FlexMatch matchmaking functionality to your client-side game components.

We highly recommend that your game client make matchmaking requests through a backend game service. By using this trusted source for your communication with the Amazon GameLift service, you can more easily protect against hacking attempts and fake player data. If your game has a session directory service, this is a good option for handling matchmaking requests. Using a backend game service for all calls to the Amazon GameLift service is a best practice when using FlexMatch with Amazon GameLift hosting and as a standalone service.

Client-side updates are required whether you're using FlexMatch with Amazon GameLift managed hosting or as a standalone service with another hosting solution. Using the Amazon GameLift service API, which is part of the Amazon SDK, add the following functionality:

  • Request matchmaking for one or multiple players (required). Depending on your matchmaking rule set, this request might require certain player-specific data, including player attributes and latency.

  • Track the status of a matchmaking request (required). In general, this task requires setting up event notification.

  • Request player acceptance for a proposed match (optional). This feature requires additional interaction with a player to display match details and allow them to accept or reject the match.

  • Get game session connection information and join the game (required). After a game session has been started for the new match, retrieve connection information for the game session and use it to connect to the game session.

Prerequisite client-side tasks

Before you can add client-side functionality to your game, you need to do these tasks:

  • Add the Amazon SDK to your backend service. Your backend service uses functionality in the Amazon GameLift API, which is part of the Amazon SDK. See Amazon GameLift SDKs for client services to learn more about the Amazon SDK and download the latest version. For API descriptions and functionality, see Amazon GameLift FlexMatch API reference (Amazon SDK).

  • Set up a matchmaking ticket system. All matchmaking requests must have a unique ticket ID. Create a mechanism to generate unique ticket IDs and assign them to match requests. A ticket ID can use any string format, up to a maximum of 128 characters.

  • Collect information about your matchmaker. Get the following information from your matchmaking configuration and rule set.

    • Name of the matchmaking configuration resource.

    • The list of player attributes, which are defined in the rule set.

  • Retrieve player data. Set up a way to get relevant data for each player to include in your matchmaking requests. You need the player ID and player attribute values. If your rule set has latency rules or you want to use latency data when placing game sessions, collect latency data for each geographic location where the player is likely be slotted into a game.