diff --git a/README.md b/README.md index ae2d6e7..783e254 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,33 @@ # Werwolf - Flutter App ## Beschreibung -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. +Die "Werwolf" Flutter App wurde als Teil eines Gruppenprojekts von David Miller und Yusuf Can Özdemirkan entwickelt. Ziel der App ist es, das bekannte Partyspiel "Werwolf" digital nachzubilden und eine benutzerfreundliche Plattform zu bieten, die es Spielern ermöglicht, ohne komplizierte Anmeldungen oder Einstellungen zu spielen. ## Funktionalitäten -- **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. 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) +- **Anmeldungsfreier Zugang**: Spieler können sich ohne Anmeldung direkt über ein mehrfeldriges Formular registrieren. + +- **Spielerregistrierung**: Über das Formular können sich beliebig viele Spieler (mindestens 6) eintragen. +- **Konfiguration der Spielrunde**: Vor dem Spielbeginn lassen sich Anzahl und Arten der speziellen Rollen konfigurieren. + +- **Enthüllung der Rollen**: Nachdem alle Spieler eingetragen sind, wird durch Anklicken der Karte die Rolle der jeweiligen Person aufgedeckt. Dieser Vorgang wird wiederholt, bis alle Spieler ihre Rollen kennen. + + +- **Spielaktionen**: Die App ermöglicht es, den Tod von Spielern festzustellen und weitere Spielaktionen zu verwalten. + + + +- **Moderation und Sieg**: Der Moderator kann die Rollen der Spieler einsehen und bei einem Sieg der Dorfbewohner, Werwölfe oder des Jokers wird ein entsprechender Bildschirm angezeigt. + + ## Plattformunterstützung und Tests -Die Applikation benutzt keine plattformspezifischen Funktionen oder Bibliotheken, sollte daher überall laufen. Wir haben die App unter folgenden Plattformen getestet: +Die App ist plattformunabhängig konzipiert und wurde auf folgenden Plattformen getestet: - **Android** - **iOS** - **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. -- **Zusätzliche Parameter für Build/Test**: Keine besonderen Parameter erforderlich. +- **Integrationstests**: Befolge die untenstehenden Anweisungen zur Installation der Abhängigkeiten und Ausführung der Tests. ## Installation und Ausführung @@ -38,6 +37,7 @@ Die Applikation benutzt keine plattformspezifischen Funktionen oder Bibliotheken ### Installation 1. Klone das Repository: + ```bash git clone https://gitty.informatik.hs-mannheim.de/2011708/cpd_David_und_Yusuf 2. Wechsle in das Projektverzeichnis: