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:
- Nach der Begrüßung vom Server:
- LOGIN (<login>|<email>) <password>
- LOGOUT
- Nach dem Anmelden:
- LIST MAPS
- LIST USERS
- LIST GAMES
- CREATE GAME <gamename> -maxPlayers <count> (-map <mapname>)? (-testgame)?
- JOIN GAME <gamename> (-visitor [true|false])?
- MSG (ALL | ( ( USER | TEAM ) <recipient> ) )? <message>
- UPLOAD MAP
- DOWNLOAD MAP <mapname>
- CREATE TESTPLAYER
Beispiel:
SE1 SettlersOfCatan-Server 1.0, Timeout set to 3600000ms
login zenobios ******
USER NICK=zenobios EMAIL=andreas.scharf@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):
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 - rollDies"}
erwartet der Server ein ROLL_DIES command von euch
Tipp: Das nötige Datenmodell lässt sich größtenteils aus dem Eventstream ableiten.