git.cworth.org Git - empires-api/blob - README

   1 This repository describes a client-server API useful for playing the
   2 traditional party game of Empires (sometimes called Families).
   3
   4 This game involves each player secretly choosing a character. The
   5 complete list of characters is read aloud at the beginning of the
   6 game, without revealing which player chose each character. Players
   7 must try to remember all the character names, and gameplay consists of
   8 guessing the character that another player submitted. After a correct
   9 guess, the guessed player is "captured" and becomes part of the
  10 "empire" of the guessing player. At the end of the game, there will be
  11 one winner who is the head of an empire consisting of all players in
  12 the game.
  13
  14 See the api.text for a decription of the REST API.
  15
  16 Motivation
  17 ==========
  18 As a party game, Empires requires very little equipment, (just slips
  19 of paper for each player to write their character name on). And for an
  20 in-person party, it's probably best to just use that traditional
  21 method (without needing any technology to implement this API).
  22
  23 However, if a group is not meeting in person, but instead using
  24 something like a video-conference tool to get together, the
  25 traditional approach of slips of paper may not be available. So an
  26 implementation of the API describes here allows for players to submit
  27 their own character names, and then for clients to obtain the complete
  28 list of charater names without knowing which players submitted which
  29 names.
  30
  31 The API also allows for keeping track of which players have "captured"
  32 other players to form larger empires and querying the current empire
  33 relationshiips.
  34
  35 Notably, this API has no mechanism for submitting guesses of a
  36 player's character nor determining whether a guess is correct. The
  37 assumption here is that the game is still played face to face,
  38 (whether in person or via video conference or some other
  39 technology). So guesses should still be communicated and resolved that
  40 way. The API simplifies the tracking of empires so that players can
  41 easily know who is still active, (whereas, in the in-person party
  42 game, empires are made obvious by people physically moving to sit with
  43 their empire).