[CS2113-T13-4] Rolladie

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+data/savefile.txt
+save_slot_1.dat

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "interactive"
+}

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: Rolladie
+

README.md

@@ -1,6 +1,6 @@
-# Duke project template
+# Rolladie project template
 
-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.
+This is a project template for a greenfield Java project. Given below are instructions on how to use it.
 
 ## Setting up in Intellij
 

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("Rolladie")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("rolladie")
     archiveClassifier.set("")
 }
 
@@ -43,4 +43,9 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
+tasks.withType(JavaCompile) {
+    options.encoding = 'UTF-8'
+}
+

data/savefile1.txt

@@ -0,0 +1,2 @@
+1
+HDFDGH | 100 | 100 | 5 | 3 | Armor -1 | Boots -1 | Weapon -1 | 0 | 50 | 100

data/savefile3.txt

@@ -0,0 +1,2 @@
+3
+HTTORKHDOFPGHKFGDPOHDGF | 62 | 100 | 5 | 3 | Armor -1 | Boots -1 | Weapon -1 | 27 | 100 | 100

docs/AboutUs.md

@@ -2,8 +2,8 @@
 
 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)
+![](https://via.placeholder.com/100.png?text=Photo) | Vincent | [Github](https://github.com/vincesum) | [Portfolio](team/vincesum.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Lee ying ying | [Github](https://github.com/yyingg-243) | [Portfolio](team/yyingg-243.md)
+![](https://via.placeholder.com/100.png?text=Photo) | James Koh | [Github](https://github.com/James17042002) | [Portfolio](team/james17042002.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Tiang Soon Yong | [Github](https://github.com/TiangSoonYong) | [Portfolio](team/tiangsoonyong.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Irwin Teo | [Github](https://github.com/zavsky) | [Portfolio](team/zavsky.md)

docs/README.md

@@ -1,8 +1,11 @@
-# Duke
+# RollaDie
 
-{Give product intro here}
+RollaDie is a Dungeon & Dragons (DnD) text-based RPG,designed for CLI play. 
+It offers a retro-style gaming experience where players can embark on adventures, make choices,
+and roll the dice to determine their fate. With its simple interface and replayable gameplay,
+RollaDie provides a fun and engaging escape for CS2113 students.
 
-Useful links:
+## Useful links:
 * [User Guide](UserGuide.md)
 * [Developer Guide](DeveloperGuide.md)
 * [About Us](AboutUs.md)

docs/UserGuide.md

@@ -1,42 +1,222 @@
-# User Guide
+# RollaDie User Guide
+
+## Table of content
+
+- [Introduction](#introduction)
+
+- [Quick Start](#quick-start)
+
+- [Features](#features)
+
+- [1. Starting a new game](#starting-a-new-game)
+
+- [2. Loading from a save](#loading-from-a-save)
+
+- [3. Making your character](#making-your-character)
+
+- [4. Choosing your battle ability](#choosing-your-battle-ability)
+
+- [5. Looting the enemy](#looting-the-enemy)
+
+- [6. Purchasing from the shop](#purchasing-from-the-shop)
+
+- [7. Saving the game](#saving-the-game)
+
+- [8. Exiting the game](#exiting-the-game)
+
+- [Command Summary](#command-summary)
+
+- [FAQ](#faq)
 
 ## Introduction
 
-{Give a product intro}
+RollaDie is a Dungeon & Dragons (DnD) text-based RPG, optimised to play using Command Line Interface (CLI) and has a simple text-ui display that reminisces games of the 1960s. Players face off hordes of enemies with the ultimate goal of achieving the legendary status in the annals of history. Join the story and learn the secrets that lay within!
+
+The target audience of this program are CS2113 students, but everyone is invited! It serves primarily as a stress reliever, and it aims to provide a dynamic and replay-able experience!
+
 
 ## Quick Start
 
-{Give steps to get started quickly}
+1. Ensure that you have Java 17 installed.
 
-1. Ensure that you have Java 17 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+2. Download the latest version of `Rolladie` from [here](https://github.com/AY2425S2-CS2113-T13-4/tp/releases/).
 
-## Features 
+3. From the folder containing the downloaded JAR file, run the following command in your terminal to start the game:
+- `java -jar ./rolladie.jar`
 
-{Give detailed description of each feature}
+## Features
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+> [!NOTE]
+> The dice outcome listed below are randomly generated, meaning the results will vary each time. As a result, the damage calculation will depend highly on the situation and can only be used as a reference
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+### Starting a new game
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+  ![](images/rolladie_mainmenu.png)
 
-Example of usage: 
+Upon first launch, input `1` to start a new game.
+### Loading from a save
 
-`todo n/Write the rest of the User Guide d/next week`
+To load from a previous save, input `2`.
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+![](images/rolladie_mainmenu_loadsave.png)
 
-## FAQ
+You can choose the specific save slot to load from. Select your choice and begin!
+### Making your character
+
+If starting from a new game, the game will then ask you for your hero's name. Choose a name and type it in!
+### Choosing your battle ability
+
+![](images/rolladie_battle.png)
+
+The game presents the round number (aka the bout number with the current opponent), your player stats, and the current enemy stats below.
+
+Let's break it down:
+`p` is our hero's name and he has 100 Hit Points (HP). Our player has 50 Power (out of a max possible 100), akin to mana that you encounter in other games of similar genre. The Weapon is an equipment that boosts your damage stats, while the Armor increases your durability. Below, we see our hero has three abilities he can use, namely Basic Attack, Power Strike and Heal.
+
+The enemy is mostly similar in makeup, but this one has 50 Hit Points and a different Weapon and Armor. You can see how the equipment affects each player differently during combat. He has only one ability, Power Strike. Generally, the AI will intelligently choose its ability based on the situation. However, when the AI has no valid moves available, it will default to use a Basic Attack.
+
+Select the ability you want to use for the round. Note that each ability comes with different costs (Power cost, Cooldown cost) and you will need to strategise well to survive!
+
+#### Battle sequence
+
+![](images/rolladie_battle1.png)
+
+In this example, we begin with using the Basic Attack ability.
+
+![](images/rolladie_battle2.png)
+
+The game proceeds to roll both players' dice, with your hero's dice shown on the left and the opponent's shown on the right. The rolled value is critical in the calculation of the final damage dealt to each player. Here, you are looking for a high value.
+
+![](images/rolladie_battle3.png)
+
+An animation plays out to visually represent the changes to Hit Points at the present turn. The bar changes colour depending on the status of your character.
+
+![](Pimages/rolladie_battle4.png)
+
+In the next turn, you will see the changes to the player stats at the top, any ability cooldown related blockers will be shown with a turn counter.
+
+![](images/rolladie_battle5.png)
+
+The narrator will announce the effects of your attacks, as well as those of your opponents.
+
+![](images/rolladie_battle6.png)
+
+Here, the game continues the battle until one of the players is down. If the player survives into the next encounter, he/she may be awarded a new skill and be able to loot from the fallen opponent.
+#### Strategizing for a win
+
+There are various strategies to thriving in the world of RollaDie. Careful planning of your skills to leverage on each of their strengths is crucial in maintaining the upper edge in each encounter.
+
+The damage calculation is as follows:
+\[(dice roll result) + (num of dice) * (weapon bonus)  - (opponent armor defense)] * \[(power) / (max power) * 0.5 * (ability damage multiplier)]
+
+To break it down further:
+- The number of dice impacts your damage calculation two-fold, the total roll result, as well as the weapon bonus per die rolled.
+- The available amount of power you have scales your damage output up to a total of 50%.
+- The used ability has an innate damage multiplier that will drastically change the total damage output.
+- Finally, the equipped armor and player's defense stat will have a fixed damage reduction bonus applied on top.
+### Looting the enemy
+
+After every battle, there will be a loot event!
+If you defeated the enemy, the loot event will grant you gold.
+If you fled from the enemy, no gold for you!
+
+### Buying and Selling in the shop
+
+Every 2 waves, the player will be able to purchase Equipment from the Shop. These Equipment consists of Armor, Boots, Weapon. 
 
-**Q**: How do I transfer my data to another computer? 
+Upon entering the Shop, the equipment on sale will be shown with their costs. There will be three commands to choose from. This is the main shop screen.
 
-**A**: {your answer here}
+![](images/rolladie_shop_entry.png)
+
+To select a command, just enter the corresponding index of the command.
+
+Entering "1", will select [1. Buy] and buy instructions will be shown.
+
+![](images/rolladie_buy_instructions.png)
+
+Entering an index within the list of equipments on sale will attempt purchase the corresponding equipment.
+
+It will be successful only if the player has enough gold.
+
+In this example, the user enters "2" to buy "Leather Soles", and it is successfully equipped:
+
+![](images/rolladie_buy_success.png)
+
+In this example, the user enters "2" to buy "Leather Soles", but the purchase does not go through due to insufficient gold:
+
+![](images/rolladie_buy_fail.png)
+
+After a command is executed, the main shop screen will be shown again.
+
+Entering "2", will select [2. Sell]. Sell instructions and a list of equipment Types will be shown.
+
+![](images/rolladie_sell_instructions.png)
+
+Entering an index within the list of equipment types will attempt to sell the Equipment owned by the player with the corresponding equipment type.
+
+It will be successful only if the player owns such an equipment type.
+
+In this example, the user enters "1" to sell the "Leather Soles" previously equipped. The user earns 5 gold, which is half the price of "Leather Soles".
+
+![](images/rolladie_sell_success.png)
+
+Since the "Leather Soles" are already sold, the player is left with an empty equipment slot for boots.
+
+Therefore, trying to sell boots again will be a failure, as illustrated in the example below.
+
+![](images/rolladie_sell_fail.png)
+
+Entering "3" in the main shop screen will select [3. Exit the Shop] and proceed to the next event.
+
+![](images/rolladie_shop_exit.png)
+
+.
+
+
+### Saving the game
+
+The game will periodically ask you to save the game at checkpoints. Type `y` when prompted to save and `n` to skip through. Specify a save slot (1-3) to save multiple progresses and return to them when necessary!
+
+### Exiting the game
+
+At any point in the game when it asks for input, you can insert the command, `exit`, to quit the game. Do note however, that any unsaved progress will be lost!
+
+### Game Rounds
+
+The total number of battle rounds is 10. The goal is to win the 10th round of the game to beat the game.
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
+There are no commands to remember. Simply follow and let the game guide you along!
+
+| Function             | Scenario    | Input                                          |
+|----------------------|-------------|------------------------------------------------|
+| Starting a new game | In main menu | `1` |
+| Loading a previous save | In main menu | `2` |
+| Creating a new character | In character screen | {your_hero_name} |
+| Choosing your battle ability | In combat | Integer corresponding to your choice of ability {1..*} |
+| Saving the game | At checkpoints | Input `y` and choose a slot number {1-3} |
+
+
+## FAQ
+
+**Q: How do I transfer my data to another computer?**
+
+A: Copy the `.dat` files created in the same directory over to the other computer you wish to continue your save from.
+
+**Q: What happens if I enter invalid input?**
+
+A: The game will not accept the input and will prompt for another valid one.
+
+**Q: What is the difference between HP, Power and Cooldown?**
+
+A: Remaining HP is a measure of your character's durability against incoming damage. When HP falls to zero, your character also falls. Power acts like mana as seen frequently in other games of such genre, in that it is an ability casting requirement to prevent skill spamming, but also gives you a damage boost the more you stack it. So it helps add strategic depth. Cooldown applies to individual skills so that players are forced to choose their combat sequence tactically for the best outcome.
+
+**Q: What is the difficulty of the game?**
+
+A: The enemy will get stronger as the battles progresses, until the player reaches the final enemy. Therefore, players have to upgrade themself through the loot
+and shop events that occur after battles, with loot appearing after every battle and shop appearing after every 2 battles.
+
+**Q: What happens if I close the application without using the `exit` command?**
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+A: Any previously saved progress will remain available. However, if there are any progress made between the point of exit and the point of last save, then those progress will be lost.