[CS2113-T11-4] EconoCraft Pro

.gitignore

@@ -15,3 +15,6 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+META-INF/
+docs/UML diagram/Script/

build.gradle

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

docs/AboutUs.md

@@ -1,9 +1,10 @@
 # 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://image.umall.com.au/image/goods4/6921294355383/image/1.jpg?x-oss-process=image/resize,w_750/sharpen,100/quality,Q_100)                |  Xia Cong   |        [Github CXIA17](https://github.com/CXIA17)         |      [Portfolio](docs/team/johndoe.md)      |
+| ![](https://th.bing.com/th/id/OIP.sDaKNkXjaMY7lIZBnMkYsQHaFj?w=231&h=180&c=7&r=0&o=5&dpr=1.5&pid=1.7)                                            |  MA JIAJUN  |         [Github](https://github.com/Jamarcus111)          | [Portfolio](https://www.linkedin.com/feed/) |
+| ![](https://wingfungdundee.co.uk/WebRoot/Store25/Shops/619556e1-1fbf-4030-bcf6-c7e2e8a4f752/620E/4594/146C/E2B0/E561/0A48/3522/3482/CKA101B.jpg) |  Li Kunjun  | [Github](https://github.com/StargazerX0?tab=repositories) |     [Portfolio](docs/team/LiKunjun.md)      |
+| ![](https://miro.medium.com/v2/resize:fit:1358/0*hJtj0p-31PmVA4wd.jpeg)                                                                          | Zhu Minghui |          [Github](https://github.com/ZMinghuiZ)           |      [Portfolio](docs/team/johndoe.md)      |
+
+

docs/DeveloperGuide.md

@@ -1,29 +1,211 @@
 # Developer Guide
 
+## Table of Contents
+
+* [Design](#design)
+  * [Architecture](#architecture)
+    * [Main components](#main-components)
+    * [Component interaction](#component-interaction)
+  * [UI components](#ui-components)
+  * [EconoCraftLogic components](#econocraftlogic-components)
+  * [MiniGame components](#miniGame-components)
+* [Implementation](#implementation)
+  * [MiniGame - Typing Game](#miniGame---typing-Game)
+  * [MiniGame - Tic Tac Toe](#miniGame---tic-tac-toe)
+  * [MiniGame - True or False](#miniGame---true-or-false)
+* [Product scope](#product-scope)
+  * [Target user playerProfile](#target-user-playerprofile)
+  * [Value proposition](#value-proposition)
+* [User Stories](#user-stories)
+* [Non-Functional Requirements](#non-functional-requirements)
+* [Glossary](#glossary)
+
 ## Acknowledgements
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
+## Design
+
+### Architecture
+
+![Architecture.png](UML%20diagram%2FArchitecture.png)
+
+The **Architecture diagram** above showcases the high-level design of the EconoCraft Pro application. 
+
+The following section would give a brief overview of the different components of the application and their interactions
+with each other.
+
+#### Main components:
+
+`Main` (consisting of class `EconoCraft` and `EconoCraftLogic`) 
+is in charge of the game initialization and starting the main game loop.
+
+* At game initialization, it reads the necessary information from prompted user input and develops the player profile.
+* When game starts, it initializes the game logic and starts the main game loop.
+
+The functionality of the game is divided into different components, each responsible for a different aspect of the game.
+
+* `PlayerProfile`: Represents the player's profile and is responsible for storing and updating the player's information.
+* `Parser`: Responsible for parsing the user input.
+* `ResponseManager`: Responsible for generating the response to the user input.
+* `EconoCraftLogic`: Responsible for executing user command and updating the game state.
+* `MiniGame`: Responsible for handling the mini-games that the player can play to gain rewards.
+* `CommandFactory`: Responsible for using the parsed user input to produce executable commands.
+
+#### Component interaction:
+
+The *Sequence Diagram* below showcases the interaction between the different components of the EconoCraft Pro 
+application when a user inputs a command `work`.
+
+For `CommandFactory` and `Minigame`,
+* Each defines its API for creating commands and mini-games respectively, where
+  `Command` is the API for `CommandFactory` and `MiniGame` is the API for `MiniGame`.
+* Implements its functionality with concrete classes such as `WorkCommand` and `TypingGame`.
+
+The sections below would give more details of each component.
+
+## UI components
+
+UI consists of the following components:
+* `Parser`
+* `ResponseManager`
+* `CommandType`
+
+![UI.png](UML%20diagram%2FUI.png)
+
+The **UI components**,
+* `Parser` parses the user input for `CommandFactory` to produce `Command`
+* `ResponseManager` generate the response to the user according to the *command execution* and *game logic*.
+
+## EconoCraftLogic components
+
+Here is the partial class diagram of the `EconoCraftLogic` component:
+
+![Logic.png](UML%20diagram%2FLogic.png)
+
+> [!NOTE]
+> - The `XYZ` in `XYZCommand` represents the exact command e.g., `WorkCommand`, `RestCommand`, `ExerciseCommand`.
+> - The `XYZ` in `XYZMiniGame` represents the exact mini-game e.g., `TypingGame`, `TicTacToe`, etc.
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+Here is the sequence diagram of the `EconoCraftLogic` executing the command:
+
+![Work.png](UML%20diagram%2FWork.png)
+
+The `EconoCraftLogic` mechanism:
+
+1. `EconoCraftLogic` receives the user input string and pass it into `CommandFactory`.
+2. `CommandFactory` would use `Parser` to parse the user input string and produce a `Command`.
+3. `EconoCraftLogic` would execute the `Command` which will:
+   * update the player profile accordingly.
+   * use `ResponseManager` to generate the response to the user.
+
+## MiniGame components
+
+Here is the partial class diagram of the `MiniGame` component:
+
+![MiniGame.png](UML%20diagram%2FMiniGame.png)
+
+The `MiniGame` mechanism:
+1. For command `work`, `rest`, and `exercise`, they would have their respective mini-games.
+2. When these commands are generated and executed in `EconoCraftLogic`, the respective mini-game would be played.
+3. The command would then update the player profile according to the mini-game result.
+
+# Implementation
+
+## MiniGame - Typing Game
+
+The implementation of the Typing Game is as follows:
+
+1. The game can be invoked by the `WorkCommand` class when the user inputs the `work` command.
+2. It makes use of the `ResponseManager` to generate the instructions of the game to the user. 
+3. The user would be prompted to type the given text as fast as they can.
+4. This game made use of the `CompletableFuture` class to create separate thread which handles the countdown timer and user input at the same time.
+5. When the user finishes typing or the time limit is reached, the game would calculate the user's typing speed and accuracy and reward the user accordingly. 
+6. Finally, the `WorkCommand` would update the player profile with the reward earned according to the user's performance in the game.
+
+## MiniGame - Tic Tac Toe
+
+The implementation of the Tic Tac Toe Game is as follows:
+
+1. The game can be invoked by the `ExerciseCommand` class when the user inputs the `exercise` command.
+2. It makes use of the `ResponseManager` for instructions and display the board status.
+3. The user would be prompted to choose player mark and place it when entering the game.
+4. AI player will randomly choose available to place mark once user places the mark.
+5. After each placement, the game would check the status to determine whether continue the game or not.
+6. If the board is full or there are three consecutive marks, the game will announce the winner or say "it's a draw".
+7. Finally, the `ExerciseCommand` would update the player profile with the reward or punishment for health.
+
+## MiniGame - True or False
+
+1. The game can be invoked by the `RestCommand` class when the user inputs the `rest` command.
+2. It makes use of the `ResponseManager` for instructions and display the questions to answer.
+3. The user would be prompted to answer True or False by typing `T` or `F`.
+4. When the user returns his/her answer, the `ResponseManager` will display the correctness of the response.
+5. When the user finishes answering all the questions, `ResponseManager` will output how many questions the user answers correctly.
+6. Finally, the `RestCommand` would update the player profile with the reward or punishment earned according to the game.
+
+## Investment game - Stock
+
+1. The process of buying stock can be invoked by the `StockCommand` class when user inputs `stock`.
+2. It makes use of `ResponseManager` for instructions and output the stock graph and information relating to the stock.
+3. The user would be prompted to input the number of stocks they would like to purchase in integer.
+4. `ResponseManager` will indicate the completion of purchase after user's input.
+5. When the user finishes the purchase, stock they bought will be stored inside `Asset` class.
+6. Input `status` will output the stock the user currently possesses.
+7. The process of selling stock can be invoked by the `SellStockCommand` class when user input `sellstock`.
+8. The system will calculate user's profit gained at the current price of the stock and return the money back to the 
+user based on the stock's current price.
+9. User can keep the stock they purchased inside their asset for as long as they want.
 
 ## Product scope
-### Target user profile
+### Target user playerProfile
 
-{Describe the target user profile}
+{Describe the target user playerProfile}
 
 ### Value proposition
 
 {Describe the value proposition: what problem does it solve?}
 
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+| Version | As a ...         | I want to ...                                                  | So that I can ...                                           |
+|---------|------------------|----------------------------------------------------------------|-------------------------------------------------------------|
+| v1.0    | new user         | see usage instructions                                         | refer to them when I forget how to use the application      |
+| v1.0    | user             | view basic command list and game flow                          | navigate and start the game smoothly      |
+| v1.0    | user             | add my name to the programme                                   | have a personalised game interaction    |
+| v1.0    | user             | exit from the programme                                        | decide when to exit based on my own preferrence     |
+| v1.0    | user             | view my player or company status                               | know how much assets that I have      |
+| v2.0    | user             | find a to-do item by name                                      | locate a to-do without having to go through the entire list |
+| v2.0    | user             | restart the game                                               | reset the progess when a bad decision is made      |
+| v2.0    | user             | check current game progress via a progress percentage bar      | be clear about how many more task needs to be done to complete the game      |
+| v2.0    | user             | set finantial task to be completed                                                               | complete task to increase game progress      |
+| v2.0    | user             | track my in-game money flow                               | play the game more strategically      |
+| v2.0    | first-time user  | view tips for playing the game                              | familiarise with the game faster      |
+| v2.0    | first-time user  | view the background story of the game                              | have a better understanding on what the game is about      |
+| v2.0    | experienced user | perform employee hiring action                               | develop the virtual startup      |
+| v2.0    | user             | invest in virtual stock market                               | increase the earning for company development      |
+| v2.0    | user             | delete a task that has been created                               | start over with a new idea or approach      |
+| v2.0    | user             | have a reward system for completing each task                               | feel a sense of achievement when complete the task      |
+| v2.0    | player           | task with different challenge when entered command                               | feel more engaged to the game      |
+| v2.0    | user             | want to have random event at the end of each round                               | enjoy the uncertainty within the gameplay process      |
+| v2.0    | user             | save my personal profile                               | not to lose any progress when I play again      |
+| v2.0    | user             | see different game ending from different decision made in game | gain a sense of satisfaction when good ending happens |
+| v2.0    | user             | have 3-4 saved progresses                                      | choose the progress based on my preference                              |
+| v2.0    | user             | name each progress                                             | differentiate saved progresses                              |
+| v2.0    | user             | delete saved progresses                                        | delete the saved data when the data has no use              |
+| v2.0    | advanced player  | modify the saved file                                          | adjust my game infomation when possible                     |
+| v2.0    | user             | choose level of difficulties of the game                       | adjust the difficulties based on my skills      |
+| v2.0    | user             | learn different player skills                                  | complete mission and task easier      |
+| v2.0    | user             | have lucky draw to gain interesting rewards                    | feel the excitement and joy of the game     |
+| v2.0    | user             | get loan from the virtual bank                                 | use for the investment and expand the businesses     |
+| v2.0    | user             | negotiate with game NPCs                                       | feel more engaged to the game      |
+| v2.0    | busy-user        | save the game data into local                                  | continue the saved progress next time      |
+| v2.0    | first-time user  | see what actions I can do in different player level            | type correct command to complete the tasks     |
+| v2.0    | user             | trigger random event                                           | feel more insterested to the game     |
+
+
+
 
 ## Non-Functional Requirements
 

docs/README.md

@@ -1,6 +1,9 @@
-# Duke
+# EconoCraft Pro
 
-{Give product intro here}
+EconoCraft is a single player text adventure game where a player takes on the role of a business owner or manager,
+tasked with growing their company from a small startup to a large corporation. The game would simulate real-world
+business challenges, including resource management, market analysis, product development, and financial planning to 
+help students prepare for the future challenges.
 
 Useful links:
 * [User Guide](UserGuide.md)