diff --git a/README.md b/README.md index e1ec88e..4808ead 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,64 @@ -# bubbletwist +# Bubble-Twist -A Candy Crush Clone \ No newline at end of file +Bubble-Twist ist ein Puzzle-Spiel, das auf dem beliebten Candy Crush basiert. In diesem Spiel +besteht das Ziel darin, benachbarte Steine durch anklicken zu vertauschen, um eine Reihe von drei +oder mehr +gleichfarbigen Steinen zu bilden und so Punkte zu sammeln. + +## Installation + +Stelle sicher, dass du [Flutter](https://flutter.dev) auf deinem System installiert hast. + +1. Klone das Repository: + ```bash + git clone https://gitty.informatik.hs-mannheim.de/3011340/bubbletwist.git + ``` +2. Wechsle in das Projektverzeichnis: + ```bash + cd bubbletwist + ``` +3. Installiere die Abhängigkeiten: + ```bash + flutter pub get + ``` +4. Starte die App: + ```bash + flutter run + ``` + +## Spielanleitung + +### Ziel des Spiels + +Vertausche benachbarte Steine, um eine Reihe von drei oder mehr gleichfarbigen Steinen zu bilden. Je +mehr Steine du in einer Reihe hast, desto mehr Punkte erhältst du. Das Spiel endet, wenn die Zeit +abgelaufen ist. + +### Steuerung + +- **Tippen**: Tippe auf einen Stein, um ihn auszuwählen. Tippe anschließend auf einen benachbarten + Stein, um die beiden Steine zu vertauschen. + +## Spielmerkmale + +- **8x8 Gitter**: Ein Spielfeld mit 8 Reihen und 8 Spalten. +- **Verschiedene Farben**: Steine in verschiedenen Farben (Rot, Grün, Blau, Gelb, Pink). +- **Punkteanzeige**: Verfolge deinen Punktestand während des Spiels. +- **Timer**: Ein Timer zeigt an, wie viel Zeit noch übrig ist. +- **Game Over-Bildschirm**: Zeigt deinen Endpunktestand und ermöglicht die Eingabe deines Namens zur + Speicherung des Highscores. +- **Highscore-Liste**: Speichert die besten Spieler und ihre Punktzahlen lokal und zeigt sie nach + dem Spiel an. + +## Highscore-Funktion + +Nach dem Ende eines Spiels kannst du deinen Namen eingeben und deine Punktzahl in die +Highscore-Liste eintragen. Die Highscore-Liste zeigt die Namen und Punktzahlen der besten Spieler +an. + +## Screenshots + +Startbildschirm +Spielbildschirm +Game Over Bildschirm +Highscore-Liste \ No newline at end of file diff --git a/screenshots/game_over_screen.jpg b/screenshots/game_over_screen.jpg new file mode 100644 index 0000000..ba066a3 Binary files /dev/null and b/screenshots/game_over_screen.jpg differ diff --git a/screenshots/game_screen.jpg b/screenshots/game_screen.jpg new file mode 100644 index 0000000..38042c8 Binary files /dev/null and b/screenshots/game_screen.jpg differ diff --git a/screenshots/scoreboard_screen.jpg b/screenshots/scoreboard_screen.jpg new file mode 100644 index 0000000..96a3071 Binary files /dev/null and b/screenshots/scoreboard_screen.jpg differ diff --git a/screenshots/start_screen.jpg b/screenshots/start_screen.jpg new file mode 100644 index 0000000..01d2099 Binary files /dev/null and b/screenshots/start_screen.jpg differ