Set up session - Quick match with dedicated servers - (Unity module)

Last updated on June 11, 2024

About​

This tutorial will show you how to set up the configurations for dedicated server (DS) matchmaking in AccelByte Gaming Services (AGS) Admin Portal.

Create Session Template​

A Session Template is a configuration template that defines your game session. In this section, you will learn how to create a Session Template.

  1. Log in to the AGS Admin Portal and go to your game namespace dashboard.

  2. Go to Multiplayer > Matchmaking > Session Configurations. On the Session Template tab, click the Add Session Template.

  3. Fill in the new window using the configuration below for the Elimination game mode.

    • Session Template Name: the unique name to identify your Session Template. Set it to unity-elimination-ds-ams.
    • Min Players: the minimum number of players required in the session. Set it to 1.
    • Max Players: the maximum number of players in the session. Set it to 4.
    • Joinability: the joinability of the session. Set it to Open.
    • Server: the session connection type. Set it to DS - AMS.

  4. Add all of your enabled AccelByte Multiplayer Servers (AMS) regions by clicking Add Region under the Requested Regions configuration that appears as a result of the DS - AMS connection type being selected.

  5. For Fallback Claim Keys, add a new claim key that matches the claim keys you configured in your AMS fleet. If you're following along with the Byte Wars tutorials, you need to add the unity-ds-ams claim key. To add new claim keys, click Add Key.

  6. Click Next until you arrive at the Summary tab where you can review your Session Template configurations. Then, click Create.

  7. Repeat the steps above to create a new Session Template for the Team Deathmatch game mode by using the configuration below.

    • Session Template Name: set it to unity-teamdeathmatch-ds-ams.
    • Min Players: set it to 1.
    • Max Players: set it to 8.
    • Joinability: set it to Open.
    • Server: set it to DS - AMS.
    • Requested Regions: add all of your enabled AMS regions.
    • Fallback Claim Keys: add unity-ds-ams claim key.

Create a Match Ruleset​

A Match Ruleset is a configuration that defines how your players will be matched. It is a set of rules for how your matchmaking should work. This section will guide you through creating a Match Ruleset in the Admin Portal.

  1. Log in to the AGS Admin Portal and go to your game namespace dashboard.

  2. Go to Multiplayer > Matchmaking > Matchmaking Configurations. On the Match Ruleset tab, click Create Ruleset.

  3. Replace the preexisting JSON with the JSON below and name the new Match Ruleset as elimination. Once finished, click Create.

    {
        "alliance": {
            "max_number": 4,
            "min_number": 1,
            "player_max_number": 1,
            "player_min_number": 1
        },
        "auto_backfill": true
    }
    info

    • alliance is the attribute to define your match members, such as how many teams and players are in a match. This attribute should contain the following fields:

      • max_number is the maximum number of teams. Set it to 4.
      • min_number is the minimum number of teams. Set it to 1.
      • player_max_number is the maximum number of players in a team. Set it to 1.
      • player_min_number is the minimum number of players in a team. Set it to 1.

    • auto_backfill is a flag for whether the game's server should use backfill or not. You will learn more about it later. For now, set it to true.

  4. Repeat the steps above to create a new Match Ruleset for Team Deathmatch named teamdeathmatch using the configurations below.

    {
        "alliance": {
            "max_number": 2,
            "min_number": 2,
            "player_max_number": 1,
            "player_min_number": 4
        },
        "auto_backfill": true
    }

Create a Match Pool​

A Match Pool is a configuration that connects your Match Ruleset to your Session Template. It will perform matchmaking based on your Match Ruleset and create a game session based on your Session Template. This section will guide you through setting up Match Pools in the Admin Portal.

  1. Log in to the AGS Admin Portal and go to your game namespace dashboard.

  2. Go to Multiplayer > Matchmaking > Matchmaking Configurations. On the Match Pools tab, click Create Match Pool.

  3. Fill out the window that appears using the configuration below to create a Match Pool for the Elimination game mode. Once done, click Add.

    • Match Pool Name: the name of the Match Pool. Set it to unity-elimination-ds-ams.
    • Match Ruleset: the Match Rule to use. Set it to elimination.
    • Session Template: the Session Template to use. Set it to unity-elimination-ds-ams.

  4. Repeat the steps above to create a Match Pool for Team Deathmatch using the configuration below.

    • Match Pool Name: set it to unity-teamdeathmatch-ds-ams.
    • Match Ruleset: set it to teamdeathmatch.
    • Session Template: set it to unity-teamdeathmatch-ds-ams.
Last updated on

On this page