Empires Game Protocol
=====================
-Version: 0.5
+Version: 0.6
For a specific game the following API endpoints are defined.
(Note: Only the trailing portion of the API URI is provided here.
WHEN: When client first connects and whenever game state changes
- VALUES: Event gives both the old and new state. Game state
+ VALUES: Event gives both the old and new state.
Each will be one of the following:
none: Pseudo-state used as old_state when game is started
reveal: Character names are being revealed to players
capture: Players are guessing characters in capture attempts
+ NOTE: When a client first connects, it may see multiple
+ game-state transitions, to transition step-by-step from
+ the initial state to the state of the current game. See
+ the example below which would be presented to a client
+ joining a game that is already in the "reveal state.
+
EXAMPLES:
event: game-state
Method: POST
- Behavior: Adds a new player with "name" and "character" and assigns an id. Also will add a new empire with empty "captured" array
+ Behavior: Adds a new player with "name" and "character" and
+ assigns an id. Also will add a new empire with empty "captured"
+ array.
+
+ Note: If the client supports cookies and has previously set a
+ nickname in the current session via the upper-level /profile API,
+ then the name can be omitted from the data here and the profile
+ nickname will be used instead.
Example data: { "name": "Carl", "character: "Elvis" }