Protocol

[jeffladiray]

Made this on to define once and for all a basic and extensible protocol for UTL related stuff

I prefixed all the "message" with an identifier, so redux code will be easier to segment.

• ON - connection : (client)

• ON - disconnect : EMIT - lobby/update && if connected to channel channel/update && (if don't reconnected => disconnect from game after 45 s)

• ON - init/createPlayer : ({player})

  • EMIT - INITIATOR ONLY - init/playerCreated : () => ({player}) # Send created user
  • JOIN IO ROOM -> LOBBY # Since user exist, add it to lobby
  • EMIT - `lobby/update

• ON - channel/create : ({channel})

  • EMIT - lobby/update # Update lobby with new channel
  • EMIT - INITIATOR ONLY - channel/created
  • EMIT - channel/update # Contains info to redirect the user to the correct page

• ON - channel/join : ({channelId})

  • EMIT - lobby/update : () => ({lobby}) # Update lobby, without initiator
  • JOIN IO ROOM -> UTL_GAME_ROOM(channelId) # Since user exist, add it to lobby
  • EMIT - channel/update: # Update current channel for all player # contains info to redirect the user to the correct page

• ON - utl/nextRound : ()

  • EMIT - channel/update # Update current channel for all player

• ON - utl/selectedAnswers : ({answers})

  • EMIT - channel/update: # Update current channel for all player

• ON - utl/selectedJudgment : ({judgment})

  • EMIT - channel/update: # Update current channel for all player

We should also strictly define and serialize response message sent from the server in order to avoid ppl looking trough js code to find opponents card

EMIT - lobby/update

{
  $id: 'lobby',
    type: 'object',
    properties: {
      lobbyUsers: { type: 'User', default: '' },
      channels: {
       name: {type: 'string', default: '' },
       id: {type: 'integer', default: '' },
    },
  };

EMIT - channel/update (UTLGame & UTLPlus (protocol)

{
  $id: 'channel',
    type: 'object',
    properties: {
      id: {type: 'integer', default: '' },
      name: {type: 'string', default: '' },
      admin: {type: PLAYER (NEED TO BE CHANGED)},
      players: {
       id: {type: 'integer', default: '' },
       name: {type: 'string', default: '' },
       score: {type: 'integer', default: '0' },
       hand: {type: Answer, default: '' },
       answers: {type: Array[type: 'integer'], default: '0' },
       isGameMaster: {type: 'boolean', default: '0' },
      },
      currentStatus: {type: 'string', default: 'IDLE' },
      timer: {type: 'integer', default: '0' },
      deckQuestion: {type: 'string', default: '' },
    },
  };

This is the UTL games definition of a channel.

EMIT/ON/EMIT - INITIATOR ONLY : BROADCAST/ON NEW REQ RECEIVED/SEND RES ONLY TO THE SPECIFIC CLIENT

[Thenkei]

I started to update the protocol as they are set today.