Skip to main content

Lobby overview

How it works?​

Lobby scene (sometimes known as a main menu) is a space, where the player can change authentication, select game mode, adjust settings, see some meta-play data like leaderboards or highscore, and finally cool down after a match. Under the mask it faciliates communication with Elympics services, making all of these possible to happen.

To access numerous Web3 features such as preserving player's identity and playing in tournaments, lobby needs to be integrated with PlayPad SDK.

Functionalities:

  • Establishing connection between the client and server (known as matchmaking, even for solo games) - playing the game using server authoritative architecture
  • Providing custom match data
  • Guest and wallet authentication
  • Rooms based matchmaking
  • Smart, machine-learning based matchmaking
  • Using regions for best possible client-server connection quality
  • Unlocking numerous Web3 features

Setup​

Every lobby scene needs ElympicsLobby prefab instance with ElympicsLobbyClient component attached, which is responsible for the whole core lobby functionality. You can add it by clicking right mouse button in the hierarchy then selecting Elympics->ElympicsLobby.

To handle authentication, AuthenticateOnAwakeWith should be set to None when integrated with PlayPad SDK and Client secret otherwise. If your game allows for changing authentication at runtime, proper loading mask and input blocking should be provided to handle time inbetween authentications.

Play action​

Every game needs a way for the player to start a match. To achieve that, most games utilize play buttons or automatic play initialization when conditions are met.

Note that each game should provide input blocking mask for match loading and also proper error handling popup in case of issues.

Versus games​

Use ElympicsLobbyClient.Instance.RoomsManager to manage rooms, where players can meet each other, and after proclaiming mutual readiness, the host can start the match with StartMatchmaking method. This solution needs whole UI structure for listing, creating, joining and modifying rooms. Great example of a game using this solution is Clash of Orbs.

Solo games​

For leaderboard based games a play button is enough. It needs to call ElympicsLobbyClient.Instance.RoomsManager.StartQuickMatch. For tournament play see the next section.

Web3 features​

For wallet authentication, leaderboards displying, and tournaments management, you need to integrate with PlayPad SDK.

Using Web3 features also means a little more complex lobby scene, which will be able to handle displaying leaderboards, tournament data and so on. Fortunately, all that functionality can be easily achieved by importing the AsyncGameSample and adjusting it to your visual design.

With that, to play the game, play button should call PlayPadCommunicator.Instance.GameStatusCommunicator.PlayGame on click (if not locked for example by already closed tournament).

Continue with deploying the game​

With the lobby scene fully set up and PlayPad SDK integrated, it's time to deploy & test the game online.