Setting Up Matchmaking - Simpl

Prerequisites

You need a build with status ready and a project on the Pro plan. Queues, lobbies, and matchmaking are Pro-only. See Plan Limits.

Creating a queue

From the dashboard: open the Queues tab and click Create queue. From the API:

curl -X POST https://api.simpl.gg/v1/queues \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "version_tag": "0.1.0",
    "region": "iad",
    "tier": "2x-2g",
    "max_players": 10
  }'

Field	Description
`version_tag`	The build to run for matched servers
`region`	Where servers boot for this queue
`tier`	Compute tier for booted servers
`max_players`	Total players required to start a match
`matchmaking`	Team composition and matching rules

How matchmaking works

Players create lobbies at runtime through your game client. The lobby host enters the lobby into a queue. Simpl groups compatible lobbies together, boots a server once a match is full, and delivers a server_ready event to every player over SSE.

Team composition

For asymmetric games, define teams by size and role. A 1 killer vs. 4 survivors queue looks like:

{
  "matchmaking": {
    "teams": [
      { "name": "killer", "size": 1 },
      { "name": "survivors", "size": 4 }
    ]
  }
}

Matchmaking rules

Rule	Purpose
`difference`	Matches players within an MMR range
`equals`	Requires an exact match, such as game version
`region`	Requires overlapping player regions

Player state

Players set state when joining a lobby. Simpl reads this state when applying matchmaking rules and team composition.

{
  "state": {
    "mmr": 1450,
    "regions": ["iad", "ewr"],
    "role": "survivor"
  }
}