OpenMatchTutorial

Test Open Match backfill. Build matching system with Open Match for tutorial scenario like this.

C4Context
title Open Match Tutorial

Person(userA, "UserA", "grpcurl")
Person(userB, "UserB", "grpcurl")
Boundary(minikube, "Minikube", "") {
  Boundary(OpenMatchTestNamespace, "open-match-test", "namespace") {
    Container(GameFront, "GameFront")
    Container(mmf, "MatchMakingFunction")
    Container(Director, "Director")
    Container(DGS, "GameServer")
  }
  Boundary(OpenMatchNamespace, "open-match", "namespace") {
    System(OpenMatch, "OpenMatchCore")
  }
}

Loading

prerequirements

• helm
• docker
• local k8s, e.g. minikube
• grpcurl
• jq

How to run

install and setup components

1. install open match (if you need)
   • run CONTEXT=(k8s context) VERSION=(Open Match version) make install-openmatch
     • default CONTEXT is open-match-test
     • default VERSION is 1.8.0
2. apply manifests
   • run make apply

request match making

First, run this command for request ticket:

TICKET_ID=`grpcurl -plaintext -d '{"name":"userA"}' (gemefront service ip):30021 gamefront.GameFrontService.EntryGame | jq .ticketId`

And next, join the DGS:

grpcurl -plaintext -d "{\"ticket_id\":$TICKET_ID}" (gameserver service ip):30054 gameserver.GameServerService.Join

If the request is succeeded, you got room state via stream like this:

{
  "members": [
    {
      "name": "userA",
      "ready": true
    }
  ]
}

UserA is ready now, so we'll have UserB join the DGS next:

TICKET_ID=`grpcurl -plaintext -d '{"name":"userB"}' (gemefront service ip):30021 gamefront.GameFrontService.EntryGame | jq .ticketId` grpcurl -plaintext -d "{\"ticket_id\":$TICKET_ID}" (gameserver service ip):30054 gameserver.GameServerService.Join

UserA and UserB got response like this:

{
  "members": [
    {
      "name": "userA",
      "ready": true
    },
    {
      "name": "userB",
      "ready": true
    }
  ]
}

Now, the game has 2 participants but it requires 3. DGS add bots if the participants are not enough until timeout limit.

UserA and UserB got response when the bot was added. It means the room is ready.

{
  "members": [
    {
      "name": "userA",
      "ready": true
    },
    {
      "name": "userB",
      "ready": true
    },
    {
      "name": "bot1",
      "ready": true
    }
  ]
  "ready": true
}

cleanup

If you cleanup only tutorial components, run kubectl delete namespace open-match-test.

make clean command uninstall Open Match too.