diff --git a/README.md b/README.md index 88abf70..ae2d6e7 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,27 @@ Die "Werwolf" Flutter App ist ein Projekt, das im Rahmen eines Gruppenprojekts von David Miller und Yusuf Can Özdemirkan entwickelt wurde. Das Ziel der App ist es, das bekannte Partyspiel "Werwolf" digital zu imitieren und eine benutzerfreundliche Plattform für Spieler bereitzustellen, um das Spiel ohne komplizierte Anmeldungen oder Einstellungen zu genießen. ## Funktionalitäten -- **Anmeldungsfreier Zugang**: Spieler müssen sich nicht anmelden, sondern können direkt über ein Formular mit mehreren Feldern teilnehmen. +- **Anmeldungsfreier Zugang**: Spieler müssen sich nicht anmelden, sondern können direkt über ein Formular mit mehreren Feldern teilnehmen. Siehe Bild: Werwolf Spiel +![Werwolf Spiel](images/spielerliste.png) - **Spielerregistrierung**: Das Formular ermöglicht es Spielern, sich einzutragen, wobei eine beliebige Anzahl von Spielern möglich ist (ab 6 Spieler). -- **Konfiguration der Spielrunde**: Vor Beginn des Spiels können Konfigurationen vorgenommen werden, wie die Anzahl und Art der speziellen Rollen im Spiel. -- **Enthüllung der Rollen**: Nachdem alle Spieler eingetragen sind und die Konfigurationen abgeschlossen sind, wird der Name der ersten Person angezeigt. Durch Anklicken der Karte wird dann die Rolle dieser Person aufgedeckt. Dieser Vorgang wird für jede Person wiederholt, bis alle Spieler und ihre Rollen angezeigt wurden. -- **Spielaktionen**: Die App bietet Funktionen, um den Tod von Spielern festzulegen und andere Spielaktionen durchzuführen. +- **Konfiguration der Spielrunde**: Vor Beginn des Spiels können Konfigurationen vorgenommen werden, wie die Anzahl und Art der speziellen Rollen im Spiel. Siehe Bild: Settings +![Settings](images/settings.png) +- **Enthüllung der Rollen**: Nachdem alle Spieler eingetragen sind und die Konfigurationen abgeschlossen sind, wird der Name der ersten Person angezeigt. (Siehe Bild Spieler) Durch Anklicken der Karte wird dann die Rolle dieser Person aufgedeckt. Dieser Vorgang wird für jede Person wiederholt, bis alle Spieler und ihre Rollen angezeigt wurden. (Siehe Bild Rolle) +![Spieler](images/spieler.png) +![Rolle](images/rolle.png) +- **Spielaktionen**: Die App bietet Funktionen, um den Tod von Spielern festzulegen und andere Spielaktionen durchzuführen. Siehe die Bilder Tag, Nacht und Tote Spieler für die Spielaktionen. +![Tag](images/spielfeld_tag.png) +![Nacht](images/spielfeld_nacht.png) +![Tote Spieler](images/tote_spieler.png) +- **Weiteres**: Der Moderator kann mit dem betätigen der Informationstaste die Rollen der Spieler nachschauen und wenn die Dorfbewohner/Werwölfe oder der Joker gewinnt wird ein Screen angezeigt. +![Moderator](spielerrollen_fuer_moderator.png) +![Win](images/winscreen.png) ## Plattformunterstützung und Tests Die Applikation benutzt keine plattformspezifischen Funktionen oder Bibliotheken, sollte daher überall laufen. Wir haben die App unter folgenden Plattformen getestet: - **Android** - **iOS** -- **Web** +- **MacOS** ### Besondere Hinweise zum Testen - **Integrationstests**: Um die Integrationstests auszuführen, folge den untenstehenden Anweisungen zur Installation der Abhängigkeiten und zum Ausführen der Tests. @@ -37,12 +47,9 @@ Die Applikation benutzt keine plattformspezifischen Funktionen oder Bibliotheken flutter pub get ### Ausführen der App -- **Android/iOS**: +- **Android/iOS/MacOS**: flutter run -- **Web**: - flutter run -d chrome - ## Tests ### Unit- und Widget-Tests ausführen diff --git a/images/flipcard_flipped.png b/images/rolle.png similarity index 100% rename from images/flipcard_flipped.png rename to images/rolle.png diff --git a/images/flipcards.png b/images/spieler.png similarity index 100% rename from images/flipcards.png rename to images/spieler.png