A turn-based RPG with Roguelike elements which can be run in the terminal.
# Java Knight ⚔️
Welcome to **Java Knight**, a turn-based RPG with Roguelike elements which can be run in the terminal.
### **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**.
⚠️ **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.
🎯 **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.
### 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 navigate through dangerous encounters, recover the unique key from each monster type, and slay the Dragon to break the curse and restore peace to Javanest!*
---
## Tasks 📝
## How The Game Works 🎮
### 1️⃣ Step 1: Fork & Setup 🍴
1.**Fork** this repository and clone it to your local machine.
2. Create a new branch named `develop` and switch to it.
```bash
git checkout -b develop
```
### 2️⃣ Step 2: Implement the Class Hierarchy 🌲
- **The Core Loop:** The game starts with the player spawning at his camp. He can then choose to:
- **1. Enter the portal:** Which will lead either to a random standard location (`Forest`, `Graveyard`, or `Crypt`), or to the Dragon's castle based on the player's choice.
- **2. Visit the Merchant:** To buy and store Weapons, Armors and different Consumables.
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
- **Player Choices:** Before engaging in a fight and after spawning at a random location, 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.
- **Going to the Castle to fight the Dragon:** The player may enter the Dragon's castle only if he has all 3 unique keys.
- **The Key Drop Logic (RNG Gatekeeping):**
-When the player defeats an enemy, there is a **specific percentage chance** 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.
- **Experience & Leveling System:**
- Defeating an enemy grants **XP** and some **Coins**. The amount of XP and Coins scale proportionally to the enemy's power level.
- Upon reaching an XP threshold, the player levels up. **Leveling up automatically increases the player's Max HP and Max Stamina**, making them strong enough to eventually face the Dragon.
- **Post-Combat Recovery:** After each successful battle, the player has the choice to either continue fighting enemies, or to return to his camp to recover HP and Stamina.
- **Final Boss Fight:** Once all three unique keys are collected, the player can unlock the Castle gates to face the Dragon. Defeating the Dragon breaks the curse, resulting in **Victory**. Dying at any point results in **Game Over**.
---
## Core Mechanics ⚙️
- **Turn-based combat** – The player and monsters take turns attacking each other or defending themselves. Each entity performs one of these 4 possible moves during their turn:
- **1. Light Attack:** Deals basic damage, no Stamina cost.
- **2. Heavy Attack:** Deals high damage, medium Stamina cost.
- **3. Defend:** Completely blocks the enemy's *next* strike, medium Stamina cost.
- **4. Special Ability:** A unique class-based ultimate move, high Stamina cost (available only to the player and the final boss).
In addition to these moves, the player can also use consumables mid-fight without using their turn.
- **Character classes with Unique Traits** – Players can choose from archetypes like **Knight, Assassin, or Wizard**, each starting with distinctly different base stats:
- **Knight** ⚔️: Highest Base Damage.
- **Special:** Performs a shield bash that stuns the enemy, forcing them to skip their next turn while dealing heavy damage.
- **Assassin** 🗡️: Highest Max Stamina.
- **Special:** Turns invisible, dodging the next incoming attack completely and guaranteeing a Critical Hit on their next turn.
- **Wizard** 🧙♂️: Highest Max Health (HP).
- **Special:** Casts a devastating spell that damages the enemy while simultaneously replenishing some HP.
- **Monsters' Attributes:**
- **Goblin** 👹: High heavy attack chance but low health.
- **Skeleton** 💀: Can resurrect once per battle with 50% HP.
- **Vampire** 🧛♂️: Life steal 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.
---
## OOP Principles Used 📋
This project is made using Object-Oriented Programming (OOP) Principles. Here is a brief explanation of how and where these concepts are applied:
### 1️⃣ Encapsulation
**Encapsulation** means restricting direct access to an object's internal data by using `private` (or in some cases `protected`) modifiers, and requiring all access and interactions to happen through public methods.
For example, variables like `hp`, `stamina`, or armor's `durability` cannot be directly viewed or changed by external classes. Instead, we use getter/setter methods to access these variables and methods like `takeDamage()`, `spendStamina()` and `reduceDurability()` to handle the logic.
### 2️⃣ Inheritance
**Inheritance** means deriving new classes from existing ones, allowing child classes to automatically contain fields and methods from its parent class without rewriting duplicate code.
We use inheritance when we want a class to include the general logic of another class, but with some of its features defined more specifically.
For example, `Knight`, `Assassin` or `Wizard` all inherit the general mechanics of the `Player` class, but each subclass specifies its own unique base stats and special abilities.
### 3️⃣ Abstraction
**Abstraction** means defining a class's base structure, while leaving the specific execution details for later.
We can achieve and use abstraction in two ways:
- **1. Through Abstract Classes:** For example, `Player` and `Enemy` classes are abstract. They contain the base structure and important logic needed, but each subclass define its own unique details in its own way (like `specialAbility()` for `Player` subclasses and `choice()` for `Enemy` subclasses).
- **2. Through Interfaces:** For example, The `Entity` interface acts as a strict contract which ensures that any implementing class (like `Player` and `Enemy`) MUST include behaviors like `lightAttack()`, `defend()` and any methods mentioned in the interface. This allows the game to handle players and monsters the same way.
### 4️⃣ Polymorphism
**Polymorphism** means different objects responding differently to the exact same method call. Java automatically figures out which specific version of the method to run at runtime based on the object's active subclass type.
For example, when the combat loop executes `player.specialAbility(enemy);`, Java automatically determines which version to execute: the Knight’s shield, the Assassin’s strike, or the Wizard’s spell.
### 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.
## Other Features In This Game ⭐
**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.
- ### Merchant System & Inventory Management:
Coins you earn from defeated enemies can be spent at the Camp merchant to purchase, store, and use different Weapons, Armors, and Consumables like Healing Flasks and Stamina Potions!
🔹 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]
- ### Enhanced Console UX:
ANSI escape codes are used to provide color-coded narrative output.
2. **Open** the project folder in your preferred Java IDE.
### 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:
```java
while(player.isAlive()&&enemy.isAlive())
player.attack(enemy);
if(enemy.isAlive()){
enemy.attack(player);
}
}
```
### 5️⃣ Step 5: Extra Features & Bonus Tasks ⭐
*(Optional for extra credit)*
✅ **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.
### 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).
| Inventory (item) and Merchant System (bonus) | **20** |
| Other Extra features (bonus tasks) | **20** |
| **Total Score** | **150** |
## 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.
## 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.
3. **Run** the `Main.java` class and enjoy the game!
###### - 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
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
