Update the game-state event and increment protocol to version 0.5

Specifically, we change to lowercase names for the states, and we also
include both the old and new states on each transition. This also
means there is a new "none" state for the initial game-state event.

diff --git a/api.text b/api.text
index 250ed107c86aad50698332b5185a5402c85debf2..b1a8f798175a7e89d644c2165a8225c7ff75a62c 100644 (file)
--- a/api.text
+++ b/api.text
@@ -1,6 +1,6 @@
 Empires Game Protocol
 =====================
 Empires Game Protocol
 =====================

-Version: 0.4
+Version: 0.5

 
 For a specific game the following API endpoints are defined.
 (Note: Only the trailing portion of the API URI is provided here.
 
 For a specific game the following API endpoints are defined.
 (Note: Only the trailing portion of the API URI is provided here.


@@ -53,20 +53,25 @@ For a specific game the following API endpoints are defined.
 
        WHEN: When client first connects and whenever game state changes
 
 
        WHEN: When client first connects and whenever game state changes
 

-       VALUES: Game state will be one of the following:
+       VALUES: Event gives both the old and new state. Game state
+               Each will be one of the following:

 
 

-               JOIN: Players are choosing characters and joining the game
-                REVEAL: Character names are being revealed to players
-                CAPTURE: Players are guessing characters in capture attempts
+               none: Pseudo-state used as old_state when game is started
+               join: Players are choosing characters and joining the game
+                reveal: Character names are being revealed to players
+                capture: Players are guessing characters in capture attempts

 
 

-       EXAMPLE:
+       EXAMPLES:
+
+               event: game-state
+                data: {"old_state":"none","new_state":"join"}

 
                event: game-state
 
                event: game-state

-                data: {"state":"REVEAL"}
+                data: {"old_state":"join","new_state":"reveal"}

 
        TYPE: character-reveal
 
 
        TYPE: character-reveal
 

-       WHEN: Periodically during the REVEAL state of the game
+       WHEN: Periodically during the "reveal" state of the game

 
        EXAMPLE:
 
 
        EXAMPLE: