[CS2113-F15-3] NUSFC 24

.gitignore

@@ -15,3 +15,7 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+*.jar
+/.vscode
+
+META-INF/MANIFEST.MF

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.Duke
+

build.gradle

@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+Display |     Name     | Github Profile | Portfolio 
+--------|:------------:|:--------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) | Run Xinghuan | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Henry Gan | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Ymir Meddeb | [ymirmeddeb](https://github.com/ymirmeddeb) | [Portfolio](docs/team/johndoe.md)
+![](https://incybot.github.io/images/avatars/avatar-1.png) | Sparsh | [Github](https://github.com/IncyBot) | [Portfolio](https://incybot.github.io/)
+

docs/README.md

@@ -1,4 +1,4 @@
-# Duke
+# NUSFC 24
 
 {Give product intro here}
 

docs/UserGuide.md

@@ -2,32 +2,67 @@
 
 ## Introduction
 
-{Give a product intro}
+NUSFC 24 is an association football-themed game app. Unlike the more famous games like EA Sports FC 24 and eFootball, 
+NUSFC 24 is played via a Command Line Interface (CLI). The game does not simulate the main game of a football match. 
+Rather, it simulates penalty shoot-out for football.
 
-## Quick Start
+## Background Information
+
+### Penalty Shoot-out
+
+In a penalty shoot-out, each team takes turns shooting at goal from the penalty mark, with the goal defended only by the
+opposing team's goalkeeper.
+
+### Rules for Penalty Shoot-out
+
+#### Best-of-five Kicks
 
-{Give steps to get started quickly}
+Teams take turns to kick from the penalty mark, until each has taken five kicks. However, if one side has scored more 
+goals than the other could possibly reach with all of its remaining kicks, the shoot-out immediately ends, regardless of
+the number of kicks remaining.
 
-1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+For example, there are two teams team A and team B playing a penalty shoot-out. Both teams have taken three kicks. Team 
+A has scored 3 goals, while team B has scored 0 goal. Now both teams are left with two kicks. As the goal difference 
+between team A and team B (3) is larger than the number of kicks left for team B (2). The game ends immediately, with 
+team A being the winner.
 
-## Features 
 
-{Give detailed description of each feature}
+#### Sudden Death
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+If after five rounds of kicks, the teams have scored an equal number of goals (or neither team has scored any goals), 
+additional rounds of one kick each are used until one team scores and the other misses.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+## Quick Start
+
+1. Ensure that you have Java 11 or above installed in your laptop.
+2. Download the latest version of `NUSFC 24` from [here](https://github.com/AY2324S2-CS2113-F15-3/tp/releases/tag/v2.0).
+3. Copy the file to the folder where you want to play the game.
+4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar tp.jar` command to run
+the application.
+5. Type the command in the terminal and press Enter to execute it. e.g. typing `shoot 0` and pressing Enter will shoot a
+penalty at direction 0 shown in the goal.\
+Some example commands you can try:
+* `shoot 0`: Shoot a penalty at direction 0 shown in the goal.
+* `save 0`: Make a save at direction 0 shown in the goal.
+* `upgrade 2`: Upgrade your player to the medium skill level.
+* `yes`: Restarts a match after a match ends.
+* `no`: Does not restart a match after a match ends, and exits the game.
+* `bye`: Exits the game.  
+
+6. Refer to the Features below for details of each command.
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+## Features
 
-Example of usage: 
+### Restarts a match after a match: `yes`
+When one match ends, you will be asked whether to have a new match or not. Type `yes` for a new match.
 
-`todo n/Write the rest of the User Guide d/next week`
+Format: `yes`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+### Does not restart a match after a match: `no`
+When one match ends, you will be asked whether to have a new match or not. Type `no` for not having a new match, and 
+exits the game directly.
+
+Format: `no`
 
 ## FAQ
 
@@ -37,6 +72,5 @@ Example of usage:
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
-
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+* Restarts a match after a match `yes`
+* Does not restart a match after a match `no`

docs/diagrams/MatchStatClassDiagram.puml

@@ -0,0 +1,20 @@
+@startuml
+'https://plantuml.com/class-diagram
+
+skinparam classAttributeIconSize 0
+
+class MatchStat {
+- {static} matchCount: int
+- {static} roundCount: int
+- {static} playerScore: int
+- {static} aiScore: int
+- {static} isPlayerWin: boolean
+- {static} isMatchEnd: boolean
+- {static} isPlayerTurn: boolean
++ {static} updateStat(isGoal: boolean)
++ {static} updateForNewMatch()
+- {static} decideMatchEnd()
+}
+
+
+@enduml

docs/diagrams/MatchStatSequential.puml

@@ -0,0 +1,35 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+autonumber
+
+ -> CommandList: executeShoot("1")
+activate CommandList
+
+CommandList -> Ai: getAiDirection()
+activate Ai
+return direction
+
+CommandList -> CommandList: goalCheck(1, direction)
+activate CommandList
+return isScoreGoal
+
+CommandList -> MatchStat: updateStat(isScoreGoal)
+activate MatchStat
+MatchStat -> MatchStat: decideMatchEnd()
+activate MatchStat
+return
+
+return
+
+CommandList -> Formatter: printGoalAfterShot(isScoreGoal)
+activate Formatter
+Formatter -> Formatter: showScore()
+activate Formatter
+return
+
+return
+
+return
+deactivate CommandList
+@enduml

src/main/java/seedu/duke/CommandList.java

@@ -0,0 +1,64 @@
+package seedu.duke;
+
+import seedu.duke.ai.Ai;
+import seedu.duke.stats.MatchStat;
+import seedu.duke.ui.Ui;
+
+public enum CommandList {
+
+    BYE, SHOOT, PENALTY, YES, NO, UPGRADE, EASY, MEDIUM, HARD, SAVE;
+
+    //insert new user command name here
+    ;
+
+    /**
+     * Exits the program
+     */
+    public static void executeBye() {
+        Formatter.printGoodbyeMsg();
+        Ui.setIsRunning(false);
+    }
+
+    public static boolean goalCheck(int userInput, int aiInput) {
+        assert userInput >= 0 && userInput <= 2 :
+                "Illegal userInput generated!";
+        assert aiInput >= 0 && aiInput <= 2 :
+                "Illegal aiInput generated!";
+        return userInput != aiInput;
+    }
+
+    public static void executePenalty(DifficultyLevel difficultyLevel) {
+        Ai ai = new Ai(difficultyLevel);
+        Penalty.executePenalty(ai);
+    }
+
+    public static void executeShoot(String[] readArgumentTokens) {
+        String selectedDirection = readArgumentTokens[0];
+        int selectedDirectionIndex = Integer.parseInt(selectedDirection);
+        boolean isScoreGoal = goalCheck(selectedDirectionIndex, Ai.getAiDirection());
+
+        MatchStat.updateStat(isScoreGoal);
+        Formatter.printGoalAfterShot(isScoreGoal);
+    }
+
+    public static void executeUpgrade(String[] level){
+        String upgradeLevel = level[0];
+        int upgradeLevelIndex = Integer.parseInt(upgradeLevel);
+
+        PlayerList.l1.get(Ui.curPlayer).upgradePower(upgradeLevelIndex);
+        PlayerList.l1.get(Ui.curPlayer).printSelfInfo();
+    }
+
+    public static void executeSave(String[] readArgumentTokens) {
+        String userSaveDirection = readArgumentTokens[0];
+        int userSaveDirectionIndex = Integer.parseInt(userSaveDirection);
+        int aiPenaltyDirection = Ai.getAiDirection();
+        boolean isGoalSaved = userSaveDirectionIndex == aiPenaltyDirection;
+        boolean isGoal = !isGoalSaved;
+        MatchStat.updateStat(isGoal);
+        Formatter.printSaveResult(isGoalSaved);
+    }
+
+    //insert new command here
+}
+

src/main/java/seedu/duke/DifficultyLevel.java

@@ -0,0 +1,7 @@
+package seedu.duke;
+
+public enum DifficultyLevel {
+    EASY,
+    MEDIUM,
+    HARD
+}

src/main/java/seedu/duke/Duke.java

@@ -1,21 +1,51 @@
 package seedu.duke;
 
-import java.util.Scanner;
+import seedu.duke.exception.ProcessInputException;
+import seedu.duke.player.MediumSkill;
+import seedu.duke.player.Player;
+import seedu.duke.stats.MatchStat;
+import seedu.duke.ui.Ui;
 
 public class Duke {
+
+
     /**
      * Main entry-point for the java.duke.Duke application.
      */
     public static void main(String[] args) {
-        String logo = " ____        _        \n"
-                + "|  _ \\ _   _| | _____ \n"
-                + "| | | | | | | |/ / _ \\\n"
-                + "| |_| | |_| |   <  __/\n"
-                + "|____/ \\__,_|_|\\_\\___|\n";
-        System.out.println("Hello from\n" + logo);
-        System.out.println("What is your name?");
+        Formatter.printWelcomeMsg();
+
+        Player playerThisRound = createNewPlayer();
+        //Assume there is single player, can only have one player in the game
+        //After account login function done,
+        //the PlayerThisRound will either return a new player, or a player existed in the PlayerList
+
+        while (Ui.getIsRunning()) {
+            if (MatchStat.getIsMatchEnd()) {
+                Formatter.printMatchResult();
+                PlayerList.skillUpgrade(Ui.curPlayer);
+                playerThisRound = PlayerList.l1.get(Ui.curPlayer);
+            } else if (MatchStat.getIsPlayerTurn()) {
+                playerThisRound.printGoalBeforeShoot();
+            } else {
+                playerThisRound.printGoalBeforeSave();
+            }
+            try {
+                Ui.beginListening();
+                Ui.processInput();
+                Ui.executeCommand();
+            } catch (ProcessInputException e) {
+                Formatter.printErrorExecutionFail();
+            }
+        }
+    }
 
-        Scanner in = new Scanner(System.in);
-        System.out.println("Hello " + in.nextLine());
+    //Bruno is a sample player for demonstration, you can try any level player
+    private static Player createNewPlayer() {
+        PlayerList.l1.add(new MediumSkill("Bruno",3));
+        Player playerThisRound = PlayerList.l1.get(Ui.curPlayer);
+        playerThisRound.printSelfInfo();
+        MatchStat.setMatchCount(playerThisRound.matchCount);
+        return playerThisRound;
     }
 }