Carcassonne Server Protokoll v1.0.1

Software Engineering I, SS14

Der Server spricht generell ein zeilenbasiertes String Protokoll. Daher kann man eine telnet Verbindung benutzen um das Protokoll zu erkunden. Nach dem öffnen einer Konsole und der Eingabe von

 telnet se1.cs.uni-kassel.de 5000

kann man mit HELP eine Liste aller verfügbaren Befehle abrufen.

Allgemeine Informationen

  • Um sich beim Server anzumelden, benötigt man zunächst einen eigenen Login. Dieser ist identisch mit eurem Jira-Login.
  • Jedes erfolgreiche Kommando wird vom Server mit einem OK beendet. Fehler werden mit einer Zeile beantwortet die mit ERROR beginnt.
  • Der Server kommuniziert durch zwei verschiedene Protokollarten:
    • “Klartextprotokoll”: Bei einloggen und in der Lobby verwendet der Server ein simples “Klartextprotokoll” um mit seinen Clients zu kommunizieren.
    • JSON-Protokoll: Nach einem erfolgreichen JOIN GAME Kommando das mit OK bestätigt wurde wechselt der Server in ein JSON basiertes Protokoll, bei dem er JSON codierte Events verschickt und JSON codierte Commands erwartet.
  • Um einen Timeout zu vermeiden sollte vom Client in regelmäßigen Abständen ein NOOP geschickt werden.

Klartextprotokoll

Sobald man eine Verbindung zum Server aufgebaut hat, kommuniziert dieser mit einem simplen Klartextprotokoll mit dem Client. Nicht alle Befehle sind überall verfügbar. Eine genaue Auflistung inkl. Gruppierung der Befehle liefert der HELP Befehl. Hier eine Übersicht über die verschiedenen Befehle:

  • Immer:
    • HELP <command>
    • NOOP
  • Nach der Begrüßung vom Server:
    • LOGIN (<login>|<email>) <password>
    • LOGOUT
  • Nach dem Anmelden:
    • LIST USERS
    • LIST GAMES
    • CREATE GAME <gamename> -maxPlayers <count> (-testgame)?
    • JOIN GAME <gamename> (-visitor [true|false])?
    • MSG (ALL | ( ( USER | TEAM ) <recipient> ) )? <message>
    • CREATE TESTPLAYER
      Beispiel:

      SE1-Server 1.0, Timeout set to 3600000ms
login akoch ******
USER NICK=akoch EMAIL=andreas.koch@cs.uni-kassel.de ROLE=SE
TEAM NAME=SE ID=3fb6101e
OK
help
Available commands after greeting: LOGIN, LOGOUT
User commands: ID, LIST USERS
Game management: LIST MAPS, CREATE GAME, LIST GAMES, JOIN GAME, UPLOAD MAP, DOWNLOAD MAP
Team management: LIST TEAMS
Other commands: CREATE TESTPLAYER, MSG, CHANGELOG, UPLOAD MAP, NOOP, HELP
send 'HELP <command>' for details
a successfull command will be acknowledged with an 'OK' line
an unsuccessfull command will be acknowledged with an 'ERROR' line
OK
help create testplayer
Creates a temporary user e.g. for testing purposes. This user exists at least for 24h hours or until the next server restart
Usage: "CREATE TESTPLAYER"
OK
create testplayer
TEMPORARY USER NICK=tempUser0 PASSWORD=ys8ufm
OK

JSON Protokoll

Das Ingame JSON Protokoll kennt in Serverrichtung Commands und in Clientrichtung Events.

Commands

Die Commands müssen mindestens ein action Attribut enthalten welches folgende Werte annehmen kann (keys in Klammern sind optional):

Action Keys Beispiel Bemerkung
CHANGE_USER_COLOR color {"@action":"CHANGE_USER_COLOR","properties":{"entry":{"key":"color","value":"FFFF00"}}} Ändert die Userfarbe.
DRAW_CARD keiner {"@action":"DRAW_CARD"} Zieht eine Karte.
PLACE_CARD neighbor, orientation, rotation {"@action":"PLACE_CARD","properties":{"entry":[{"key":"neighbor","value":"Field@b2d54e6"},{"key":"orientation","value":"NORTH"},{"key":"rotation","value":"R90"}]}} Legt die zuletzt gezogene Karte neben der spezifizierten Karte (neighbor) an die gewünschte Seite (orientation) mit der gewünschten Rotation (rotation) aus.
Für orientation sind folgende Werte möglich: NORTH, EAST, SOUTH, WEST
Für rotation sind folgende Werte möglich: R0, R90, R180, R270
PLACE_MEEPLE id, position {"@action":"PLACE_MEEPLE","properties":{"entry":[{"key":"meeple","value":"Meeple@c4e732d"},{"key":"position","value":"1"}]}} Stellt einen eigenen Spielstein (meeple) auf der gerade ausgelegten Karte an die gewünschte Position (position).
END_TURN keiner {"@action":"END_TURN"} Beendet den aktuellen Zug.
LEAVE_GAME keiner {"@action":"LEAVE_GAME"} Verlässt das aktuelle Spiel.
MESSAGE message, (audience)?, (recipient)? {“@action”:”MESSAGE”,”@id”:”0″,”properties”:{“entry”:[{“key”:”message”,”value”:”Hallo”},{“key”:”audience”,”value”:”USER”},{“key”:”recipient”,”value”:”zenobios”}]}} Verschickt eine Nachricht an alle oder den angegebenen User/Team. Der Parameter audience erlaubt folgende Werte:ALL, USER, TEAM.Folgende Kombinationen von audience und recipient sind möglich:

  • audience: leer, recipient:leer -> Nachricht wird an alle User im Spiel geschickt
  • audience: leer, recipient:nicht leer -> Nachricht wird nicht verschickt
  • audience: ALL, recipient:leer -> Nachricht wird an alle User im Spiel geschickt
  • audience: ALL, recipient:nicht leer-> Nachricht wird nicht verschickt
  • audience: USER, recipient:leer -> Nachricht wird nicht verschickt
  • audience: USER, recipient:username -> Nachricht wird an user username verschickt
  • audience: TEAM, recipient:leer -> Nachricht wird an das eigene Team geschickt
  • audience: TEAM, recipient:teamname -> Nachricht wird an das Team teamname verschickt

Events, die durch diesen Command ausgelöst werden übergeben die Art der Message mit, um im Client eine Unterscheidung durchführen zu können. Mögliche Werte sind:ERROR, MESSAGE, PUBLIC_MESSAGE, USER_MESSAGE, TEAM_MESSAGE
NOOP keiner {"@action":"NOOP"} Command der in regelmäßigen Abständen abgeschickt werden kann, um die Verbindung aufrecht zu erhalten.
START_GAME keiner {"@action":"START_GAME"} Startet das Spiel, wenn genügend Spieler angemeldet sind.

Events

Der Server schickt Events in der Form

{"@ts":"1336475335153","@src":"User@a4d93e3","@prop":"nickname","@nv":"akoch"}

In diesem Fall wurde zum Timestamp 1336475335153 von der source User@a4d93e3 die property nickname auf akoch (new value) geändert.
Wer sich die Events vom Server genauer anschaut wird feststellen, dass Werte die null sind in JSON wegoptimiert werden. In diesem Beispiel fehlt z.B. die Property @ov.

Nicht alle Events stehen für Modelländerungen. Während eines Spiel sendet der Server euch auch Events, auf die ihr reagieren müsst. So gibt es OK und ERROR Events, die euch zusätzliche Informationen geben oder euch auffordern mit dem Server zu interagieren.

OK Events, die eine Reaktion von euch erfordern sind wie folgt aufgebaut: {“@ts”:”1372946132672″,”@src”:”SERVER”,”@prop”:”USER_MESSAGE”,”@nv”:”OK – {type} – {message}”}. Es gibt zudem auch OK Events, die rein informellen Charakter haben und erfolgreich ausgeführte Commands bestätigen

ERROR Events sind immer wie folgt aufgebaut: {“@ts”:”1372946132685″,”@src”:”SERVER”,”@prop”:”USER_MESSAGE”,”@nv”:”ERROR: {type} – {message}”}

Auf welchen {type} ihr wie reagieren müsst, findet ihr oben in der Tabelle. Der Parameter {message} wird nicht immer mitgesendet.

Empfangt ihr beispielsweise ein Event wie

{"@ts":"1372946132672","@src":"SERVER","@prop":"USER_MESSAGE","@nv":"OK - drawCard"}

erwartet der Server ein DRAW_CARD command von euch

Tipp: Das nötige Datenmodell lässt sich größtenteils aus dem Eventstream ableiten.