nogit-sync commit

diff --git a/TODO b/TODO
index 48fb75a7402b82b47560c366425f780460eae541..a96ab17d32226b992b6537016b6b6afa246e282c 100644 (file)
--- a/TODO
+++ b/TODO
@@ -106,6 +106,45 @@ Bring client up to latest Empires API approach
                      -H 'Content-Type: application/json' \
                      -d '{"character": "Cookie Monster"}'
                      https://lmno.games/empires/QRST/register
+                Returns: 2 (Or some other player ID value)
+
+  [ ] Listen to the /events stream for the game
+
+      This will require an asynchronous mechanism that is continually
+      listening for events to come in. Events will be of the form
+      "event: <event_type>" followed by the data of the event "data:
+      <json_data_for_event>" followed by a blank line. There will also
+      be periodic keep-alive non-events sent which are just a line
+      with only a ":".
+
+      This mechanism is called "Server-sent events" so you may find
+      code that supports the parsing of this. Or you may not. It
+      doesn't seem like this mechanism ever became all that popular
+      (before websockets came along and became popular).
+
+      Example:
+
+                curl https://lmno.games/empires/QRST/events
+                Returns:
+
+                   event: game-info
+                   data: {"id":"QRST","url":"http://lmno.games/QRST"}
+
+                   event: player-info
+                   data: {"id":5,"active":true,"name":"Cookie","team":""}
+
+                   event: player-enter
+                   data: {"id":2,"active":true,"name":"Web","team":""}
+
+                   event: game-state
+                   data: {"team_to_play":{"name":""}}
+
+                   event: players
+                   data: [{"id":1,"name":"Carl"},{"id":2,"name":"Cookie"}]
+
+                   event: game-phase
+                   data: {"old_phase":"none","new_phase":"join"}
+
 
 Scribe
 ======