Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen der Seite angezeigt.

Link zu der Vergleichsansicht

Beide Seiten, vorherige Überarbeitung Vorherige Überarbeitung
Nächste Überarbeitung		 Vorherige Überarbeitung
ef_informatik:game-server_block [2021-08-31 07:31] – [3.2 Technische Vorgaben] hofef_informatik:game-server_block [2021-10-05 13:41] (aktuell) – [Rundenbasierter Gameserver mit REST-API] hof
Zeile 1: Zeile 1:
 ====== Rundenbasierter Gameserver mit REST-API ====== ====== Rundenbasierter Gameserver mit REST-API ======
  
-===== - Organisation =====+Die ganze Dokumentation findet sich mittlerweile auf https://github.com/JungleState/ksr_junglestate 
 +===== - Organisation & Ablauf =====
  
-Alle Talenta/EF Schüler:innen bilden zusammen eine Projektorganisation, um einen Game-Server zu realisieren. Die Lehrperson hat dabei zwei Rollen: einerseits vertritt sie die Auftraggeberin, die **JungleState Inc**, andererseits fungiert sie als Projekt-Coach. +Alle Talenta/EF Schüler:innen gründen zusammen die Software-Firma **CanopySoft Corp**, um einen Game-Server zu realisieren. Die Lehrperson hat dabei zwei Rollen: einerseits vertritt sie die Auftraggeberin, die **JungleState Inc**, andererseits fungiert sie als Projekt-Coach.
- +
-===== - Ablauf =====+
  
 Die Umsetzung folgt der Entwicklung in einer Software-Firma: Die Umsetzung folgt der Entwicklung in einer Software-Firma:
Zeile 13: Zeile 12:
     * Einreichung des Proposals inkl. Komponentenplanung und Zeitplan     * Einreichung des Proposals inkl. Komponentenplanung und Zeitplan
   - Implementierungsphase (5w)   - Implementierungsphase (5w)
-    * Umsetzung gemässe Projektplan +    * Umsetzung gemäss Proposal 
-    * Alle Artefakte werden in Github abgelegt. +    * Alle Artefakte werden in Github abgelegt: 
-    * Nach jeder Woche erwartet die Auftraggeberin einen kurzen Report mit folgendem Inhalt:+      * Quellcode 
 +      * Dokumentation (als Markdown) 
 +      * Issues (Implementierungseinheiten) 
 +      * Milestones (jede Woche einer) 
 +    * Nach jeder Woche erwartet die Auftraggeberin einen kurzen Email-Report mit folgendem Inhalt:
       * Projektfortschritt       * Projektfortschritt
       * Ist vs. Soll: Wo steht das Projekt im Vergleich zum Zeitplan?       * Ist vs. Soll: Wo steht das Projekt im Vergleich zum Zeitplan?
Zeile 30: Zeile 33:
 ===== - Requirements ===== ===== - Requirements =====
  
-Es wird ein Game-Server implementiert, der remote Clients in einem rundenbasierten Game gegeneinander spielen lässt.+JungleState möchte einen Game-Server entwickeln lassen, der remote Clients in einem rundenbasierten Game gegeneinander spielen lässt. Die //Requirements// definieren die Vorgaben zum Spiel und zur gewählten Technologie.
  
 ==== - Spielbeschrieb ==== ==== - Spielbeschrieb ====
Zeile 46: Zeile 49:
 Jeder Affe erhält zu Beginn der Runde seinen einsehbaren Teilbereich des Urwalds. Dieser beträgt typischerweise 5x5 Felder um die Position des Affen. Der Affe entscheidet sich für eine Aktion, entweder ''MOVE'' oder ''THROW_COCONUT'' in einer der 8 Richtungen. Kokosnüsse fliegen nur ein Feld weit. Jeder Affe erhält zu Beginn der Runde seinen einsehbaren Teilbereich des Urwalds. Dieser beträgt typischerweise 5x5 Felder um die Position des Affen. Der Affe entscheidet sich für eine Aktion, entweder ''MOVE'' oder ''THROW_COCONUT'' in einer der 8 Richtungen. Kokosnüsse fliegen nur ein Feld weit.
  
-Wird ein Affe von einer Kokosnuss getroffen, wird seine Lebensenergie um eine bestimmte Menge verringert. Fällt die Lebensenergie eines Affen auf null, fällt er ohnmächtig vom Ast und scheidet aus((Selbstverständlich erwachen alle ohnmächtige Affen nach dem Spielende ohne bleibende Schäden zu erleiden. Bei der Entwicklung dieses Spiels kamen keine Tiere zu Schaden!)).+Wird ein Affe von einer Kokosnuss getroffen, wird seine Lebensenergie um eine bestimmte Menge verringert. Fällt die Lebensenergie eines Affen auf null, fällt er ohnmächtig vom Ast und scheidet aus((Selbstverständlich erwachen alle ohnmächtige Affen nach dem Spielende ohne bleibende Schäden zu erleiden. Bei der Entwicklung dieses Spiels dürfen keine Tiere zu Schaden kommen!)).
  
 Kollidieren zwei Affen oder ein Affe und der Dickicht, verringert sich die Lebensenergie ebenfalls, die Affen bleiben auf ihrem Feld stehen. Kollidieren zwei Affen oder ein Affe und der Dickicht, verringert sich die Lebensenergie ebenfalls, die Affen bleiben auf ihrem Feld stehen.
Zeile 67: Zeile 70:
  
 === - Server === === - Server ===
-Der Server wird als [[https://de.wikipedia.org/wiki/Representational_State_Transfer|REST]]-API definiert und implementiert.    +Der Server wird als [[https://de.wikipedia.org/wiki/Representational_State_Transfer|REST]]-API definiert und implementiert. Das API soll mit der Anfangsanfrage mitgeliefert werden ([[https://de.wikipedia.org/wiki/Representational_State_Transfer#Beispiel|HATEOS]]). 
-  * Die Abfrage des Spielzustands soll mittels Long-Polling (ev. [[https://en.wikipedia.org/wiki/WebSocket|Websockets]]) umgesetzt werden: der Client fragt den Zustand an, die Antwort erfolgt erst, wenn die Runde zuende ist.+  * Die Abfrage des Spielzustands soll mittels Long-Polling (ev. [[https://en.wikipedia.org/wiki/WebSocket|Websockets]] in [[https://gitlab.com/pgjones/quart|Quart]]) umgesetzt werden: der Client fragt den Zustand an, die Antwort erfolgt erst, wenn die Runde zuende ist.
   * Der Server unterstützt zusätzlich zum Client-Zugang über einen privilegierten Zugang, um das gesamte Spielfeld zu visualisieren.   * Der Server unterstützt zusätzlich zum Client-Zugang über einen privilegierten Zugang, um das gesamte Spielfeld zu visualisieren.
   * Es werden verschiedene Spielfelder unterstützt (default, Testumgebung, Schwierigkeitsgrade...).   * Es werden verschiedene Spielfelder unterstützt (default, Testumgebung, Schwierigkeitsgrade...).
   * Ein Spiel soll von bis zu 50 Clients gleichzeitig gespielt werden können.   * Ein Spiel soll von bis zu 50 Clients gleichzeitig gespielt werden können.
 +  * Clients, die zulange mit der Antwort zuwarten, werden aus dem Spiel ausgeschlossen.
  
 === - Client === === - Client ===
 Clients greifen ausschliesslich über das REST-API auf ein Spiel zu. Zum Lieferumfang gehören: Clients greifen ausschliesslich über das REST-API auf ein Spiel zu. Zum Lieferumfang gehören:
   * Ein Beispiel-Client auf C#-Basis, der einen einfachen Affen-Agenten implementiert (z.B. einer, der jede zweite Runde in einer zufälligen Richtung geht und auf alles in der Umgebung schiesst).    * Ein Beispiel-Client auf C#-Basis, der einen einfachen Affen-Agenten implementiert (z.B. einer, der jede zweite Runde in einer zufälligen Richtung geht und auf alles in der Umgebung schiesst). 
-  * Ein Konsolen- oder Web-Client-Programm, das die manuelle Steuerung eines Affen erlaubt.+  * Ein Konsolen- oder Web-Client-Programm für Testzwecke, das die manuelle Steuerung eines Affen erlaubt.
     * Die Steuerung soll über Tastatureingabe erfolgen.     * Die Steuerung soll über Tastatureingabe erfolgen.
   * Eine Visualisierung als Web-App, die das gesamte Spielfeld abbildet, um Spiele live verfolgen zu können.   * Eine Visualisierung als Web-App, die das gesamte Spielfeld abbildet, um Spiele live verfolgen zu können.
-    * Die App soll den Namen //Dschungelcamp// tragen.+    * Die App soll den Namen //Jungle Camp// tragen.
  
-=== - Proposal === +===== - Proposal ===== 
-Die Gruppe erarbeitet ein Proposal um die obigen Requirements umzusetzen. Das Proposal beinhaltet die folgende Angaben:+Die Gruppe erarbeitet ein Proposal um die obigen Requirements umzusetzen. Das Proposal beinhaltet die folgenden zwei Teile:
  
-  * Design: +=== Design === 
-    * Technologie-Stack auf Server und Client: +Das Design wird als Markdown-Dokument auf Github gestellt. Es beinhaltet: 
-      * Vorgeschlagene Technologie / Plattform+    * Aufteilung des Systems in **Komponenten**: 
 +      * Server: Spiel-Management, Gameplay, Benutzeridentifizierung 
 +      * Client: Beispiel-Client, API-Code für andere Schüler 
 +      * Visualisierung: UI, Schnittstellen...
       * Diagramm der Hauptbestandteile       * Diagramm der Hauptbestandteile
-      * ev. Abwägung von verschiedenen Möglichkeiten. 
     * zu implementierende REST-Endpunkte mit folgenden Angaben:     * zu implementierende REST-Endpunkte mit folgenden Angaben:
       * Ressourcenname mit allen Parametern (z.B. ''/gamestate/game123'')       * Ressourcenname mit allen Parametern (z.B. ''/gamestate/game123'')
Zeile 94: Zeile 100:
       * Rückgabe-Wert und Format (meist JSON)       * Rückgabe-Wert und Format (meist JSON)
     * Schnittstellenbeschreibung zwischen Komponenten (z.B. JSON-Format).     * Schnittstellenbeschreibung zwischen Komponenten (z.B. JSON-Format).
-  * Komponentenaufteilung: +    * Technologie-Stack auf Server und Client: 
-    * Wie lässt sich das System in Komponenten aufteilen? +      * Vorgeschlagene Technologie / Plattform 
-      * Server: Spiel-Management, Gameplay, Benutzeridentifizierung +      * ev. Abwägung von verschiedenen Möglichkeiten. 
-      * Client: Beispiel-Client, API-Code für andere Schüler +=== Ausführungsplan === 
-      * Visualisierung: UI, Schnittstellen... +Die Umsetzung wird in kleinere Einheiten, sogenannte **Tasks** aufgeteilt, die in maximal einer Woche umsetzbar sein sollten. Für jede Woche wird in Github ein **Milestone** erstellt, und für jeden //Task// wird ein Github **Issue** erstellt. Zumindest für die ersten Wochen sollten die Tasks auf den passenden Milestone eingeteilt werden. 
-    * Wie lässt sich die Umsetzung der Komponenten in **Tasks** aufteilen? Zum Beispiel: + 
-      * Git Repo einrichten und Projekt-Layout definieren. +Gibt es Abhängigkeiten zwischen den Tasks? Wie gross sind die Tasks (1, 2, 3, 5 Stunden)? 
-      * JSON-Schnittstelle für ein Game definieren. + 
-      * Game-Logik in Python implementieren. +Beispiel-Tasks: 
-      * Einfache Game-Verwaltung mit Sessions implementieren. +  * Git Repo einrichten und Projekt-Layout definieren. 
-      * ... +  * JSON-Schnittstelle für ein Game definieren. 
-    * Gibt es Abhängigkeiten zwischen den Tasks? +  * Game-Logik in Python implementieren. 
-    * Wie gross sind die Tasks (1, 2, 3, 5 Stunden)?+  * Einfache Game-Verwaltung mit Sessions implementieren. 
 +  * ... 
  
  
Zeile 116: Zeile 124:
     * ML-Schnittstelle: erlaubt es, eine ML-Learner zu trainieren, der die optimale Spielstrategie herausfindet (entweder mit Zielwert-Learning oder mittels [[https://de.wikipedia.org/wiki/Generative_Adversarial_Networks|Generative Adversarial Networks]])     * ML-Schnittstelle: erlaubt es, eine ML-Learner zu trainieren, der die optimale Spielstrategie herausfindet (entweder mit Zielwert-Learning oder mittels [[https://de.wikipedia.org/wiki/Generative_Adversarial_Networks|Generative Adversarial Networks]])
     * Randomisierung: Kokosnüsse treffen nur mit Wahrscheinlichkeit x < 1 - damit wird das Spiel etwas weniger deterministisch.     * Randomisierung: Kokosnüsse treffen nur mit Wahrscheinlichkeit x < 1 - damit wird das Spiel etwas weniger deterministisch.
 +    * [[https://stackoverflow.com/questions/28795561/support-multiple-api-versions-in-flask/28797512|API-Versioning]]
  • ef_informatik/game-server_block.1630395073.txt.gz
  • Zuletzt geändert: 2021-08-31 07:31
  • von hof