Software Engineering Research Group Kassel

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: *Später mehr*
• 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>
• 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 TESTPLAYERBeispiel:

    SE1 SettlersOfCatan-Server 1.0, Timeout set to 3600000ms
    login zenobios ******
    USER NICK=zenobios EMAIL=andreas [dot] scharf [at] cs [dot] uni-kassel [dot] 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