From f8f89becf1cd6fcc598ff06b213fd182b1ae2ab5 Mon Sep 17 00:00:00 2001 From: Leo Kerschbaumer <leo.kerschbaumerlk@gmail.com> Date: Wed, 16 Jun 2021 09:32:31 +0200 Subject: [PATCH] updated readme --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 59ccb56..9d946d3 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ Marco Sciacovelli, Lisa Mussner and Leo Kerschbaumer ## What is the project about? Our project is a BlackJack game implemented in Java using JavaFX. For reference please refer to https://en.wikipedia.org/wiki/Blackjack. +We are still working on multiplayer for this application but that feature is still +in development. The user can enter a username and play against the dealer. Lisa moch du des bitte ;) @@ -48,7 +50,9 @@ these might change when using an IDE (eg. IntelliJ or Eclipse), where you can ru please message us on LeKerschbaumer@unibz.it ## Requirements -- Java 15 or above +- Java 15 or above link +- maven link +- JAVA HOME variable must be set correctly `link` for windows... ## Usage This application is an implementation of the popular card game Blackjack. @@ -67,13 +71,41 @@ two options are presented: ## Implementation To implement this project we used the javaFX. +1. We used `collections` (lists) to save the cards in hand and deck. +2. Custom Exception are thrown when a certain case arrives during the game + ex. when no bet is set and the player wants to start the round +#3. Exceptions are handled so the application does not crash unexpectedly +4. Method overriding ex. toString.. +5. Lambdas for event listeners +6. Streams +7. File I/O for card backs +8. Regex to check username does not contain special characters +9. Observer pattern by using event listeners +10. Test hooks +11. serialization for log +We use some basic classes as logic (Hands, Player, Deck, Card). The GUI uses JavaFX +while the logic for the GUI resides in a controller. +. +. +. +## Our experience in this project +We organized ourselves using an application called Clickup. It allows us to create +tasks and notes as well as assign those tasks to a team member. It also features +a mindmap and other functionality which helped us to keep track of what needed to be done. +Git helped us share our code. We used feature branches to develop different parts of the +project for example the logic or the gui. +###challenges - +- Marco: + +- Lisa: + +- Leo: ## Licensing -- GitLab