Skip to content
This repository has been archived by the owner on Apr 8, 2024. It is now read-only.

Update Konzept.md #22

Merged
merged 5 commits into from
Feb 11, 2018
Merged

Update Konzept.md #22

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5c7c626
Update Konzept.md
FrederikSchlemmer Jan 30, 2018
61ef781
Update Konzept.md
FrederikSchlemmer Feb 1, 2018
33bf953
Update Konzept.md
FrederikSchlemmer Feb 1, 2018
1be7f13
Update Konzept.md
FrederikSchlemmer Feb 8, 2018
610d58c
Changes after Review
RudiKl Feb 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 89 additions & 42 deletions Dokumentation/Konzept.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Konzeption des Simulationsspiels BrainySnake
# Dokumentation des Simulationsspiels BrainySnake

- [Konzeption des Simulationsspiels BrainySnake](#konzeption-des-simulationsspiels-brainysnake)
- [Dokumentation des Simulationsspiels BrainySnake](#dokumentation-des-simulationsspiels-brainysnake)
- [Spiel aus Sicht des Players](#spiel-aus-sicht-des-players)
- [Herausforderungen für die Entwickler der Agenten](#herausforderungen-f%C3%BCr-die-entwickler-der-agenten)
- [Technische Umsetzung](#technische-umsetzung)
- [Object: _PlayerStatus_](#object-playerstatus)
- [Object: _PlayerView_](#object-playerview)
- [Projektstrucktur (Gradle)](#projektstrucktur-gradle)
- [Objekt: _PlayerState_](#objekt-playerstate)
- [Objekt: _PlayerView_](#objekt-playerview)
- [Objekt: _RoundEvent_](#objekt-roundevent)
- [Projektstruktur (Gradle)](#projektstruktur-gradle)
- [Programmablauf](#programmablauf)
- [Simulationsablauf](#simulationsablauf)
- [Technische Herausforderungen](#technische-herausforderungen)
Expand All @@ -23,48 +24,91 @@ Der Agent wird von der Simulation nach seiner nächsten Aktion gefragt.

## Herausforderungen für die Entwickler der Agenten

1. Herausforderungen Stufe #1
1. **Herausforderungen Stufe #1**
1. Der Agent sollte seinen Status (PlayerStatus) von der Simulation entgegennehmen können und verstehen wo das Kopfelement ist und entsprechend handeln. Befindet sich das Kopfelement an der Position (0, 0) muss Agent
wissen, dass es nur eine gültige Zugrichtung gibt. Ebenso kann der Agent aus der Sicht nach vorne (PlayerStatus -> PlayerView) erkennen, dass die Elemente links und vorne Wandelemente sind (WallElement)
2. Der Angent kann seine Positionen selbst verwalten und liefert auf Anfrage der Simulation einen gültigen Zug.
2. Herausforderungen Stufe #2
2. **Herausforderungen Stufe #2**
1. Der Agent kann sich selbständig und strategisch in der Spielwelt bewegen und verfolgt eine Strategie.
Beispiel: Der Agent hält sich von gegnerischen Einheiten fern und beginnt frühzeitig mit dem Wachstum
3. Herausforderungen der Stufe #3
3. **Herausforderungen der Stufe #3**
1. Der Agent ist in der Lage das Verhalten der Gegner einzubeziehen.
4. Herausforderungen Stufe #4
4. **Herausforderungen Stufe #4**
1. Der Agent ist selbstlernend. Daher wird das Verhalten durch die Entwickler nicht mehr explizit vorgegeben.

## Technische Umsetzung
Jeder Agent implementiert das Interface BrainySnake, welches folgende Methoden vorgibt:
- **void handlePlayerStatusUpdate (PlayerStatus playerStatus)**
- Der Agent bekommt ein Update vom Spiel und kann damit sein Datenstand aktualisieren.
- **PlayerUpdate getPlayerUpdate()**
- Agent wird nach seinem nächsten Spielzug gefragt

### Object: _PlayerStatus_
- number movesPlayed _// Anzahl der gespielten Spielzüge_
- number movesRemaining _// Verbleibende Spielzüge in der Runden_
- number PlayerPoints _// Erspielte Punkte im Spiel (Länge der Schlange)_
- PlayerPosition head _// Kopf der Schlange (Position x und y)_
- PlayserPosition tail _// Ende der Schlange (Position x und y)_
- boolen gotPenalty _// Der Agent hat eine Strafe erhalten_
- GameEvent gameEvent _// Spielereignis pro Spielzug(Kollision mit Wand/Hindernis/sich selbst/Gegner, Schritt, Tod, Punkt Konsumiert)_
- PlayerView view _// Sicht des Spielers auf das Spielfeld(Sichtfeld)_
- boolean ghostmode _// Der Agent hat ein Schlangenelement gerammt und geht für x Züge in den Ghostmode. Der gerammte Agent verliert einen Punkt, welcher auf den Attackierer übergeht._

### Object: _PlayerView_
Der Agent erhält ein zweidimensionales Sichtfeld(x Felder breit und y Felder hoch), welches Koordinaten und Bezeichnung von allen Gegenständen enthält. Das Sichtfeld beginnt auf höhe des Kopfes (Kopfposition plus einen Schritt nach vorne).
Jedes **Field** innerhalb des **PlayerView** hat eine **Position** und kann ein **GameObject** enthalten.

## Projektstrucktur (Gradle)

Jeder Player (Agent) wird in ein **seperates Modul** auisgelagert welches in den Core improtiert wird.
Damit sollten keine Zugriffe auf fremden Code möglich sein.
Jedes Player Modul importierrt **playerCommon** indem gemeinsame Interfaces und Klassen liegen. (z.B. PlayerStatus, GameEvent und das BrainySnake Interface)

Jeder Agent implementiert das Interface **BrainySnakePlayer**, welches folgende Methoden vorgibt:
- **String getPlayerName()**
-- Agent wird nach dem gesetzten Spielernamen gefragt

- **boolean handlePlayerStatusUpdate (PlayerState playerState)**
-- Der Agent bekommt ein Update vom Spiel und kann damit seinen Datenstand aktualisieren.

- **PlayerUpdate tellPlayerUpdate ()**
-- Agent wird nach seinem nächsten Spielzug gefragt


### Objekt: PlayerState

Der Agent bekommt das Objekt PlayerState in seiner Methode *handlePlayerStatusUpdate()* übergeben. In dem Objekt kann der Zustand der eigenen Schlange abgefragt werden.

Übersicht der vorhandenen Daten:

| Name / Methode |Beschreibung|Datentyp|
|:----------------|:-------------------------------|:-----------------------------:|
|movesPlayed / getMovesPlayed()| Anzahl der gespielten Runden.|int
|movesRemaining / getMovesRemaining()|Anzahl der übrigen zu spielenden Runden.|int
|playerPoints / getPlayerPoints()|Aktuelle Spielerpunkte (Gesamtzahl von Kopf- und Körperteilanzahl).|int
|playersHead / getPlayersHead()|Aktuelle Position des Kopfes von der Schlange.|Point2D
|playersTail / getPlayersTail()|Aktuelle Position des Körpers von der Schlange. Es wird nur der letzte Punkt des Körpers zurückgegeben. Falls kein Körper vorhanden wird null zurückgegeben.|Point2D
|ghostModeActive / isGhostModeActive()|Zustand des GhostMode bei der Schlange (GhostMode aktiv = true, GhostMode inaktiv = false).|boolean
|ghostModeRemaining / getGhostModeRemaining()|Verbleibende Dauer von des aktiven GhostMode. Bei nicht aktivem GhostMode wir die definierte maximale Dauer zurückgegeben.|int
|bitByPlayer / isBitByPlayer()|Mit dieser Methode kann der Zustand über einen Biss an einem Spieler geprüft werden.|boolean
|moved / isMoved()|Mit dieser Methode kann der Zustand über die Bewegung der Schlage des Spielers geprüft werden.|boolean
|collisionWithLevel / isCollisionWithLevel()|Mit dieser Methode kann der Zustand über die Kollision der Schlage des Spielers mit dem Level geprüft werden.|boolean
|playerView / getPlayerView()|Die aktuelle Sicht der Schlange in dem Spielzug. Beinhaltet das Objekt PlayerView.|PlayerView


### Objekt: PlayerView

Der Agent erhält ein zweidimensionales Sichtfeld(viewWidth und viewRange), welches Koordinaten und Bezeichnung von allen Gegenständen enthält. Das Sichtfeld beginnt auf höhe des Kopfes (Kopfposition plus einen Schritt nach vorne). Jedes Field innerhalb des PlayerView hat eine Position und kann ein GameObject enthalten.

Übersicht der vorhandenen Daten:

| Name / Methode |Beschreibung |Datentyp |
|---------------- |------------------------------- |:-----------------------------:|
|currentOrientation/ getCurrentOrientation()| Aktuelle Orientierung der Schlange.|Orientation
|viewWidth / getViewWidth()|Feldbreite in Feldern aus Sicht der Schlange. Das Feld beginnt vor dem Kopf der Schlange. Die Aufteilung findet in gleichen Anteilen rechts und links der Schlange statt.|int
|viewRange / getViewRange()|Feldhöhe in Feldern aus Sicht der Schlange. Beginnend einen Punkt vor dem Kopf der Schlange.|int
|visibleFields / getVisibleFields()|Liste mit allen sichtbaren Feldern für die Schlange. Der erste Eintrag in der Liste mit dem Index 0 ist aus Sicht der Schlange der Punkt links oben.|List of Fields

### Objekt: RoundEvent

Jede Runde werden für die jeweiligen Schlangen verschiedene RoundEvents berechnet. Diese RoundEvents können im PlayerState ausgelesen werden.

Übersicht der vorhandenen Events:

| Name |Beschreibung |Abfragbar (siehe PlayerState)
|---------------- |------------------------------- |:-----------------:
|MOVED | Bewegung der Schlange. | true
|BIT_BY_PLAYER | Biss an der eigenen Schlange von einem anderen Spieler. | true
|COLLISION_WITH_LEVEL | Kollision mit Levelobjekten. | true
|CONFUSED | Verwirrung der Schlange durch ungültiges Update. | false
|BIT_AGENT | Biss von der eigenen Schlange an einem anderen Spieler. | false
|BIT_HIMSELF | Biss von der eigenen Schlange an sich selber. | false
|DIED | Löschung der Schlange aufgrund Punktestand. | false
|CONSUMED_POINT | Konsum von Spielpunkten. | false


## Projektstruktur (Gradle)

Jeder Player (Agent) wird in ein **seperates Modul** ausgelagert, welches in den Core importiert wird.
Diese Auslagerung verhindert den Zugriff von den Agenten auf fremden Code.
Jedes Player Modul implementiert das Interface **BrainySnakePlayer** und importiert das Package **playerCommon**, welches das Interface und die Klassen beinhaltet (z.B. PlayerStatus, GameEvent und das BrainySnake Interface).

Modul | Beschreibung | Includes
--------- | ------------------ |--------
--------- | ------------------ |:--------:
desktop | Starter für die Anwendung | core
core | Logik der Simulation | SamplePlayer, PlayerOne, PlayerTwo, ...
playerCommon | Klassen, Interfaces, Enums die alle Agenten brauchen | junit
Expand Down Expand Up @@ -92,20 +136,23 @@ playerOne | Spieler (Agent) der zu Implementieren ist | player
## Technische Herausforderungen
### Der Agent antwortet nicht

__Problem:__ Fehler, der auftreten kann, wenn der Agent verschuldet oder unverschuldet in einer Endlosschleife läuft
**Präventiv Lösung:** Unit-Tests schreiben
__Problem:__ Fehler, der auftreten kann, wenn der Agent verschuldet oder unverschuldet in einer Endlosschleife läuft.

**Präventiv Lösung:** Unit-Tests schreiben.

**Laufzeit Lösung:** Der Aufruf jedes Agenten erfolgt ein eigenem Thread, welcher nach einer angemessenen Zeit terminiert, sofern keine Antwort eingegangen ist.
Der Agent wird eingefroren (PlayerStatus frozen), wechselt zur Kennzeichnung des Status die Farbe und es werden zu diesem Zug keine Aktionen für diesen Agenten ausgeführt.

### Der Agent greift auf Fremden Code zu
**Problem:** Der Agent könnte **Public Methoden** der Simulation der oder die **Public Methoden** anderer Agenten zugreifen.
__Problem:__ Der Agent könnte auf **Public Methoden** der Simulation oder die **Public Methoden** anderer Agenten zugreifen.
Denkbar sind auch **Reflections** mit der Private Methoden aufgerufen werden.

**Präventiv Lösung:** Wir verbieten das und kontrollieren den Quellcode der Agenten

**Laufzeit Lösung:**

1. Die Simulation verwendet **keine öffentlichen Interfaces**, die Agenten werden von der Simulation aufgerufen.
1. Jeder Agent bekommt ein eigens Paket
1. **TODO:** Gibt es weitere Möglichkeiten Code zu isolieren?
- Die Simulation verwendet **keine öffentlichen Interfaces**, die Agenten werden von der Simulation aufgerufen.
- Jeder Agent bekommt ein eigenes Paket

## Glossar
- Ghostmode: Im Ghostmode kann der Agent keine Aktionen ausfürhen außer sich zu bewegen