Anforderungsbeschreibung

Transkript

1 Fachbereich Mathematik und Informatik Prof. Dr. Klaus Ostermann Anforderungsbeschreibung zum Softwarepraktikum im Sommersemester 2010 Tillmann Rendel 28. Mai Mai 2010 Informationen zum Betrieb im Netzwerk in Anwendungsfall 3.3.2, Abschnitt 4.8 bis Abschnitt 4.12 und Kapitel 5 ergänzt.

2 Inhaltsverzeichnis 1 Einleitung 3 2 Kahala Spielfeld Regeln Beispiel Variationen Anwendungsfälle Der Spielstart Der Spielzug Kommandozeilen-Interface XML-Formate Verteilung der Spielsteine auf dem Spielfeld (<board>-tag) Aufforderung zur Abgabe eines Spielzuges (<your-turn>-tag) Spielzug (<my-turn>-tag) Ergebnis eines Spielzuges (<turn-result>-tag) Ergebnis eines Spieles (<score>-tag) Spielfeld und -zug (<board-and-turn>-tag) Mehrere Spielzüge (<my-turns>-tag) Name des Spielers (<my-name>-tag) Name des Gegenspielers (<opponents-name>-tag) Zug des Gegenspielers (<opponents-turn>-tag) Netwerk-Datenströme (<administrator>-tag und <player>-tag) Versionsnummer (<version>-tag) Weitere XML-Formate Netzwerk-Protokoll Orientierung des Spielbretts Aufbau der Verbindung Austausch der Versionsnummern Austausch der Spielernamen Ablauf eines Spielzuges Ende des Spieles

3 1 Einleitung Im Software-Praktikum entwickeln Sie in kleinen Gruppen ein vollständiges Softwaresystem. Implementieren Sie das Brettspiel Kalaha. Ihre erste Implementierung soll eine graphische Benutzeroberfläche, einen Einzelspieler-Modus für das Spiel gegen eine künstliche Intelligenz, sowie einen Mehrspieler-Modus für das Spiel über ein TCP/IP-Netzwerk enthalten. In einem zweiten Release sollen die Regeln für das Spiel parametrisiert werden. 3

4 2 Kahala Kalaha ist ein modernes Spiel aus der Familie der Mancala Spiele, das von William Julius Champion 1940 erfunden wurde. Das Spielbrett besteht aus Mulden, in denen Spielsteine liegen. Ziel des Spiels ist es, die Spielsteine durch Umverteilen und Fangen der Spielsteine in der eigenen Gewinnmulde zu sammeln. Kalaha ist ein Spiel für zwei Mitspieler. 2.1 Spielfeld Das Spielfeld besteht aus zwei gegenüberliegenden Reihen von je sechs Spielmulden. Links und Rechts befindet sich je eine größere Gewinnmulde. Die untere Spielmuldenreihe und die rechte Gewinnmulde gehören einem Spieler, und die obere Spielmuldenreihe und die linke Gewinnmulde seinem Gegner. Abbildung 2.1 zeigt eine schematische Abbildung des Spielfeldes. 2.2 Regeln Am Anfang des Spieles werden sechs Spielsteine in jede Spielmulde gelegt. Die Gewinnmulden bleiben leer. Die Spieler sind abwechselnd am Zug. Ein Zug besteht aus der Auswahl einer eigenen Spielmulde, in der sich Spielsteine befinden. Die Spielsteine werden aus dieser Spielmulde entfernt, und reihum gegen den Uhrzeigersinn in die eigenen Spielmulden, die eigene Gewinnmulde, und die Spielmulden des Gegners verteilt. Die Gewinnmulde des Gegners wird übersprungen. Landet der letzte Spielstein in der eigenen Gewinnmulde, ist der selbe Spieler erneut am Zug. Landet der letzte Spielstein in einer eigenen, leeren Spielmulde, und befinden sich Spielsteine in der gegenüberliegenden Spielmulde des Gegners, werden sowohl der Spielstein, der in der eigene, leere Spielmulde gelandet ist, als auch alle Spielsteine in der gegenüberliegenden Spielmulde gefangen. Der Spieler legt sie in seine eigene Gewinnmulde. Wenn ein Spieler keinen Zug machen kann, weil alle seine Spielmulden leer sind, endet das Spiel. Die in den Spielmulden des Gegners verbliebenen Spielsteine werden in die Gewinnmulde des Gegners gelegt. Gewonnen hat der Spieler, der mehr Spielsteine in seiner Gewinnmulde gesammelt hat. 2.3 Beispiel Abbildung 2.2 zeigt die ersten sechs Züge eines möglichen Spieles. 4

5 Spielmulden des Gegners Gewinnmulde des Gegners eigene Gewinnmulde eigene Spielmulden Abbildung 2.1: Eine schematische Abbildung des Spielfeldes. 2.4 Variationen Folgt in einer späteren Version dieses Dokuments. 5

6 Spieler 1 beginnt das Spiel und wählt die fünfte Spielmulde aus. Spieler 2 wählt die sechste Spielmulde aus. Spieler 1 wählt die sechste Spielmulde aus. Spieler 2 wählt die sechste Spielmulde aus. Der letzte verteile Spielstein dieses Zuges fällt in die Gewinnmulde von Spieler 2. Spieler 2 darf noch einmal ziehen, und wählt die vierte Spielmulde aus. Spieler 1 wählt die fünfte Spielmulde aus. Der letzte verteile Spielstein dieses Zuges fällt in eine leere Spielmulde von Spieler 1 Spieler 1 fängt die Steine in seiner eigenen sechsten Spielmulde, und in der gegenüberliegenden ersten Spielmulde von Spieler 2 Abbildung 2.2: Die ersten sechs Züge eines möglichen Spieles. 6

7 3 Anwendungsfälle Die Anwendungsfälle in diesem Kapitel beschreiben die Interaktion eines Benutzers mit dem System. 3.1 Der Spielstart Die Anwendungsfälle in diesem Abschnitt beschreiben, wie ein Benutzer mit dem System interagiert, um ein neues Spiel zu starten, oder an einem Spiel eines entfernten Servers teilzunehmen Eröffnen eines Spieles Der Benutzer beginnt ein neues Spiel, indem die beiden beteiligten Spieler ausgewählt werden und die Spielregeln konfiguriert werden. Auslösendes Ereignis: ˆ Der Benutzer wählt Neues Spiel aus dem Hauptmenü. Teilschritte: 1. Auswahl der beteiligten Spieler (siehe Anwendungsfall 3.1.2). 2. Warten auf entfernte Spieler (siehe Anwendungsfall 3.1.3) 3. Konfiguration der Spielregeln (siehe Anwendungsfall 3.1.5) 4. Beginn des Spieles (siehe Anwendungsfall 3.1.6) Auswahl der beteiligten Spieler Der Benutzer wählt die beiden Spieler aus, die an einem Spiel teilnehmen. Zur Verfügung stehen jeweils lokale Spieler, entfernte Spieler und künstliche Intelligenzen. Teilschritte: 1. Auswahl der Spieler 2. Auswahl von Spiel konfigurieren 7

8 3.1.3 Warten auf entfernte Spieler Wenn entfernte Spieler ausgewählt wurden, wird nun darauf gewartet, daß sich diese Spieler verbinden. Dazu werden die notwendigen Verbindungsdaten (IP-Adresse und Port-Nummer) angezeigt (siehe Anwendungsfall 3.1.4). Auslösendes Ereignis: ˆ Benutzer wählt Spiel konfigurieren im Dialog zur Auswahl von Spielern, nachdem er entfernte Spieler ausgewählt hat. Nachbedingungen: ˆ Die Verbindung zu entfernten Spielern wurde aufgenommen. Ausnahmebedingungen: ˆ Kein entfernter Spieler nimmt eine Verbindung auf Teilnehmen an einem entfernten Spiel Der Benutzer nimmt an einem Spiel eines entfernten Servers teil, indem er die Verbindungsdaten (IP-Adresse und Port-Nummer) eingibt und die Verbindung zum entfernten Server aufnimmt. Auslösendes Ereignis: ˆ Der Benutzer wählt An Spiel teilnehmen aus dem Hauptmenü. Teilschritte: 1. Der Benutzer gibt die Verbindungsdaten ein. 2. Die Verbindung wird aufgenommen. Ausnahmebedingungen: ˆ Die Verbindung kann nicht aufgenommen werden. Nachbedingungen: ˆ Die Verbindung wurde aufgenommen Konfiguration der Spielregeln Der Benutzer konfiguriert die Spielregeln. Dazu tauschen alle an einem Spiel beteiligten Spieler Informationen über die unterstützten Konfigurationseinstellungen aus, um ein gemeinsames Subset von unterstützten Konfigurationseinstellungen zu ermitteln. 8

9 Auslösendes Ereignis: ˆ Benutzer wählt Spiel konfigurieren im Dialog zur Auswahl von Spielern, und alle entfernten Spieler haben sich verbunden. Vorbedingungen: ˆ Alle Spieler sind ausgewählt und verbunden. Ausnahmebedingungen: ˆ Spieler reagieren nicht. ˆ Es gibt keine Konfigurationseinstellung, die von allen beteiligten Spielern unterst ützt wird. Nachbedingungen: ˆ Die ausgewählte Konfigurationseinstellung wird von allen beteiligten Spielern unterstützt Beginn des Spieles Das Spiel beginnt. Auslösendes Ereignis: ˆ Der Benutzer wählt Spiel starten im Konfigurationsdialog. Vorbedingungen: ˆ Alle Spieler sind ausgewählt und verbunden. ˆ Das Spiel ist vollständig konfiguriert. Nachbedingungen: ˆ Das Spiel läuft. ˆ Spieler 1 ist am Zug. Teilschritte: 1. Das Spielbrett wird initialisiert. 2. Alle Spieler werden über die Spielregeln und das Spielbrett informiert. 3. Spieler 1 wird aufgefordert, seinen Zug zu machen. 9

10 3.2 Der Spielzug Die Anwendungsfälle in diesem Abschnitt beschreiben, wie ein Benutzer mit dem System interagiert, um einen Spielzug zu machen Gegnerischer Spielzug Der Spielzug des Gegners wird auf dem angezeigten Spielbrett dargestellt. Auslösendes Ereignis: ˆ Der Gegner hat einen Spielzug gemacht. Vorbedingungen: ˆ Das Spiel läuft. ˆ Der Gegner ist am Zug. Nachbedingungen: ˆ Das angezeigte Spielbrett entspricht der Spielsituation nach dem Zug des Gegners Eigener Spielzug Der Spieler macht seinen Zug, indem er auf die Mulde im angezeigten Spielbrett klickt, aus der er alle Steine entfernen will, um sie reihum zu verteilen. Der Spielzug wird auf dem angezeigten Spielbrett dargestellt. Auslösendes Ereignis: ˆ Der Benutzer klickt auf eine Mulde. Vorbedingungen: ˆ Das Spiel läuft. ˆ Der Spieler ist am Zug. ˆ Die ausgewählte Mulde enthält Steine. ˆ Die aktuellen Spielregeln erlauben, diese Mulde auszuwählen. 3.3 Kommandozeilen-Interface Die Anwendungsfälle in diesem Abschnitt beschreiben, welche Funktionen direkt über die Kommandozeile aufgerufen werden können. 10

11 3.3.1 Betrieb als entfernter Bot Das Programm verbindet sich zu einem entfernten Server und spielt als Bot, gesteuert durch eine künstliche Intelligenz. Auslösendes Ereignis: ˆ Der Benutzer startet das Programm mit der Kommandozeilen-Option --bot <ip>:<port>. Ausnahmebedingungen: ˆ Die Verbindung zum Server kann nicht aufgenommen werden. ˆ Während des Spieles tritt tritt ein Problem auf. Teilschritte: 1. Verbinden zum angegebenen Server. 2. Spielen Betrieb als Dedicated Server Das Programm akzeptiert Verbindungen von zwei entfernten Spielern und läßt sie gegeneinander spielen. Auslösendes Ereignis: ˆ Der Benutzer startet das Programm mit der Kommandozeilen-Option --server <port1> <port2>. Ausnahmebedingungen: ˆ Die Verbindung zum Server kann nicht aufgenommen werden. ˆ Während des Spieles tritt ein Problem auf. Teilschritte: 1. Warten auf eine eingehende Verbindung an <port1>. 2. Warten auf eine eingehende Verbindung an <port2>. 3. Vermittlung eines Spieles zwischen den Spielern <port> und <port2>. 11

12 4 XML-Formate In diesem Kapitel werden die XML-Formate für Konfigurationseinstellungen, Spielsituationen und Spielzüge beschrieben. Diese Formate werden für die Netzwerk-Kommunikation (siehe Kapitel 5) benötigt. 4.1 Verteilung der Spielsteine auf dem Spielfeld (<board>-tag) <!-- distribution of tokens on a board --> <!ELEMENT board (mine, yours)> <!ELEMENT mine (store, bucket*)> <!ELEMENT yours (store, bucket*)> <!ELEMENT store (#PCDATA)> <!ELEMENT bucket (#PCDATA)> Die Verteilung der Spielsteine auf dem Spielfeld wird durch das <board>-tag beschrieben. Ein Spielfeld wird immer aus der Sicht eines der beiden Spieler beschrieben. Daher hat das <board>-tag zwei Subtags: Das <mine>-tag beschreibt den eigenen Teil des Spielfeldes, und das <yours>-tag beschreibt den gegnerischen Teil des Spielfeldes. Diese Tags enthalten jeweils einen <store>-tag und soviele<bucket>-tag, wie eine Reihe des Spielfeldes Mulden enthält. Diese Tags beschreiben, wieviele Steine in der Gewinnmulde bzw. in der jeweiligen Spielmulde liegen. Die <bucket>-tags sind dabei in der Reihenfolge angeordnet, in der beim Spielzug die Steine verteilt werden. Zum Beispiel wir das Spielfeld durch folgenden XML-Baum beschrieben. <board> <mine> <store>14</store> <bucket>5</bucket> <bucket>2</bucket> <bucket>1</bucket> 12

13 <bucket>1</bucket> <bucket>0</bucket> <bucket>2</bucket> </mine> <yours> <store>26</store> <bucket>3</bucket> <bucket>1</bucket> <bucket>5</bucket> <bucket>9</bucket> <bucket>3</bucket> <bucket>0</bucket> </yours> </board> 4.2 Aufforderung zur Abgabe eines Spielzuges (<your-turn>-tag) <!-- a request to play a turn --> <!ELEMENT your-turn (board)> Die Aufforderung, einen Spielzug abzugeben, wird durch das <your-turn>-tag beschrieben. Es enthält ein <board>-tag, das die Verteilung der Spielsteine auf dem Spielfeld aus der Sicht desjenigen Spielers beschreibt, der aufgefordert wird, seinen Zug abzugeben. 4.3 Spielzug (<my-turn>-tag) <!-- a turn --> <!ELEMENT my-turn (my-store my-bucket your-store your-bucket)> <!ELEMENT my-store EMPTY> <!ELEMENT my-bucket (#PCDATA)> <!ELEMENT your-store EMPTY> <!ELEMENT your-bucket (#PCDATA)> Der Spielzug eines Spielers wird durch ein <my-turn>-tag beschrieben. Es enthält eine Beschreibung der Mulde, die der Spieler ausgewählt hat. Diese Beschreibung ist aus der Sicht des Spielers zu verstehen, der den Zug gemacht hat. Das <my-store>-tag bezeichnet die eigene Gewinnmulde, das <my-bucket>-tag bezeichnet eine der eigenen Spielmulden. Die Spielmulden werden dabei in derselben Reihenfolge nummeriert, wie sie auch im <mine>-tag erscheinen. Zum Beispiel wird der Zug, die erste eigene Spielmulde auszuwählen, als <my-turn><my-bucket>1</my-bucket></my-turn> repräsentiert. Entsprechend bezeichnen das <your-store>-tag und das <your-bucket>-tag die Gewinnmulde und die Spielmulden des Gegners. 13

14 4.4 Ergebnis eines Spielzuges (<turn-result>-tag) <!-- the result of playing a turn --> <!ELEMENT turn-result (end-of-turn another-turn illegal-turn)> <!ELEMENT end-of-turn (board)> <!ELEMENT another-turn (board)> <!ELEMENT illegal-turn EMPTY> Das Ergebnis eines Spielzuges wird durch das <turn-result>-tag beschrieben. Ein Spielzug kann drei mögliche Ergebnisse haben: Erstens werden ungültige Spielzuge durch das <illegal-turn>-tag gekennzeichnet. Zweitens werden gültige Spielzüge, nach denen derselbe Spieler noch einmal am Zug ist, durch das <another-turn>-tag gekennzeichnet. Und drittens werden die übrigen gültigen Spielzüge durch das <end-of-turn>-tag gekennzeichnet. Sowohl das <end-of-turn>- als auch das <another-turn>-tag enthalten eine Beschreibung der Spielsteine auf dem Spielfeld nach dem Zug aus der Sicht des Spielers, der den Zug gemacht hat. 4.5 Ergebnis eines Spieles (<score>-tag) <!-- game results --> <!ELEMENT score (i-win you-win draw still-playing)> <!ELEMENT i-win (board)> <!ELEMENT you-win (board)> <!ELEMENT draw (board)> <!ELEMENT still-playing EMPTY> Der Ausgang eines Spieles wird durch das <score>-tag beschrieben. Spielausgänge werden immer aus der Sicht eines der Spieler beschrieben. Das <i-win>-tag bedeutet, daß dieser Spieler gewonnen hat. Das <you-win>-tag bedeutet, daß dieser Spieler verloren hat. Das <draw>-tag bedeutet, daß das Spiel unentschieden ausgegangen ist, und das <still-playing>-tag bedeutet, daß das Spiel noch gar nicht zu Ende ist. Die <i-win>-, <you-win> und <draw>-tags enthalten die Verteilung des Spielsteine auf dem Spielfeld am Ende des Spieles. 4.6 Spielfeld und -zug (<board-and-turn>-tag) <!-- a board and a turn --> <!ELEMENT board-and-turn (board, my-turn)> Die Verteilung der Spielsteine auf dem Spielfeld aus der Sicht eines Spielers zusammen mit einem Zug desselben Spielers werden durch das <board-and-turn>-tag beschrieben. 14

15 4.7 Mehrere Spielzüge (<my-turns>-tag) <!-- a list of turns --> <!ELEMENT my-turns (my-turn*)> Eine Menge von möglichen Zügen desselben Spielers werden durch das <my-turns>- Tag beschrieben. Die Züge sollen dabei in derselben Reihenfolge geordnet sein, wie auch Spielsteine verteilt werden, beginnend mit der ersten Spielmulde des Spielers. 4.8 Name des Spielers (<my-name>-tag) <!-- the name of a player --> <!ELEMENT my-name (#PCDATA)> Der Name eines Spielers wird durch das <my-name>-tag repräsentiert. Es enthält den Namen als Text. 4.9 Name des Gegenspielers (<opponents-name>-tag) <!-- the name of the player s opponent --> <!ELEMENT opponents-name (#PCDATA)> Der Name des Gegenspielers wird durch das <opponents-name>-tag repräsentiert. Es enthält den Namen als Text Zug des Gegenspielers (<opponents-turn>-tag) <!-- what the opponent did --> <!ELEMENT opponents-turn (my-turn, turn-result)> Der Zug des Gegenspielers wird durch das <opponents-turn>-tag repräsentiert. Es enthält den Zug des Gegenspielers, und das Ergebnis des Zuges des Gegenspielers Netwerk-Datenströme (<administrator>-tag und <player>-tag) <!-- the stream an administrator sends over the network --> <!ELEMENT administrator ( version, opponents-name, ((your-turn, turn-result) opponents-turn)*, score )> 15

16 <!-- the stream a player sends over the network --> <!ELEMENT player ( version, my-name, my-turn* )> Das <administrator>-tag und das <player>-tag sind die Wurzelelemente für das Netzwerkprotokoll, siehe Kapitel Kapitel Versionsnummer (<version>-tag) <!-- version information --> <!ELEMENT version (#PCDATA)> Eine Versionsnummer wird durch das <version>-tag repräsentiert. Der Inhalt des Tags soll eine Dezimalzahl ohne Nachkommastellen sein, zum Beispiel <version>1</version> Weitere XML-Formate Folgt in einer späteren Version dieses Dokuments. 16

17 5 Netzwerk-Protokoll In diesem Kapitel wird das Netzwerk-Protokoll zur Kommunikation mit einem entfernten Spieler beschrieben. Das Netzwerk-Protokoll basiert auf dem Austausch von XML-Daten über einen bidirektionalen TCP/IP-Stream. Über diesen Stream kommunizieren zwei Parteien: Ein Administrator und ein Spieler. Die Parteien tauschen Nachrichten über den TCP/IP-Stream aus. Jede Partei sendet dabei insgesamt ein XML-Dokument. Der Administrator sendet ein XML-Dokument mit Wurzelelement <administrator>-tag, und der Spieler sendet ein XML-Dokument mit Wurzelelement <player>-tag. Die einzelnen Nachrichten sind XML-Tags unterhalb der <administrator>- bzw. <player>-tags. Die Parteien können natürlich die XML-Daten nicht als vollständiges Dokument verschicken, sondern müssen aufeinander reagieren. Zum Beispiel wartet ein Spieler auf das <your-turn>-tag des Administrators, entscheidet sich dann für einen Zug, und antwortet dem Administrator mit einem <my-turn>-tag. 5.1 Orientierung des Spielbretts Ein Spieler kann immer davon ausgehen, daß seine Hälfte des Spielbretts durch das <mine>-tag beschrieben wird, daß seine Spielmulden durch das <my-bucket>-tag beschrieben werden, daß seine Gewinnmulde durch das <my-store>-tag beschrieben wird, und daß <i-win>-tag bedeutet, daß er gewonnen hat. Der Administrator muß Spielbretter, Spielzüge und Spielergebnisse also passend kodieren, je nachdem, mit welchem der beiden Spieler er kommunziert. 5.2 Aufbau der Verbindung Der Administrator akzeptiert Verbindungen an einem Port. Der Spieler eröffnet eine Verbindung zu diesem Port. Es ist nicht Bestandteil dieses Protokolls, woher der Spieler Adresse und Port des Administrator kennt. Diese Daten müssen also unabhängig von diesem Protokoll vereinbart werden. Nachdem die Verbindung aufgebaut wurde, sendet der Administrator <administrator> und der Spieler sendet <player>. 5.3 Austausch der Versionsnummern Als erste Nachricht senden beide Parteien die höchste unterstütze Versionsnummer dieses Protokolls (<version>-tag). Die aktuelle Versionsnummer ist 1. 17

18 Jede Partei liest die Versionsnummer der anderen Partei und berechnet das Minimum der eigenen und der fremden Versionsnummer. In der weiteren Kommunikation dürfen nur Features verwendet werden, die in dieser minimalen Version dieses Protokolls definiert sind, die von beiden Parteien unterstützt wird. 5.4 Austausch der Spielernamen Der Spieler sendet als zweite Nachricht seinen Namen (<my-name>-tag). Der Administrator sendet als zweite Nachricht den Namen des Gegenspielers (<opponents-name>-tag). 5.5 Ablauf eines Spielzuges Nach dem Austausch der Spielernamen beginnen die Spielzüge. Ein Spielzug wird immer durch den Administrator initiiert. Einer der Spieler ist am Zug, der andere ist nicht am Zug. Der Administrator kommuniziert bei jedem Spielzug mit beiden Spielern. Im Ergebnis des Zuges sollen die Regeln für das Ende des Spieles noch nicht berücksichtigt werden. Nach dem Spielzug beginnt sofort der nächste Spielzug, oder das Spiel endet. Der Administrator fragt den Spieler, der am Zug ist, nach seinem Zug (<your-turn>- Tag). Der Spieler antwortet mit seinem Zug (<my-turn>-tag). Der Administrator antwortet mit dem Ergebnis des Zuges (<turn-result>-tag). Der Administrator schickt den Zug des Spielers, der am Zug ist, an den Spieler, der nicht am Zug ist (<opponents-turn>-tag). 5.6 Ende des Spieles Nach dem letzten Spielzug sendet der Administrator das Spielergebnis an die Spieler (<score>-tag). Dabei kann das <still-playing>-tag nicht vorkommen. Dann sendet der Administrator das abschließende </administrator>, die Spieler senden das abschließende </player>, und alle Parteien schließen die Verbindung. 18