CS2113-W12-3 Game

.gitignore

@@ -15,3 +15,6 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+#custom
+/data

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: main.CalculaChroniclesOfTheAlgorithmicKingdom
+

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# Game
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("main.CalculaChroniclesOfTheAlgorithmicKingdom")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("Release v2.1")
     archiveClassifier.set("")
 }
 
@@ -42,5 +42,7 @@ checkstyle {
 }
 
 run{
+    enableAssertions = true
     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://via.placeholder.com/100.png?text=Photo) | Aarav Rawal |     [Github](https://github.com/)      | [Portfolio](docs/team/johndoe.md) 
+ ![](https://via.placeholder.com/100.png?text=Photo) | Tanner Lie  | [Github](https://github.com/tannerlie) |  [Portfolio](team/tannerlie.md)   
+ ![](https://via.placeholder.com/100.png?text=Photo) | Fang Sihan  |     [Github](https://github.com/)      | [Portfolio](docs/team/johndoe.md) 
+ ![](https://via.placeholder.com/100.png?text=Photo) |   Samuel    |     [Github](https://github.com/)      | [Portfolio](docs/team/johndoe.md) 
+
+

docs/README.md

@@ -1,8 +1,14 @@
-# Duke
+# CalculaChroniclesOfTheAlgorithmicKingdom
 
-{Give product intro here}
-
-Useful links:
+CalculaChroniclesOfTheAlgorithmicKingdom is an open-world game played on the CLI. It aims to provide a fun and interactive
+way for younger students to learn/revise their mathematics knowledge. It is equipped with full player autonomy to explore,
+interact with shops and their inventory as well as slaying monsters with their wits and intellect by solving mathematical problems. <br>
+<br>
+Below is a list of links for our project:
 * [User Guide](UserGuide.md)
 * [Developer Guide](DeveloperGuide.md)
 * [About Us](AboutUs.md)
+* [B1G-SAM PPP](team/b1g-sam.md)
+* [bestdownloader365 PPP](team/bestdownloader365.md)
+* [tannerlie PPP](team/tannerlie.md)
+* [aaravrawal_PPP](team/aaravrawal.md)

docs/UserGuide.md

@@ -2,41 +2,147 @@
 
 ## Introduction
 
-{Give a product intro}
+Welcome to CalculaChroniclesOfTheAlgorithmicKingdom. This is a simple text based
+game. Your goal in this game is to defeat the enemies within and claim victory for yourself as a 
+math wizard.
 
 ## Quick Start
 
-{Give steps to get started quickly}
 
 1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+2. Download the latest version of `CalculaChroniclesOfTheAlgorithmicKingdom` from [here](https://github.com/AY2324S2-CS2113-W12-3/tp/releases).
 
 ## Features 
 
-{Give detailed description of each feature}
+### The Map
+This game displays the character's position on a 2D grid, the player is denoted by a `P` 
+and the other interactable entities are denoted by other symbols. The entities on the map are randomly generated in each
+play through of the game.
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+### The Player
+At all times, the player's health, money and exp is displayed at the top of the screen. Dropping the player's health 
+to 0 will cause the player to die and the game is over. 
+
+### The Text Box
+At all times, on the bottom part of the screen, a text box will be visible and it will be visible. The text box informs
+the player of narrations from the narrator, dialogue from the entities, general instructions from the user interface and
+also error messages when they occur.
+
+### Movement
+Traversing the map is similar to many common computer games. We use the "WASD" system such that
+entering `w` to the program shifts the player up by 1 space, entering `a` shifts the player to the left,
+entering `s` shifts the player down 1 space and lastly, entering `d` shifts the player to the right by 1 space.
+This movement can only take place when the 2D grid map is visible.
+
+Additionally, should the player wish to move more than 1 space at a time, the player can modify the directional commands
+by adding a number in this manner.
+
+E.g `d 10`
+
+The above command moves the player rightwards by 10 spaces.
+
+
+### Interacting 
+
+To interact with any entity in the game the player first has to move towards the symbol and be within close proximity
+to the symbol. We define close as the player needing to be directly above, below, to the left or to the right of an
+entity symbol, in other words, there can be no gap in between the player and the entity and interactions cannot occur
+diagonally. 
+
+To interact the player enters `e`. 
+
+This action will bring up a new interface called the battle interface which can be for either battling enemies or accessing the shop.
+This interface will display an image that corresponds to the symbol on the map and gives you 2 options, to `run` or to `fight`.
+
+### Run 
+
+Should the player, in the battle interface, determine that the enemy is too strong, the player may choose to type `run` 
+to back out of the fight and return to the main map to continue moving around.
+
+### Fight
+
+Should the player, in the battle interface, wish to fight the enemy. Entering `fight` in the battle interface will 
+start a fight. A series of math questions will appear based on the strength of the enemy. Generally, stronger enemies
+will come with harder math questions. 
+
+The player will then enter the correct answer. The answer is guaranteed to be an integer. Getting the question correct
+will cause the player to attack the enemy and getting it wrong will cause the enemy to attack the player. Getting the 
+questions wrong repeatedly will deplete the player's health and once the player's health reaches 0, the player dies and 
+the game is over. However, depleting the enemy's health to 0 will result in a victory and the player is rewarded with 
+some gold and exp before returning the player to the main map. 
+
+
+### Items
+
+There are various consumables the player can acquire throughout the game. The items are consumable items, meaning the
+item can be only used once before it is destroyed. There are 2 general types of items, the healing item and the damage 
+item. Healing items will recover the player's health, if the player's health is already maxed out at 
+100hp(health points), the healing item will OVER-HEAl and increase the player's health past the initial 100hp. Damage
+items will empower the player's next attack to do increased damage on a successful hit. 
+
+### Shop
+
+Items are purchasable at the shop denoted by a '#' on the map. Interacting with the shop causes the player to enter the
+shop. Just like the enemies, the player must enter `fight` to browse the shop's items. After entering the shop, buy an 
+item by entering the index of the item and the item will automatically be purchased and transferred to the Inventory.
+The purchase will only go through if the player has enough money. To exit the shop, the player enters `exit`.
+
+### Inventory
+
+The inventory of the player can only be accessed when the player is not currently interacting with an entity. To bring
+up the inventory the player enters `i`. To use an item the player enters the keyword `use` followed by the index of the 
+item.
+
+E.g `use 1`
+
+To close the inventory, the player enters `close`.
+
+### Hints
+
+Sometimes, hints are scattered throughout the map such that some text will display just below the map to help the 
+player, hints are entirely passive and no user input is required for the hints to trigger.
+
+### Quit
+
+Enter `q` to quit the game. The game is automatically saved.
+
+
+### Help
+
+If you need a refresher on the controls, entering either `h` or `help` will bring up a set of instructions.
+
+### Saving
+
+Our program can save map when you are playing the game.  
+Also, it will save the player status and your inventory items
+Please Note: After buying things in shop or fighting with a monster, you have to move on the map to save your file.
+
+### Reset
+
+Should a reset be necessary, the player can completely wipe the current progress of the game and regenerate a new game 
+at ANY POINT IN THE GAME by entering `reset`.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
 
-Example of usage: 
 
-`todo n/Write the rest of the User Guide d/next week`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
 
 ## FAQ
 
-**Q**: How do I transfer my data to another computer? 
+**Q**: Is there any prerequisite to run the application.
 
-**A**: {your answer here}
+**A**: Java 11 needs to be installed and the jar file must be in an empty folder before running.
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
-
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+`w` `a` `s` `d` to move around
+`e` to interact
+`q` to quit
+`h` to print help menu
+`run` to escape the battle interface
+`fight` to commence a fight
+`i` to bring up inventory
+`close` to leave inventory
+`exit` to leave the shop
+`reset` to reset the entire game and start a new game.
+ All math questions have integer answers.

docs/diagrams/Architecture.puml

@@ -0,0 +1,26 @@
+@startuml
+box Architecture
+participant "User" as user
+participant ":CalculaChroniclesOfTheAlgorithmicKingdom" as main
+participant ":UI" as ui
+participant ":Parser" as parser
+participant ":MoveRightCommand" as command
+
+user -> main : "w"
+activate main
+main -> parser : parseCommand()
+activate parser
+parser --> main : command
+deactivate parser
+main -> command : execute()
+activate command
+command --> main
+deactivate command
+main -> ui : print()
+activate ui
+ui --> user
+deactivate ui
+user -> main : "d"
+
+end box
+@enduml

docs/diagrams/BattleInterface.puml

@@ -0,0 +1,123 @@
+@startuml
+
+box Battle Component
+participant ":CalculaChroniclesOfTheAlgorithmicKingdom" as main
+participant ":UI" as ui
+participant ":Parser" as parser
+participant ":TextBox" as text
+participant ":FightCommand" as f
+participant ":PlayerStatus" as player
+participant ":Enemy" as e
+participant ":BattleInterface" as bi
+participant ":FileReader" as fileReader
+participant ":Map" as map
+participant ":MathPool" as mathpool
+
+'activate main
+'main -> parser : parseCommand(userCommandText)
+'activate parser
+'create f
+'parser -> f
+'activate f
+'f --> parser
+'deactivate f
+'parser --> main : command class
+'deactivate parser
+'main -> main : executeCommand()
+activate main
+main -> f : execute()
+activate f
+f -> bi : enableFight()
+activate bi
+create mathpool
+bi -> mathpool
+activate mathpool
+mathpool --> bi
+deactivate mathpool
+bi -> mathpool : init()
+activate mathpool
+mathpool --> bi
+deactivate
+create ":UI" as UI
+bi -> UI
+activate UI
+UI --> bi
+deactivate UI
+loop player and enemy is alive
+    bi -> player : getPlayerHealth()
+    activate player
+    player --> bi : player health
+    deactivate player
+    bi -> e : getHealth()
+    activate e
+    e --> bi : enemy health
+    deactivate e
+    bi -> UI : printPlayerStatus(currentPlayer)
+    activate UI
+    UI --> bi
+    deactivate UI
+    bi -> UI : printMap(mapData, currentEntity)
+    activate UI
+    UI --> bi
+    deactivate UI
+    bi -> mathpool : getQuestionByDifficulty(difficulty);
+    activate mathpool
+    mathpool --> bi : question
+    deactivate mathpool
+    bi -> UI : printQuestion(question)
+    activate UI
+    UI --> bi
+    deactivate UI
+    loop command is not an integer
+    bi -> text : setNextError(error)
+    activate text
+    text --> bi
+    deactivate text
+    bi -> text : setNextInstruction(question)
+    activate text
+    text --> bi
+    deactivate text
+    bi -> UI : printTextBox()
+    activate UI
+    UI --> bi
+    deactivate UI
+    end
+    alt correct answer
+    bi -> bi : playerHitEnemy()
+    else wrong answer
+    bi -> bi : enemyHitPlayer()
+    end
+end
+bi --> f
+deactivate bi
+alt enemy died
+    f -> map : getInteractX()
+    activate map
+    map --> f : x coordinate
+    deactivate map
+    f -> map : getInteractY()
+    activate map
+    map --> f : y coordinate
+    deactivate map
+    f -> map : clearSpot(x coordinate, y coordinate)
+    activate map
+    map --> f
+    deactivate map
+    f -> map : handleLootingByPlayer()
+    activate map
+    map --> f
+    deactivate map
+else player died
+    f -> map : handleDeath();
+    activate map
+    map --> f
+    deactivate map
+end
+f --> main
+deactivate f
+
+
+
+end box
+
+@enduml