Matchmaking with allocations

• How will your matchmaker group players together for a match?
• When will your matchmaker group players together? For example, you may want to group players before (or after) allocating a game server.
• How will you pass the game server connection information to the game client?
• How will you configure custom requirements, such as maps or game modes?
• How should the game server end the game session?
• How will your matchmaker generate and track allocation UUIDs?
• How will you determine when a game server is ready for allocation?
• When will you initiate the deallocation process?

1. The player requests a game session from the game client.
2. The game client gathers information about the player, such as the region, preferred location, game mode, and map type.
3. The game client sends the information to the matchmaker.
4. The matchmaker determines whether to use an existing game session or to initialize a new game session.
   1. If the matchmaker decides to use an existing game session, it passes the session information to the game client, and then the player joins the session. The process ends here.
   2. If the matchmaker decides to initialize a new game session, it generates a UUID, then requests an allocation from Clanforge with the

      /allocate

      endpoint. Continue to the next step.
5. Clanforge receives the allocation request from the matchmaker, then selects a game server for the session based on the requirements in the allocation request. Depending on the game mode and map type, Clanforge may reconfigure the game server to match the requested configuration.
6. Clanforge updates the game server state to

   allocated

   .
7. Clanforge runs a few quality assurance tests on the game server to ensure that it’s online and running with the correct profile and configuration.
8. Clanforge sends a confirmation response to the matchmaker.
9. The matchmaker receives the confirmation message, then requests the allocation details from Clanforge with the

   /allocations

   endpoint.
10. Clanforge receives the request for the allocation details, then sends the information back to the matchmaker. The information includes the region, the profile, the allocation UUID, the creation time-stamp, the fulfillment time-stamp, the server ID, and the game server socket information.
11. The matchmaker receives the allocation details, then forwards the information to the game client so that it can connect to the game server session.
12. The game client connects to the game server session, and the player enters the lobby.
13. Other players join the lobby until the minimum number of players is met, then the game match begins.
14. The game server sends a heartbeat to the matchmaker every 120 seconds.
    1. If the matchmaker receives the heartbeat with the UUID, then no further action is necessary until the game session ends (or the heartbeat fails).
    2. If the matchmaker doesn’t receive the heartbeat, then the matchmaker will need to deallocate the allocation UUID with the

       /deallocate

       endpoint.
15. When the game match completes and all the players have disconnected, the game server contacts the matchmaker to report that the match is over.
16. Clanforge receives the deallocation request, then deallocates the game server.
17. Clanforge flags the game server as available for allocation again.