Dokumentation zu upoker. eine Poker App für Android

Transkript

1 Dokumentation zu upoker eine Poker App für Android Carina Päßler, Tim Terborg, Daniel Kaiser und Florian Macherey 14. März 2014

2

3 Inhaltsverzeichnis 1 Über die App 5 2 Aufbau der App und Schnellanleitung für upoker Aufbau der App und Hauptmenü Das Spiel Aufbau der Spieleansicht Eine Spielrunde Die Highscoreansicht Die Hilfe- und Infoansicht Lizenzinformationen upoker App Lizenz upoker Dokumentation und Präsentation Lizenzen Dritter Projektplanung 10

4

5 1 Über die App upoker ist eine Video Poker Application für Android, geschrieben von Carina Päßler, Tim Terborg, Daniel Kaiser und Florian Macherey. Das Spiel wurde im Java-Projekt im Studium Scientific Programming entwickelt. Der Quellcode des Spiels, diese Dokumentation, die Präsentation und die fertig komplilierte.apk Datei können von der folgenden Webseite heruntergeladen werden: wordpress.com/upoker/ 2 Aufbau der App und Schnellanleitung für upoker Dies ist eine Schnnellanleitung für upoker, es wird nach den Five Card Draw Regeln gespielt, jedoch gibt es in dieser App nur eine spielende Person. 2.1 Aufbau der App und Hauptmenü Die App besteht aus einem Bildschirm auf welchem die anderen Menüpunkte durch einfaches Antippen ausgewählt werden können. Diese sind das eigentliche Spiel( Spiel starten ), die Highscores( Highscores anzeigen ), die Hilfe( Hilfe anzeigen ) und eine Info( Info anzeigen ). 5

6 2.2 Das Spiel Aufbau der Spieleansicht In der Spieleansicht wird oben links das aktuelle Guthaben angezeigt, dies sind standardmäßig 20 Euro. Dieses Guthaben bekommt die spielende Person zur Verfügung gestellt beziehungsweise wird nach dem Speichern eines Spielstandes auf diesen Betrag zurückgesetzt. Daneben ist eine Auswahlbox für den Einsatz, dieser kann 10 Cent, 20 Cent, 50 Cent, 1 Euro oder 2 Euro sein. Kombinationen daraus, wie zum Beispiel 30 Cent sind nicht möglich. Es kann immer nur eine Münze pro Runde eingesetzt werden. Der Wert aus der vorherigen Spielrunde ist hier als Standardwert eingetragen. Auf der rechten Seite ist der Spielen - Button, welcher das Spiel startet und auch die Karten für die zweite Teilspielrunde verteilt. Unter diesen drei Elementen ist eine Textausgabe, die die spielende Person darüber informiert welche Gewinne man erhalten hat oder welchen Button man als Nächstes antippen muss. Unter dieser Textausgabe sind die fünf Karten angezeigt, die per Zufall aus einem Deck von 52 Karten ausgewählt wurden. Man kann die Karten antippen die getauscht werden sollen. Wenn diese für das Tauschen markiert sind, werden sie ein Stück nach oben abgesetzt. Unten sieht man zwei Buttons, einen Nochmal spielen - Button der für eine neue Spielrunde gedrückt werden muss. Dieser Button kann nur nach der zweiten Teilspielrunde gecrückt werden. Daneben ist der Speichern und beenden - Button der gedrückt werden muss wenn man das Spiel beenden möchte und um sich in den Highscore einzutragen. 6

7 2.2.2 Eine Spielrunde Zu Beginn einer Spielrunde wählt man den zu setzenden Einsatz aus der Auswahlbox oder lässt den Standardwert beziehungsweise Wert aus der letzen Spielrunde darin stehen. Danach muss man den Button zum Starten eines Spieles drücken. Nach der ersten Teilspielrunde muss man die Karten auswählen welche getauscht werden sollen. Wenn man dann auf den Spielen Button tippt, werden für die ausgewählten Karten entpsprechend neue Karten aus dem Deck gezogen. Danach wird, wenn man etwas gewonnen hat, der Gewinn entsprechend angezeigt. Danach kann man auf den Button für ein neues Spiel tippen, es erscheinen dann wieder die Kartenrückseiten oder man tippt auf den Button um das Spiel zu speichern und zu beenden. Wenn man in den Highscore eingetragen werden kann öffnet sich eine Popup Box um den Namen der spielenden Person einzugeben. 7

8 2.3 Die Highscoreansicht Die Highscoreansicht zeigt die Namen und Gewinne der fünf Personen, die das meiste Geld verdient haben. Wenn der Highscore löschen - Button angetippt wird, werden alle Namen und Beträge gelöscht und als Standardwerte werden die Beträge 20 Euro und der Name Name eingetragen. Die Highscoreansicht sieht wie unten abgebildet aus, hier sind die Standardwerte eingetragen wie sie nach dem Löschen gespeichert werden. 2.4 Die Hilfe- und Infoansicht Die Hilfe- und die Infoansicht sind dieselbe Activity die gestartet wird. Dabei wird in der Klasse der Hauptansicht ein Intent erzeugt, welches, je nachdem welcher der beiden Buttons gedrückt wurde, die entsprechende XML 1 - Datei aufruft. Ein Auszug aus der Hauptactivity ist unten beispielhaft für die Infodatei abgedruckt. 1 Button i n f o = ( Button ) findviewbyid (R. id. buttonviewinfo ) ; 2 3 i n f o. s e t O n C l i c k L i s t e n e r (new View. OnClickListener ( ) { 5 p u b l i c void onclick ( View v ) { 6 I n t e n t i n t e n t = new I n t e n t ( t e s t, UPokerTextActivity. c l a s s ) ; 7 i n t e n t. putextra ( t e x t, R. s t r i n g. textviewinfo ) ; //R. s t r i n g. textviewinfo i s t d i e ID der I n f o d a t e i, R. s t r i n g. textviewhelp i s t d i e ID der H i l f e d a t e i 8 s t a r t A c t i v i t y ( i n t e n t ) ; 9 } 10 }) ; 11 Die Hilfe- und die Infoansicht sehen entsprechend so aus: 1 8

9 3 Lizenzinformationen 3.1 upoker App Lizenz Das Spiel steht unter der MIT - Lizenz 2 : Copyright (c) ab 2014 Carina Päßler, Tim Terborg, Daniel Kaiser und Florian Macherey Hiermit wird unentgeltlich jeder Person, die eine Kopie der Software und der zugehörigen Dokumentationen (die Software ) erhält, die Erlaubnis erteilt, sie uneingeschränkt zu benutzen, inklusive und ohne Ausnahme dem Recht, sie zu verwenden, kopieren, ändern, fusionieren, verlegen, verbreiten, unterlizenzieren und/oder zu verkaufen, und Personen, die diese Software erhalten, diese Rechte zu geben, unter den folgenden Bedingungen: Der obige Urheberrechtsvermerk und dieser Erlaubnisvermerk sind in allen Kopien oder Teilkopien der Software beizulegen. DIE SOFTWARE WIRD OHNE JEDE AUSDRÜCKLICHE ODER IMPLIZIERTE GARAN- TIE BEREITGESTELLT, EINSCHLIESSLICH DER GARANTIE ZUR BENUTZUNG FÜR DEN VORGESEHENEN ODER EINEM BESTIMMTEN ZWECK SOWIE JEGLICHER RECHTS- VERLETZUNG, JEDOCH NICHT DARAUF BESCHRÄNKT. IN KEINEM FALL SIND DIE AUTOREN ODER COPYRIGHTINHABER FÜR JEGLICHEN SCHADEN ODER SONSTI- GE ANSPRÜCHE HAFTBAR ZU MACHEN, OB INFOLGE DER ERFÜLLUNG EINES VER- TRAGES, EINES DELIKTES ODER ANDERS IM ZUSAMMENHANG MIT DER SOFTWA- RE ODER SONSTIGER VERWENDUNG DER SOFTWARE ENTSTANDEN. 3.2 upoker Dokumentation und Präsentation Diese Dokumentation und die dazugehörige Präsentation stehen unter einer Creative Commons Namensnennung - Weitergabe unter gleichen Bedingungen 4.0 International Lizenz Lizenzen Dritter Die Kartenrückseite steht unter der GNU Lesser General Public License (LGPL) Version oder höher von David Bellot (Berkerly, CA). Die Kartenvorderseiten stehen unter Public Domain von GW Simulations. Für den Fall, dass dies illegal ist, erlaubt GW Simulations jedem Benutzer und jeder Benutzerin, die Bilder für

10 jeden Zweck ohne Garantie zu verwenden. Bestehende Gesetze bleiben davon unberührt. 4 Projektplanung Die Projektplanung ist ein in Markdown geschriebenes Dokument, welches zu Beginn des Projektes erstellt wurde und in welchem alle wesentlichen beziehungsweise wichtigen Absprachen, wie zum Beispiel Methoden mit Signatur, getroffen wurden. Diese Projektplanung befindet sich auf der nächsten Seite dieses Dokumentes. 10

11 Javaprojekt - Videopoker Florian, Daniel, Carina, Tim Spielablauf Die spielende Person bekommt zu Beginn des Spiels 20 Euro. Zu Beginn einer Spielrunde setzt die spielende Person 10 Cent bis 2 Euro. Setzen 5 Karten werden zufällig verteilt Die spielende Person wählt Karten die getauscht werden sollen Für diese Karten werden neue zufällige Karten angezeigt Gewinn wird bestimmt und ausgeschüttet Kombinationen zum Gewinnen: Royal Flush, Straight Flush, 4 of a Kind, Full House, Flush, Straight, 3 of a Kind, Two Pair, Two Jacks or more. Spielregeln und Aufbau Das Hauptmenü besteht aus vier Einträgen: Spiel starten Highscore (Beinhaltet fünf Einträge) Hilfe Info Gewinnfaktor: zwei Buben oder besser: 1 zwei Paar: 2 Drilling: 3 Straight: 4 Flush: 6 Full House: 9 Vierling: 25 Straight Flush: 50 Royal Flush: 250 Der Faktor wird mit dem Einsatz multipliziert. Werden 2 Euro eingesetzt, ist der Gewinn beim Royal Flush mal 800. Wenn nach dem letzten Beenden ein Guthaben vorhanden ist, wird dieses geladen. Nach Starten des Spiels wird die UPokerGameActivity angezeigt. Über ein Dialog Element wird der Einsatz ausgewählt (10 Cent, 20 Cent, 50 Cent, 1 Euro, 2 Euro). In einem TextView wird das Guthaben angezeigt. Daneben gibt es einen "Spielen" Button der das Spiel startet. Darunter ein TextView das als Logausgabe dient um den aktuellen Status des Spiels, Einsätze und Gewinne auszugeben. Am unteren Teil der App werden die fünf Karten angezeigt. Nach jeder Spielrunde wird an der Stelle der Karten ein Button "Spiel beenden und Speichern" angezeigt. Wird dieser Button gedrückt wird eine PopupBox angezeigt um den Namen einzugeben. Wenn die App geschlossen wird, ohne das Spiel zu beenden, wird das aktuelle Guthaben gesichert. Die Anzeige für die Hilfe und die Info startet die UPokerInfoActivity. Diese bestehen nur aus einem TextView Element, welches entsprechend eine Textdatei einliest und diese anzeigt.

12 Der Highscore startet die UPokerHighscoreActivity. Diese beinhaltet ein TextView in dem fünf Highscoreeinträge gespeichert werden. Außerdem befindet sich am Ende der Liste ein Button zum Löschen der Daten. Wenn der "Spiel beenden und Speichern" gedrückt wird, wird der aktuelle Gewinn in die Highscore Liste übernommen. Diese ist nach dem höchsten Gewinn geordnet. Methoden, Funktionen und Attribute Die Karten werden als int gespeichert. Dabei ist die 100er Stelle für die Farbe, die Einer- und Zehnerstellen für das Kartenbild (2-10 Zahlen, 11 Jack, 12 Queen, 13 King, 14 Ace). Die Farben sind 1 Heart, 2 Diamond, 3 Spades, 4 Club. Der Datenaustausch findet über Dateien statt, zum Beispiel werden die Highscores in Dateien gespeichert und dann in der UPokerHighscoreActivity gelesen. Intents werden aus dem Hauptmenü heraus benutzt um der UPokerTextActivity den Dateinamen für die Info bzw. Hilfeansicht zu übergeben. public class UPokerActivity Carina onclicklistener für die Buttons um die UnterActivitys aufzurufen, es wird ein Intent erzeugt mit dem Dateinamen der Datei für die Info bzw. Hilfe public class UPokerGameActivity int choosebet() Carina int getprofit() Carina String getstatusbar() Florian void setstatusbar(string) Florian void playgame() Tim int checkprofit(int bet, Card[] cards) Daniel void showcard(card, int, boolean) Florian void endgameandsave() Tim int loadcredit() Daniel void savecredit(int) public class UPokerTextActivity Florian void showtext(int) public class UPokerHighscoreActivity Tim void showscore() int clearscores() public class Cards Daniel Card getrandomcard() //Karte ziehen für Spielrunde Card[] getnewcards() //Erzeugt jede Spielrunde ein neues Kartendeck