Skip to content

Latest commit

 

History

History
74 lines (56 loc) · 2.36 KB

Interface.md

File metadata and controls

74 lines (56 loc) · 2.36 KB
Raw

#Liar's Dice Game Interface

##Setup (pre-game) ###create

  • IN: player_count, player1_name, player2_name... playerX_name
  • OUT: game_id, game_state, (optional) round_number

Rules: - Maximum X players. - game_state will be one of 'not_started', 'playing', 'ended' - if game_state is 'playing', round_number will indicate the current round of the game. - the player calling create is always player1

###game_list

  • IN: player_name
  • OUT: game_ids()

Rules: - Array game_ids contains list of games that a) contain player name and b) have game status of 'not_started' - If no games available for player_name, game_ids() will be empty.

###join_game

  • IN: player_name, game_id
  • OUT: game_id, game_state, (optional) round_number

Rules: - Same return values as create - If all players specified in create have joined the game, game_state is 'playing' and the game has begun.

##Game Play

###start_game

  • IN: game_id
  • OUT: game_id, game_state(='playing'), round_number(=1)

Rules: - Returns error if only 1 player has joined the game. - Client may enforce whether only player 1 can call start_game

###roll_dice

  • IN: player_name, game_id
  • OUT: dice(), game_id, player_name

Rules: - Returns error if this player has already rolled this round

###game_status

  • IN: game_id, player_name
  • OUT: game_id, game_state, round_number, player_turn(bool), dice(), bid

Rules: - player_turn returns true if it is player_name's turn, false otherwise - dice() contains current dice for player_name - bids() contains current bids for other players

###bid

  • IN: game_id, round_number, player_name, bid_count, bid_die
    • Example: {"game_id": 5, "round_number": 8, "player_name": "me", "bid_count": 3, "bid_die": 6 }
  • OUT: game_id, game_state, round_number, player_turn(bool=false), dice(), bid

Rules: - Returns error if not player_name's turn - Returns error bid is not allowable - Return is otherwise the same as game_status

###challenge

  • IN: game_id, round_number, player_name
    • Example: {"game_id": 5, "round_number": 9, "player_name": "you" }
  • OUT: game_id, game_state, round_number, player_turn(bool=false), dice(), bids()

Rules: - Returns error if not player_name's turn - Return is otherwise the same as game_status