add README
This commit is contained in:
@@ -1,26 +0,0 @@
|
||||
package org.project.item.consumables;
|
||||
|
||||
import org.project.item.Item;
|
||||
|
||||
public abstract class Consumable implements Item {
|
||||
|
||||
protected int id;
|
||||
protected String name;
|
||||
protected int amount;
|
||||
|
||||
public Consumable(String name, int id, int amount) {
|
||||
this.name = name;
|
||||
this.id = id;
|
||||
this.amount = amount;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getName() {
|
||||
return name;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getId() {
|
||||
return id;
|
||||
}
|
||||
}
|
||||
@@ -1,29 +0,0 @@
|
||||
package org.project.item.consumables;
|
||||
|
||||
import org.project.entity.Entity;
|
||||
import org.project.entity.players.Player;
|
||||
|
||||
public class Flask extends Consumable{
|
||||
|
||||
private static final int HEAL_AMOUNT = 20;
|
||||
private static final String YELLOW = "\033[33m";
|
||||
public static final String RESET = "\u001B[0m";
|
||||
|
||||
public Flask(String name, int id)
|
||||
{
|
||||
super(name, id, HEAL_AMOUNT);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void use(Entity target) {
|
||||
if (target != null && target.isAlive()) {
|
||||
target.heal(HEAL_AMOUNT);
|
||||
Player player = (Player) target;
|
||||
System.out.println("🧪 " + player.getName() + " used Flask! Healed " + HEAL_AMOUNT + " HP.");
|
||||
}
|
||||
else
|
||||
{
|
||||
System.out.println(YELLOW+"❌ Cannot use Flask on a dead or null target."+RESET);
|
||||
}
|
||||
}
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -1,175 +1,108 @@
|
||||
# Fourth Assignment - Java Knight ⚔️
|
||||
A turn-based RPG with Roguelike elements which can be run in the terminal.
|
||||
|
||||
# Java Knight ⚔️
|
||||
### **Prologue: The Legend of Javanest**
|
||||
*For centuries, the land of Javanest lived in peace, until a magical Dragon attacked, plunging the realm into absolute darkness. With a wicked curse, the Dragon transformed the innocent people into horrific monsters: Goblins, Skeletons, and Vampires. Retreating to its impenetrable Castle, the Dragon divided the three keys to its lair and hid them among these cursed creatures. Now, it is your duty to step up and save the land. You must battle these monsters, recover the unique key from each monster type, and finally slay the Dragon to break the curse and restore peace to Javanest!*
|
||||
|
||||
### **Introduction**
|
||||
Welcome to **Java knight**, a turn-based RPG inspired by Roguelike games! In this assignment, you will develop a **text-based role-playing game (RPG)**. This project is designed to rigorously test your understanding of **Object-Oriented Programming (OOP) principles**.
|
||||
### Introduction
|
||||
Java Knight is a text-based Role-Playing Game developed using OOP principles in java. The gameplay is driven by interactive console messages and user input.
|
||||
|
||||
⚠️ **REQUIREMENT:** You **must** utilize all the OOP concepts you have learned so far—including *Inheritance, Interfaces, Abstract Classes, Encapsulation, Polymorphism, Overloading, and Overriding*. It is extremely important that you use everything in its right place. Your design and architecture will be graded based on how well you apply these principles to avoid code duplication and maintain a clean structure.
|
||||
___
|
||||
#### Setup:
|
||||
1. Install JDK
|
||||
2. Install IntelliJ IDEA
|
||||
3. Run the `Main` class in the project
|
||||
___
|
||||
|
||||
🎯 **Your goal is not just to complete the assignment but to learn and apply OOP effectively!**
|
||||
|
||||
### **What is a Turn-Based Game?**
|
||||
In this combat system, two sides - which are usually the player's side and the enemy's side - attack each other in turns. The side which is not attacking can perform actions to avoid or deflect the enemy's attack.
|
||||
|
||||
### **Core Mechanics:**
|
||||
- **Turn-based combat** – Players and monsters take turns attacking each other.
|
||||
- **Character classes with Unique Traits** – Players can choose from archetypes like **Knight, Assassin, or Wizard**, each starting with distinctly different base stats.
|
||||
- **Unified Mana/Stamina System** – All player classes use a unified resource (Mana/Stamina) to perform actions.
|
||||
- **Standardized Action Set** – Every player character has exactly 5 specific actions available during their turn.
|
||||
- **Experience & Leveling System** – Earn XP based on enemy strength to automatically level up and increase your base stats.
|
||||
- **Progression System** – You cannot fight the Dragon immediately. You must farm enemies for a chance to drop their specific key, collect all three, and grow stronger first.
|
||||
|
||||
---
|
||||
|
||||
## Tasks 📝
|
||||
|
||||
### 1️⃣ Step 1: Fork & Setup 🍴
|
||||
1. **Fork** this repository and clone it to your local machine.
|
||||
```bash
|
||||
git clone https://git.meshcomp.ir/AdvancedProgramming1404/HW-04-JAVA-KNIGHT.git
|
||||
```
|
||||
2. Create a new branch named `develop` and switch to it.
|
||||
```bash
|
||||
git checkout -b develop
|
||||
```
|
||||
### 2️⃣ Step 2: Implement the Class Hierarchy 🌲
|
||||
|
||||
A well-structured OOP hierarchy is crucial. Avoid duplicating code by placing shared logic in abstract classes.
|
||||
|
||||
- **Entities & Locations:** You have `Entity`, `Item`(Bonus) , and `Location`.
|
||||
- **Players:** `Player` is an abstract class implementing `Entity`. Subclasses: `Wizard`, `Knight`, `Assassin`.
|
||||
- **Base Stat Differences:** Each class must have distinct starting stats. For example:
|
||||
- **Knight:** Highest Base Damage.
|
||||
- **Wizard:** Highest Max Health (HP).
|
||||
- **Assassin:** Highest Max Stamina/Mana.
|
||||
- **Enemies:** `Enemy` is an abstract class implementing `Entity`. Subclasses: `Skeleton`, `Goblin`, `Vampire`, and **`Dragon`**.
|
||||
- **The Boss:** Even though `Dragon` is the final boss, it **must** be a subclass of `Enemy` to inherit common combat properties, while possessing extremely high stats and unique mechanics.
|
||||
- **Item (Bonus):** `Consumable`, `Armor`, `Weapon` are abstract classes implementing `Item`. example :
|
||||
- KnightArmor extends Armor - you can add more subclasses of Armor for extra score
|
||||
- Sword extends Weapon - you can add more subclasses of Weapon for extra score
|
||||
- Flask extends Consumable - you can add more subclasses of Consumable for extra score
|
||||
|
||||
|
||||
|
||||
### 3️⃣ Step 3: Implement Player & Monster Methods 🏹
|
||||
|
||||
**Player Actions (The Rule of Five):**
|
||||
Every player class **must** implement exactly the following 5 actions (You can use an interface like `ICombatActions`). Every action (except Light Attack) consumes a specific amount of Mana/Stamina. The **Special Ability** must consume the *highest* amount of Mana compared to the others.
|
||||
1. **Light Attack:** Deals moderate damage and costs **NO Mana**. (Note: If the player runs out of Mana/Stamina, this is the ONLY action they can perform.)
|
||||
2. **Heavy Attack:** Deals high damage, medium Mana cost.
|
||||
3. **Defend:** Completely blocks or significantly reduces the damage of the enemy's *next* strike. Medium Mana cost.
|
||||
4. **Heal:** Restores a portion of the player's HP. Medium-high Mana cost.
|
||||
5. **Special Ability:** A unique class-based ultimate move (Highest Mana cost):
|
||||
- **Wizard** 🧙♂️: Casts a devastating spell that damages the enemy while simultaneously replenishing some HP.
|
||||
- **Assassin** 🗡️: Turns invisible, dodging the next incoming attack completely and guaranteeing a *Critical Hit* on their next turn.
|
||||
- **Knight** ⚔️: Performs a shield bash that stuns the enemy, forcing them to skip their next turn while dealing heavy damage.
|
||||
|
||||
**Monster Abilities:**
|
||||
- **Goblin** 👹: High critical hit chance but low health.
|
||||
- **Skeleton** ☠️: Can resurrect once per battle with 50% HP.
|
||||
- **Vampire** 🦇: Lifesteal ability – a portion of the damage it deals to the player is added back to its own health.
|
||||
- **Dragon (Final Boss)** 🐉: Immune to normal defense. Its fiery breath bypasses shields and deals massive damage.
|
||||
|
||||
🔹 Make sure each entity **prints messages** when performing actions. example output (while in combat) :
|
||||
|
||||
```bash
|
||||
You chose to FIGHT!
|
||||
|
||||
[Ser Duncan - 45/45 HP | 40/40 Mana]
|
||||
[Goblin - 30/30 HP]
|
||||
|
||||
---
|
||||
|
||||
Your Turn:
|
||||
1. Light Attack | 2. Heavy Attack (-8 Mana) | 3. Defend (-6 Mana) | 4. Heal (-12 Mana) | 5. Shield Bash (-15 Mana)
|
||||
### How to play:
|
||||
1. **Create character:** Knight/ Wizard/ Assassin
|
||||
```java
|
||||
🏰 Welcome to Java Knight!
|
||||
Enter your name:
|
||||
Gru
|
||||
1. ⚔️ Knight (High Damage, Balanced HP)
|
||||
2. 🧙 Wizard (High HP, Magic Power)
|
||||
3. 🗡️ Assassin (High Mana, Critical Hits)
|
||||
Choose your character: 3
|
||||
You chose the Assassin!
|
||||
```
|
||||
|
||||
```bash
|
||||
→ Chose: Light Attack
|
||||
⚔️ Ser Duncan (Knight) used Light Attack! (0 Mana)
|
||||
Goblin took 10 damage!
|
||||
Goblin has 20/30 HP remaining.
|
||||
Ser Duncan Mana: 40/40
|
||||
2. **Select location:** Forest/ Cave/ Swamp
|
||||
```java
|
||||
🗺️ Choose your starting location:
|
||||
1. Dark Forest
|
||||
2. Spooky Cave
|
||||
3. Swamp
|
||||
Enter your choice: 2
|
||||
🚶 You have arrived at: Spooky Cave
|
||||
```
|
||||
```
|
||||
Goblin's Turn :
|
||||
👹 Goblin used Critical Strike!
|
||||
💥 Critical hit! Ser Duncan took 20 damage!
|
||||
Ser Duncan has 25/45 HP remaining.
|
||||
```
|
||||
🔹 *Narrative Console:* Use ANSI escape codes to print colorful narrative logs (e.g., Red for damage, Blue for Mana usage, Green for healing).
|
||||
|
||||
|
||||
### 4️⃣ Step 4: Implement the Game Loop & Progression 🎮
|
||||
|
||||
1. **The Core Loop:** The game starts with the player entering a location. A random standard enemy (`Goblin`, `Skeleton`, or `Vampire`) spawns immediately.
|
||||
2. **Player Choices:** Before engaging, the player is presented with the following options:
|
||||
- **1. Fight the enemy:** Enter the turn-based combat sequence.
|
||||
- **2. Move to another location:** Skip the current enemy and spawn a new random one.
|
||||
- **3. Go to the Castle to fight the Dragon:** *(Note: This option must remain strictly hidden or locked until the player has successfully collected all 3 keys).*
|
||||
3. **The Key Drop Logic (RNG Gatekeeping):**
|
||||
- When the player defeats an enemy, there is a **specific percentage chance (e.g., 20%)** that it will drop the unique key associated with its species (Goblin Key, Skeleton Key, Vampire Key).
|
||||
- **One Key Per Species:** Once a player obtains a specific key (e.g., Goblin Key), subsequent enemies of that same type (other Goblins) will **never** drop a key again.
|
||||
- The player **must collect all 3 distinct keys** to unlock Option 3 and enter the Castle.
|
||||
4. **Post-Combat Recovery:** After each successful battle, the player's HP and Mana bars must automatically replenish (either fully or partially) to their base amounts so they are ready for the next encounter.
|
||||
5. **Experience & Leveling System:**
|
||||
- Defeating an enemy grants **XP**. The amount of XP must scale proportionally to the enemy's power level.
|
||||
- Upon reaching an XP threshold, the player levels up. **Leveling up must automatically increase the player's Max HP and Max Stamina/Mana**, making them strong enough to eventually face the Dragon.
|
||||
6. **Final Boss Fight:** Once the 3 Keys are obtained and the player chooses to go to the Castle, they will face the Dragon. Defeating the Dragon breaks the curse, resulting in **Victory**. Dying at any point results in **Game Over**.
|
||||
|
||||
🔹 Example game loop structure:
|
||||
<br/> When you arrive at the selected location, an enemy (Goblin/ Skeleton/ Vampire) spawns randomly. You can fight, move to another location, or quit.
|
||||
|
||||
```java
|
||||
while (player.isAlive() && enemy.isAlive())
|
||||
player.attack(enemy);
|
||||
if (enemy.isAlive()) {
|
||||
enemy.attack(player);
|
||||
}
|
||||
}
|
||||
⚠️ A wild Vampire appears in Spooky Cave!
|
||||
```
|
||||
```java
|
||||
📍 Location: Spooky Cave
|
||||
❤️ Player HP: 150/150
|
||||
💎 Player MP: 120/120
|
||||
Enemy: Vampire (HP: 80)
|
||||
---- Actions ----
|
||||
1. 🥷 Fight enemy
|
||||
2. 🚶 Move to another location
|
||||
3. 🔒 Go to Dragon Castle
|
||||
4. 🏳️ Quit game
|
||||
```
|
||||
|
||||
3. **Fight:** You can use one of these 5 actions:
|
||||
* Light Attack: Deals moderate damage and costs NO Mana. (Note: If you run out of Mana, this is the ONLY action you can perform.)
|
||||
* Heavy Attack: Deals high damage, medium Mana cost.
|
||||
* Defend: Reduces the damage of the enemy's next strike. Medium Mana cost.
|
||||
* Heal: Restores a portion of the player's HP. Medium-high Mana cost.
|
||||
* Special Ability: A unique class-based ultimate move (Highest Mana cost).
|
||||
|
||||
### 5️⃣ Step 5: Extra Features & Bonus Tasks ⭐
|
||||
*(Optional for extra credit)*
|
||||
```java
|
||||
⚔️ Battle Started: Gru vs Vampire
|
||||
|
||||
✅ **Dynamic Economy & Merchant System:** Implement coins that drop from enemies. Add a "Visit Merchant" option to the main loop where players can spend coins to buy specific weapons, armors, or consumables.
|
||||
✅ **Multiple Weapons & Inventory:** Players can buy, store, and swap between multiple weapons or use consumables mid-combat.
|
||||
✅ **Multiplayer/Party Mode:** Allow multiple players to team up and fight multiple enemies together. The Dragon's breath attack will damage the entire party simultaneously.
|
||||
✅ **PvP Mode:** Implement a **Player vs. Player** combat system.
|
||||
--- Your Turn ---
|
||||
1. Light Attack | 2. Heavy Attack (-20 Mana) | 3. Defend (-15 Mana) | 4. Heal (-30 Mana) | 5. Special (-50 Mana)
|
||||
```
|
||||
|
||||
### 6️⃣ Step 6: Write a Comprehensive README 📄
|
||||
As the final mandatory step of your development, you must replace the default `README.md` with your own comprehensive documentation. Your README should include:
|
||||
- A brief introduction to the game.
|
||||
- How to compile and run your project from the terminal.
|
||||
- An explanation of the classes, design patterns, and OOP principles you used.
|
||||
- A brief guide on how to play (controls, stats, classes).
|
||||
4. You cannot fight the Dragon immediately. You must fight enemies for a chance to drop their specific key, collect all three, and grow stronger first.
|
||||
|
||||
---
|
||||
|
||||
## Evaluation Criteria ⚖
|
||||
#### More about the game and characters
|
||||
* Special abilities:
|
||||
* Wizard 🧙♂️: Casts a devastating spell that damages the enemy while simultaneously replenishing some HP.
|
||||
* Assassin 🗡️: Turns invisible, dodging the next incoming attack completely and guaranteeing a Critical Hit on their next turn.
|
||||
* Knight ⚔️: Performs a shield bash that stuns the enemy, forcing them to skip their next turn while dealing heavy damage.
|
||||
* Monsters:
|
||||
* Goblin 👹: High critical hit chance(40%) but low health.
|
||||
* Skeleton ☠️: Can resurrect once per battle with 50% HP.
|
||||
* Vampire 🦇: Lifesteal ability – a portion of the damage it deals to the player is added back to its own health.
|
||||
* Dragon (Final Boss) 🐉: Immune to normal defense. Its fiery breath bypasses shields and deals massive damage.
|
||||
|
||||
| **Criteria** | **Points** |
|
||||
|-------------------------------------------------------------|------------|
|
||||
| Proper use of OOP principles | **50** |
|
||||
| Working combat mechanics, Leveling System & Enemy abilities | **20** |
|
||||
| Clear and Comprehensive `README.md` | **20** |
|
||||
| Code readability, documentation, and comments | **10** |
|
||||
| Meaningful, interactive, & colored console outputs | **10** |
|
||||
| Inventory (item) and Merchant System (bonus) | **20** |
|
||||
| Other Extra features (bonus tasks) | **20** |
|
||||
| **Total Score** | **150** |
|
||||
Once you obtain a specific key (e.g., Goblin Key), subsequent enemies of that same type (other Goblins) will never drop a key again. You can still fight enemies to earn XP based on enemy strength to automatically level up and increase your base stats (max health and Mana) and become strong enough to face the Dragon.
|
||||
___
|
||||
|
||||
## Tips 🚀
|
||||
- **Follow OOP principles**: Avoid redundant code by using inheritance properly. Think carefully about what belongs in an abstract class vs. a specific subclass. Make sure you use overriding and overloading correctly.
|
||||
- **Test your code**: Run different scenarios (fighting, running out of mana, leveling up, dying) to ensure everything works as expected.
|
||||
- **Ask for help**: If you're stuck, reach out to your classmates or mentors.
|
||||
### Object-Oriented Programming concepts implementation
|
||||
#### 1. Encapsulation
|
||||
Data hiding is used to protect the internal state of objects.
|
||||
* Usage: All fields in class are declared as `private` or `protected`. Access to these fields are controlled through `public` getter and setter methods. (e.g. `getName`, `setHP`). This ensures that the name or health of the entity cannot be modified incorrectly outside the class.
|
||||
#### 2. Inheritance
|
||||
Code reusability is achieved by creating a hierarchy of classes and interfaces.
|
||||
* Usage:
|
||||
* `Player` is an abstract class implementing `Entity`. Subclasses: `Knight`, `Wizard`, `Assassin`.
|
||||
* Also `Enemy` is the superclass for `Goblin`, `Skeleton`, `Vampire` and `Dragon`.
|
||||
* `Armor` and `Weapon` implementing `Item`. `Sword`, `Dagger`, and `Wand` extend `Weapon`; `Robe`, `KnightArmor`, `LeatherArmor` extend `Armor`.
|
||||
#### 3. Polymorphism
|
||||
The ability to process objects differently based on their data type is used extensively.
|
||||
* Usage:
|
||||
* Method Overriding: Each enemy class overrides the `attack()` method. For example, the `Dragon` class overrides `attack()` to handle its special "Fiery Breath" mechanic, which ignores player defense. Similarly, each character class (`Knight`, `Wizard`, `Assassin`) overrides `specialAbility()` to provide unique skills.
|
||||
* Polymorphic Collections: We use a `List<Enemy>` to store different types of enemies. We can iterate through this list and call `enemy.attack(player)` without knowing the specific type of enemy, and the correct version of the method will be executed.
|
||||
#### 4. Abstraction
|
||||
Complex implementation details are hidden behind simple interfaces.
|
||||
|
||||
* Usage:
|
||||
* The `Entity` class is declared as abstract. It defines abstract methods like `attack()` which must be implemented by every subclass.
|
||||
* The `Player` class is abstract, forcing subclasses like `Assassin` to implement the `specialAbility(Entity target)`.
|
||||
|
||||
## Submission ⌛
|
||||
- **Deadline**: Submit your assignment before **21 Ordibehesht (May 11th, 2026)**.
|
||||
- **Submission Format**: Push your code to your forked repository, create a PR, and ensure your comprehensive `README.md` is included in the root directory.
|
||||
|
||||
|
||||
###### - Born of God and Void. You shall seal the blinding light that plagues their dreams. You are the Vessel. You are the Java Knight.
|
||||
Reference in New Issue
Block a user