From: Carl Worth <cworth@cworth.org>
Date: Fri, 5 Jun 2020 01:16:41 +0000 (-0700)
Subject: Add a new game-info event
X-Git-Url: https://git.cworth.org/git?p=empires-api;a=commitdiff_plain;h=f18d84cb1e3be387f708204d626ec27b66bfd2a6;hp=9426bf42aaa7c88c86de4c3ac02a694df8362fda

Add a new game-info event

Which gives the game ID and the URL for connecting to the game.

This allows the client to display this information so that the player
can easily share it with friends, etc.
---

diff --git a/tictactoe.txt b/tictactoe.txt
index 2211a05..361caf7 100644
--- a/tictactoe.txt
+++ b/tictactoe.txt
@@ -26,14 +26,27 @@ For a specific game the following API endpoints are defined.
 
     The following event types will be returned by the server:
 
-        TYPE: game-state
+	TYPE: game-info
 
-        WHEN: When a client first connections
+	WHEN: When a client first connects
+
+	WHAT: Static information about the game (will not change)
 
         EXAMPLE:
 
+		event: game-info
+                data: {"id":"WXYZ","url":"https://lmno.games/WXYZ"}
+
+	TYPE: game-state
+
+	WHEN: When a client first connects
+
+	WHAT: Snapshot of the current dynamic game state
+
+	EXAMPLE:
+
 		event: game-state
-                data: {"moves":[0,8],"board":["X","","","","","","","","O"],"next_player":"X"}
+		data: {"moves":[0,8],"board":["X","","","","","","","","O"],"next_player":"X"}
 
 	TYPE: move