Khelau Call Break game socket AsyncAPI 3.0.0 · protocol v1.0.0

hello Hello Client → Server

Identify the player. Must be the first message on every connection.

Send the stored session token to return to your seat after a refresh, a dropped connection or a server restart; send null the first time. The server answers with welcome, then room (and state when at a table).

Example

{
  "t": "hello",
  "v": 1,
  "token": null,
  "name": "Asha",
  "avatar": 10,
  "clientId": "k3v9x0q2m1"
}

quick Find a game Client → Server

Join the public lobby with the most players waiting, or open a new one.

Example

{
  "t": "quick"
}

create Create private room Client → Server

Open a private room; its code is in the next room message.

Example

{
  "t": "create"
}

join Join room Client → Server

Join a room by code.

Example

{
  "t": "join",
  "code": "KTM42"
}

founders Join Founders lobby Client → Server

Join the invite-only Founders lobby.

The password is checked only on the server. 5 wrong tries per 10 minutes.

Example

{
  "t": "founders",
  "name": "Sabin",
  "password": "********"
}

sitOut Sit out Client → Server

Founders lobby: move from a seat to the bench (before a game).

Example

{
  "t": "sitOut"
}

sitIn Take a seat Client → Server

Founders lobby: move from the bench to a free seat.

Example

{
  "t": "sitIn"
}

start Start Client → Server

Start now; bots fill empty seats. Private rooms: host only.

Example

{
  "t": "start"
}

bid Bid Client → Server

Bid for the round when it is your turn.

Example

{
  "t": "bid",
  "bid": 3,
  "seq": 12
}

play Play card Client → Server

Play a card from your hand when it is your turn. It must be one of state.view.legal.

Example

{
  "t": "play",
  "card": {
    "suit": "S",
    "rank": 14
  },
  "seq": 13
}

ready Next round Client → Server

Ready for the next round (between rounds).

Example

{
  "t": "ready"
}

again Play again Client → Server

Start a new game in the same room after game over (host only).

Example

{
  "t": "again"
}

leave Leave Client → Server

Leave the room. Mid-game, a bot takes the seat and it is held for you for 2 minutes (see rejoin).

Example

{
  "t": "leave"
}

rejoin Rejoin Client → Server

Take back the seat you left, while the rejoin offer is open.

Example

{
  "t": "rejoin"
}

ping Ping Client → Server

Keep-alive; answered with pong.

Example

{
  "t": "ping"
}

welcome Welcome Server → Client

Reply to hello. Store token (e.g. in localStorage) and send it in every later hello.

Example

{
  "t": "welcome",
  "token": "q1w2e3r4t5y6u7i8o9p0as",
  "playerId": "5f2a9c0d1e3b"
}

room Room Server → Client

The room you are in: seats, host, status and countdowns. null after leaving.

Example

{
  "t": "room",
  "room": {
    "code": "KTM42",
    "isPublic": false,
    "status": "lobby",
    "hostSeat": 0,
    "you": 0,
    "seats": [
      {
        "name": "Asha",
        "avatar": 10,
        "kind": "human",
        "connected": true,
        "botControlled": false
      },
      null,
      null,
      null
    ],
    "autoStartMs": null,
    "founders": false,
    "bench": null
  }
}

state Game state Server → Client

Your view of the game. It contains only your own hand; other players' cards are never sent.

Example

{
  "t": "state",
  "view": {
    "seat": 0,
    "round": 1,
    "phase": "bidding",
    "turn": 0,
    "hand": [
      {
        "suit": "S",
        "rank": 14
      }
    ],
    "bids": [
      null,
      3,
      null,
      null
    ],
    "totals": [
      0,
      0,
      0,
      0
    ],
    "legal": []
  },
  "turnMsLeft": 29000,
  "ready": [
    false,
    false,
    false,
    false
  ],
  "nextRoundMs": null,
  "seq": 12
}

rejoin Rejoin offer Server → Client

After leaving a game in progress: your seat is held for offer.ms more milliseconds. null: nothing to rejoin.

Example

{
  "t": "rejoin",
  "offer": {
    "code": "KTM42",
    "ms": 118000
  }
}

watch Watch Server → Client

Founders lobby: public progress for the founder sitting out (bids, tricks, totals; never cards).

Example

{
  "t": "watch",
  "watch": null
}

error Error Server → Client

A request was refused (e.g. room full, not your turn, illegal card). Human-readable.

Example

{
  "t": "error",
  "message": "That room is full or already playing"
}

pong Pong Server → Client

Reply to ping, with the number of players online on this server instance.

Example

{
  "t": "pong",
  "online": 3
}

Card

Seat

RoomInfo

PlayerView

Everything one seat may know. Other hands appear only as counts.