kovacsand / Simon-Taps-Server

Simon Taps server side created for a competition

Simon Taps Server Side with Spring

Get state

Visszaadja a szoba és a játokos állapotát

• URL

  /state/{room_id}/{player_id}

• Method:

  GET

• Success Response:

  • Case: Game state in Waiting
    

    • Content: { status: 'OK', gameState: [string], numberOfPlayers: [int] }

  • Case: Game state in Preparing
    

    • Content: { status: 'OK', gameState: [string], tileId: [int] }

  • Case: Game state in Showing Pattern
    

    • Content: { status: 'OK', gameState: [string], pattern: [string] }

  • Case: Game state in Playing
    

    • Content: { status: 'OK', gameState: [string] }

  • Case: Game state in Successful End
    

    • Content: { status: 'OK', gameState: [string] }

  • Case: Game state in Fail End
    

    • Content: { status: 'OK', gameState: [string] }

• Error Response:

  • TODO

• Example

  • URL paraméterként várja a room és player id-t:
  • GET /state/1234/1234

Create

Szoba létrehozása

• URL

  /create

• Method:

  POST

• JSON Params

  roomId:[string]

  playerId:[string]

• Success Response:

  • Case: Successful creation and join
    
    • Content: { status: 'OK', numberOfPlayers: [int] }

• Error Response:

  • Reason: Room already exists
    
    • Content: { status: 'ERROR', reason: 'ROOM_ALREADY_EXISTS' }

Join

Csatlakozás szobához saját player id-val

• URL

  /join

• Method:

  POST

• JSON Params

  roomId:[string]

  playerId:[string]

• Success Response:

  • Case: Successful join
    
    • Content: { status: 'OK', numberOfPlayers: [int] }

• Error Response:

  • Reason: Room does not exist
    

    • Content: { status: 'ERROR', reason: 'ROOM_DOES_NOT_EXIST' }

  • Reason: Room full
    

    • Content: { status: 'ERROR', reason: 'ROOM_IS_FULL' }

Leave

Kilépés szobából amíg WAITING state-ben van

• URL

  /leave

• Method:

  POST

• JSON Params

  playerId:[string]

• Success Response:

  • Case: Successfully left
    
    • Content: { status: 'OK' }

• Error Response:

  • Reason: Not left from room
    
    • Content: { status: 'ERROR', reason: 'NOT_LEFT' }

Start

Showing Pattern után ezen az endpointon jelez egyszer a játékos, hogy kész.

• URL

  /start

• Method:

  POST

• JSON Params

  roomId:[string]

  playerId:[string]

• Success Response:

  • Case: Success
    
    • Content: { status: 'OK'}

• Error Response:

  • TODO

Game

Gombot nyomott a játékos

• URL

  /game

• Method:

  POST

• JSON Params

  roomId:[string]

  playerId:[string]

• Success Response:

  • Case: Successful press and game is still in Playing State
    

    • Content: { status: 'OK', gameState: [string] }

  • Case: Wrong Press
    

    • Content: { status: 'OK', gameState: [string] }

  • Case: Successful press and game is in Successful End State
    

    • Content: { status: 'OK', gameState: [string] }

• Error Response:

  • TODO

Restart

Újrakezdés ugyanazokkal a játékosokkal

• URL

  /restart

• Method:

  POST

• JSON Params

  roomId:[string]

  playerId:[string]

• Success Response:

  • Case: Success
    
    • Content: { status: 'OK', numberOfRestartPlayers: [int] }

• Error Response:

  • TODO

Get version check

Kliens verziójának ellenőrzése

• URL

  /version/{version}

• Method:

  GET

• Success Response:

  • Case: Passed version check
    
    • Content: { status: 'OK', compatible: [boolean] }

• Error Response:

  • Case: Failed version check
    
    • Content: { status: 'ERROR', reason: 'FORBIDDEN' }

Game States

• 1_waiting

• 2_preparing

• 3_showing_pattern

• 4_playing

• 5_successful_end

• 5_fail_end

Get State hívása

• WAITING
  • 1000 ms-enként
• PREPARING
  • 250 ms-enként
• SHOWING PATTERN
  • 250 ms-enként
• PLAYING
  • 250 ms-enként