git.cworth.org Git - lmno-api/blob - api.text

   1 Empires Game Protocol
   2 =====================
   3 Version: 0.6
   4
   5 For a specific game the following API endpoints are defined.
   6 (Note: Only the trailing portion of the API URI is provided here.
   7  The preceding portions of the path must be determined externally.)
   8
   9 /events
  10
  11     This is a server-sent events stream that allows the server to push
  12     game-related events to clients. When a client connects to this API
  13     endpoint the server will return a header that includes:
  14
  15         Content-type: text/event-stream
  16         Connection: keep-alive
  17         Cache-Control: no-cache
  18
  19     and will keep the connection open to return events.
  20
  21     The following event types will be returned by the server:
  22
  23         TYPE: players
  24
  25         WHEN: When a client first connects
  26
  27         PURPOSE: Describes all players in the game already
  28
  29         EXAMPLE:
  30
  31                 event: players
  32                 data: [{"id":1,"name":"Carl"},{"id":2,"name":"Kevin"}]
  33
  34         TYPE: player-join
  35
  36         WHEN: When a player joins the game
  37
  38         EXAMPLE:
  39
  40                 event: player-join
  41                 data: {"id":3,"name":"Richard"}
  42
  43         TYPE: player-leave
  44
  45         WHEN: When a player leaves the game
  46
  47         EXAMPLE:
  48
  49                 event: player-leave
  50                 data: {"id":3}
  51
  52         TYPE: game-state
  53
  54         WHEN: When client first connects and whenever game state changes
  55
  56         VALUES: Event gives both the old and new state.
  57                 Each will be one of the following:
  58
  59                 none: Pseudo-state used as old_state when game is started
  60                 join: Players are choosing characters and joining the game
  61                 reveal: Character names are being revealed to players
  62                 capture: Players are guessing characters in capture attempts
  63
  64         NOTE: When a client first connects, it may see multiple
  65               game-state transitions, to transition step-by-step from
  66               the initial state to the state of the current game. See
  67               the example below which would be presented to a client
  68               joining a game that is already in the "reveal state.
  69
  70         EXAMPLES:
  71
  72                 event: game-state
  73                 data: {"old_state":"none","new_state":"join"}
  74
  75                 event: game-state
  76                 data: {"old_state":"join","new_state":"reveal"}
  77
  78         TYPE: character-reveal
  79
  80         WHEN: Periodically during the "reveal" state of the game
  81
  82         EXAMPLE:
  83
  84                 event: character-reveal
  85                 data: {"character":"Albert Einstein"}
  86
  87         TYPE: capture
  88
  89         WHEN: When one player captures another
  90
  91         EXAMPLE:
  92
  93                 event: capture
  94                 data: {"captor": 2, "captee": 1}
  95
  96 /register
  97
  98     Method: POST
  99
 100     Behavior: Adds a new player with "name" and "character" and
 101     assigns an id. Also will add a new empire with empty "captured"
 102     array.
 103
 104     Note: If the client supports cookies and has previously set a
 105     nickname in the current session via the upper-level /profile API,
 106     then the name can be omitted from the data here and the profile
 107     nickname will be used instead.
 108
 109     Example data: { "name": "Carl", "character: "Elvis" }
 110
 111 /deregister/<ID>
 112
 113     Method: POST
 114
 115     Behavior: Removes an existing player with the given ID
 116
 117 /reveal
 118
 119     Method: POST
 120
 121     When: Only valid when in game state of JOIN
 122
 123     Behavior: Change state to REVEAL; reveal character names to all clienta
 124
 125 /start
 126
 127     Method: POST
 128
 129     When: Only valid when in game state of REVEAL
 130
 131     Behavior: Change game state to CAPTURE
 132
 133 /reset
 134
 135     Method: POST
 136
 137     Behavior: Removes all players (bulk deregister)
 138
 139 /restart
 140
 141     Method: POST
 142
 143     Behavior: Eliminates all current empire ownership so the existing
 144     players can start a new game
 145
 146 /capture/<ID1>/<ID2>
 147
 148     Method: POST
 149
 150     Behavior: Indicate that empire ID1 has now captured ID2
 151
 152 /liberate/<ID>
 153
 154     Method: POST
 155
 156     Behavior: Indicate that empire ID is no longer captured (undoing a
 157     previous /capture)
 158
 159 /characters
 160
 161     Method: GET
 162
 163     Behavior: Returns a lists of all character names (in alphabetical order)
 164
 165     Example data: [ "Einstein", "Elvis", "Fred Flintstone" ]
 166
 167 /empires
 168
 169     Method: GET
 170
 171     Behavior: Shows which empires have been captured by other empires
 172
 173     Example data [ { "id": 1, "captures": [] },
 174                    { "id": 2, "captures": [1] },
 175                    { "id": 3, "captures": [4, 5, 6] },
 176                    { "id": 4, "captures": [2] },
 177                    { "id": 5, "captures": [] },
 178                    { "id": 6, "captures": [] } ]
 179
 180 /players
 181
 182     Method: GET
 183
 184     Behavior: Gets a list of all the player objects (without their
 185     character names)
 186
 187     Example data: [ { id: 1, name: "Carl" }, { id: 2, name: "Kevin" } ]
 188
 189 Server
 190 ======
 191 There's a sample server available at: https://families.cworth.org/api/
 192
 193 We plan to move this to https://empires.cworth.org at some point.