Merge pull request 'Merge develop into main' (#1) from develop into main

Reviewed-on: #1

Java-Knight/src/main/java/org/project/GameLoop.java

@@ -0,0 +1,312 @@
+package org.project;
+
+import org.project.combat.*;
+import org.project.entity.enemies.*;
+import org.project.entity.players.*;
+import org.project.location.Location;
+import org.project.managers.*;
+
+import java.util.*;
+
+public class GameLoop {
+
+    private final Scanner scanner = new Scanner(System.in);
+
+    private final ActionDecisionManager actionManager = new ActionDecisionManager();
+    private final StatusEffectManager statusManager = new StatusEffectManager();
+    private final SpecialAbilityManager abilityManager = new SpecialAbilityManager();
+    private final ManaCostManager manaManager = new ManaCostManager();
+
+    private final TotalAttackCalculator attackCalculator =
+            new TotalAttackCalculator(statusManager, abilityManager, manaManager);
+
+    private Player player;
+    private Enemy currentEnemy;
+
+    private boolean gameRunning = true;
+
+    private boolean hasGoblinKey;
+    private boolean hasSkeletonKey;
+    private boolean hasVampireKey;
+
+    private Location currentLocation;
+    private final List<Location> locations = new ArrayList<>();
+
+
+    public GameLoop() {
+        initializeLocations();
+    }
+
+    private void initializeLocations() {
+
+        Location valhalla = new Location("Valhalla");
+        Location elysium = new Location("Elysium");
+        Location niflheim = new Location("Niflheim");
+        Location castle = new Location("Castle");
+
+        valhalla.connect(elysium);
+        valhalla.connect(niflheim);
+        elysium.connect(niflheim);
+        niflheim.connect(castle);
+
+        locations.add(valhalla);
+        locations.add(elysium);
+        locations.add(niflheim);
+        locations.add(castle);
+
+        currentLocation = valhalla;
+    }
+
+    public void start() {
+
+        System.out.println("====== JAVA KNIGHT ======");
+
+        chooseClass();
+        spawnEnemy();
+
+        while (gameRunning) {
+            showMenu();
+        }
+
+        System.out.println("Game Ended.");
+    }
+
+    private void chooseClass() {
+
+        System.out.println("""
+                Choose class:
+                1. Knight   (HP:150 MP:80 DMG:12)
+                2. Wizard   (HP:80 MP:200 DMG:10)
+                3. Assassin (HP:90 MP:120 DMG:15)
+                """);
+
+        int choice = scanner.nextInt();
+
+        switch (choice) {
+            case 2 -> player = new Wizard("Merlin");
+            case 3 -> player = new Assassin("Shadow");
+            default -> player = new Knight("Sir Duncan");
+        }
+    }
+
+    private void showMenu() {
+
+        System.out.println("====" + Colors.YELLOW +  " GAME MENU " + Colors.RESET + "====");
+        System.out.println("Location: " + currentLocation.getName());
+
+        if (currentEnemy != null)
+            System.out.println("Enemy: " + currentEnemy);
+
+        System.out.println("""
+                \n1. Fight
+                2. Inventory
+                3. Move
+                0. Exit
+                """);
+
+        if (hasAllKeys())
+            System.out.println("4. Fight Dragon");
+
+        int choice = scanner.nextInt();
+
+        switch (choice) {
+            case 1 -> startCombat();
+            case 2 -> new InventoryManager().displayInventory(player);
+            case 3 -> move();
+            case 4 -> {
+                if (hasAllKeys())
+                    fightDragon();
+            }
+            case 0 -> gameRunning = false;
+        }
+    }
+
+    private void move() {
+
+        List<Location> connected = currentLocation.getConnectedLocations();
+
+        if (connected.isEmpty()) {
+            System.out.println("No paths from here.");
+            return;
+        }
+
+        System.out.println("Choose destination:");
+
+        for (int i = 0; i < connected.size(); i++)
+            System.out.println((i + 1) + ". " + connected.get(i).getName());
+
+        int choice = scanner.nextInt();
+
+        if (choice < 1 || choice > connected.size())
+            return;
+
+        currentLocation = connected.get(choice - 1);
+
+        spawnEnemy();
+    }
+
+    private void spawnEnemy() {
+
+        Enemy[] enemies = {
+                new Goblin(),
+                new Skeleton(),
+                new Vampire()
+        };
+
+        currentEnemy = enemies[(int) (Math.random() * enemies.length)];
+    }
+
+    private void startCombat() {
+
+        if (currentEnemy == null) {
+            System.out.println("No enemy here.");
+            return;
+        }
+
+        System.out.println(Colors.RED_BRIGHT + "⚔ COMBAT STARTED! ⚔" + Colors.RESET);
+
+
+        while (player.isLive() && currentEnemy.isLive()) {
+
+            statusManager.tick(player);
+            statusManager.tick(currentEnemy);
+
+            abilityManager.tick(currentEnemy, player);
+            abilityManager.tick(player, currentEnemy);
+
+            if (!player.isLive() || !currentEnemy.isLive())
+                break;
+
+            playerTurn();
+            currentEnemy.resetTurnState();
+
+            if (currentEnemy.isLive())
+                enemyTurn();
+            player.resetTurnState();
+        }
+
+        if (player.isLive())
+            victory();
+        else
+            gameRunning = false;
+    }
+
+
+    private void playerTurn() {
+        System.out.println("====" + Colors.YELLOW +  " YOUR TURN " + Colors.RESET + "====");
+        System.out.println(player.getName() + "-> HP: " + player.getHp() + " | MP: " + player.getMp() + " | level: " + player.getLevel() + " | XP: " + player.getXp());
+        System.out.println(currentEnemy.getName() + "-> HP: "  + currentEnemy.getHp() + " | MP: " + currentEnemy.getMp());
+        System.out.println("\n");
+        var action = actionManager.userChooseAction();
+
+        AttackResult result = attackCalculator.calculate(player, currentEnemy, action);
+
+        int totalDamage = result.getDamageToTarget();
+        int healAmount = result.getHealSelf();
+        boolean isDefend = result.isDefended();
+
+        if (totalDamage > 0) {
+            System.out.println(currentEnemy.getName() + " got " + totalDamage + " damage");
+            currentEnemy.takeDamage(totalDamage);
+        }
+
+        if (healAmount > 0) {
+            player.heal(healAmount);
+            if (player.getHp() < player.getMaxHP())
+                System.out.println(player.getName() + "healed " + healAmount + " HP");
+        }
+
+        if (isDefend) {
+            player.defend();
+            System.out.println(player.getName() + " will defend (50% damage)");
+        }
+        System.out.println("\n");
+    }
+
+    private void enemyTurn() {
+        System.out.println("====" + Colors.YELLOW +  " ENEMY TURN " + Colors.RESET + "====\n");
+        var action = actionManager.botChooseAction();
+
+        System.out.println("enemy random choose action: " + Colors.RED + action + Colors.RESET);
+
+        AttackResult result = attackCalculator.calculate(currentEnemy, player, action);
+
+        int totalDamage = result.getDamageToTarget();
+        int healAmount = result.getHealSelf();
+        boolean isDefend = result.isDefended();
+
+
+        if (totalDamage > 0) {
+            System.out.println(player.getName() + " got " + totalDamage + " damage");
+            player.takeDamage(totalDamage);
+        }
+
+        if (healAmount > 0) {
+            currentEnemy.heal(healAmount);
+            if (currentEnemy.getHp() < currentEnemy.getMaxHP())
+                System.out.println(currentEnemy.getName() + " healed " + healAmount + " HP");
+
+        }
+
+        if (isDefend) {
+            currentEnemy.defend();
+            System.out.println(currentEnemy.getName() + " will defend (50% damage)");
+        }
+
+
+        System.out.println("\n");
+
+    }
+
+    private void victory() {
+
+        System.out.println(Colors.GREEN + "Victory!" + Colors.RESET);
+
+        currentEnemy.rewardXp(player);
+
+        checkKeyDrop();
+
+        player.restore();
+
+        currentEnemy = null;
+    }
+
+    private void checkKeyDrop() {
+
+        if (Math.random() * 100 > 20)
+            return;
+
+        if (currentEnemy instanceof Goblin && !hasGoblinKey) {
+            hasGoblinKey = true;
+            System.out.println("Goblin Key obtained!");
+        }
+
+        else if (currentEnemy instanceof Skeleton && ! hasSkeletonKey) {
+            hasSkeletonKey = true;
+            System.out.println("Skeleton Key obtained!");
+        }
+
+        else if (currentEnemy instanceof Vampire && !hasVampireKey) {
+            hasVampireKey = true;
+            System.out.println("Vampire Key obtained!");
+        }
+    }
+
+    private boolean hasAllKeys() {
+        return hasGoblinKey && hasSkeletonKey && hasVampireKey;
+    }
+
+    private void fightDragon() {
+
+        currentEnemy = new Dragon();
+
+        System.out.println("The Dragon Appears!");
+
+        startCombat();
+
+        if (player.isLive())
+            System.out.println("YOU SAVED JAVANEST!");
+        else
+            System.out.println("The Dragon has defeated you...");
+    }
+}

Java-Knight/src/main/java/org/project/combat/AttackResult.java

@@ -0,0 +1,18 @@
+package org.project.combat;
+
+public class AttackResult {
+
+    private int damageToTarget;
+    private int healSelf;
+    private boolean defended;
+
+    public AttackResult(int damageToTarget, int healSelf, boolean defended) {
+        this.damageToTarget = damageToTarget;
+        this.healSelf = healSelf;
+        this.defended = defended;
+    }
+
+    public int getDamageToTarget() { return damageToTarget; }
+    public int getHealSelf() { return healSelf; }
+    public boolean isDefended() { return defended; }
+}

Java-Knight/src/main/java/org/project/combat/TotalAttackCalculator.java

@@ -0,0 +1,198 @@
+package org.project.combat;
+
+import org.project.abilities.SpecialAbility;
+import org.project.entity.Entity;
+import org.project.entity.players.Player;
+import org.project.item.armors.Armor;
+import org.project.item.weapons.Weapon;
+import org.project.managers.ActionDecisionManager;
+import org.project.managers.ManaCostManager;
+import org.project.managers.SpecialAbilityManager;
+import org.project.managers.StatusEffectManager;
+
+public class TotalAttackCalculator {
+
+    private final StatusEffectManager statusEffectManager;
+    private final SpecialAbilityManager specialAbilityManager;
+    private final ManaCostManager manaCostManager;
+
+    private static final int HEAL_AMOUNT = 25;
+    private static final int SHIELD_BASH_BASE_DAMAGE = 15;
+    private static final int SHIELD_BASH_STUN_CHANCE = 30;
+
+    public TotalAttackCalculator(
+            StatusEffectManager statusEffectManager,
+            SpecialAbilityManager specialAbilityManager,
+            ManaCostManager manaCostManager
+    ) {
+        this.statusEffectManager = statusEffectManager;
+        this.specialAbilityManager = specialAbilityManager;
+        this.manaCostManager = manaCostManager;
+    }
+
+    public AttackResult calculate(
+            Entity attacker,
+            Entity defender,
+            ActionDecisionManager.actionsType action
+    ) {
+
+        switch (action) {
+
+            case lightAttack:
+                return lightAttack(attacker, defender);
+
+            case heavyAttack:
+                return heavyAttack(attacker, defender);
+
+            case defend:
+                return defend(attacker);
+
+            case heal:
+                return heal(attacker);
+
+            case ability:
+                return ability(attacker, defender);
+
+            case shiedbash:
+                return shieldBash(attacker, defender);
+        }
+
+        return new AttackResult(0,0,false);
+    }
+
+    // --------------------------------
+    // LIGHT ATTACK
+    // --------------------------------
+    private AttackResult lightAttack(Entity attacker, Entity defender) {
+
+        int damage = attacker.getBaseDamage();
+
+        Weapon weapon = attacker.getWeapon();
+
+        if (weapon != null) {
+            damage += weapon.getLightAttackDamage();
+
+            if (weapon.getEffect() != null)
+                statusEffectManager.addEffect(weapon.getEffect(), defender);
+        }
+
+        damage = applyArmor(defender, damage);
+
+        if (defender.isDefending())
+            damage /= 2;
+
+        return new AttackResult(damage,0,false);
+    }
+
+    // --------------------------------
+    // HEAVY ATTACK
+    // --------------------------------
+    private AttackResult heavyAttack(Entity attacker, Entity defender) {
+
+        if (!manaCostManager.useHeavyAttack( attacker))
+            return new AttackResult(0,0,false);
+
+        int damage = attacker.getBaseDamage() * 2;
+
+        Weapon weapon = attacker.getWeapon();
+
+        if (weapon != null) {
+
+            damage += weapon.getHeavyAttackDamage();
+
+            if (weapon.getEffect() != null)
+                statusEffectManager.addEffect(weapon.getEffect(), defender);
+        }
+
+        damage = applyArmor(defender, damage);
+
+        if (defender.isDefending())
+            damage /= 2;
+
+        return new AttackResult(damage,0,false);
+    }
+
+    // --------------------------------
+    // DEFEND
+    // --------------------------------
+    private AttackResult defend(Entity attacker) {
+
+        if (!manaCostManager.useHeavyAttack( attacker))
+            return new AttackResult(0,0,false);
+
+        return new AttackResult(0,0,true);
+    }
+
+    // --------------------------------
+    // HEAL
+    // --------------------------------
+    private AttackResult heal(Entity attacker) {
+
+        if (!manaCostManager.useHeavyAttack( attacker))
+            return new AttackResult(0,0,false);
+
+        return new AttackResult(0,HEAL_AMOUNT,false);
+    }
+
+    // --------------------------------
+    // SPECIAL ABILITY
+    // --------------------------------
+    private AttackResult ability(Entity attacker, Entity defender) {
+
+        SpecialAbility ability = attacker.getSpacialAbility();
+
+        if (ability == null)
+            return new AttackResult(0,0,false);
+
+        if (attacker instanceof Player && !manaCostManager.useSpecialAbility((Player) attacker))
+            return new AttackResult(0,0,false);
+
+        Entity target =
+                ability.getTarget() == SpecialAbility.AbilityTarget.SELF
+                        ? attacker
+                        : defender;
+
+        specialAbilityManager.addAbility(ability, target);
+
+        return new AttackResult(0,0,false);
+    }
+
+    // --------------------------------
+    // SHIELD BASH
+    // --------------------------------
+    private AttackResult shieldBash(Entity attacker, Entity defender) {
+
+        if (!manaCostManager.useHeavyAttack( attacker))
+            return new AttackResult(0,0,false);
+
+        Armor armor = attacker.getArmor();
+
+        if (armor == null)
+            return new AttackResult(0,0,false);
+
+        if (armor.getType() != Armor.ArmorType.HEAVY)
+            return new AttackResult(0,0,false);
+
+        int damage = SHIELD_BASH_BASE_DAMAGE + armor.getDefense() / 2;
+
+        damage = applyArmor(defender, damage);
+
+        if (Math.random() * 100 < SHIELD_BASH_STUN_CHANCE)
+            defender.stun();
+
+        return new AttackResult(damage,0,false);
+    }
+
+    // --------------------------------
+    // ARMOR REDUCTION
+    // --------------------------------
+    private int applyArmor(Entity defender, int rawDamage) {
+
+        Armor armor = defender.getArmor();
+
+        if (armor == null)
+            return rawDamage;
+
+        return armor.reduceDamage(rawDamage);
+    }
+}

Java-Knight/src/main/java/org/project/item/consumables/Flask.java

@@ -1,16 +0,0 @@
-package org.project.item.consumables;
-
-import org.project.entity.Entity;
-
-// TODO: UPDATE IMPLEMENTATION
-public class Flask {
-    /*
-    THIS IS AN EXAMPLE OF A CONSUMABLE DESIGN.
-    */
-
-    // TODO: UPDATE USE METHOD
-    @Override
-    public void use(Entity target) {
-        target.heal(target.getMaxHP() / 10);
-    }
-}

Java-Knight/src/main/java/org/project/item/consumables/HealFlask.java

@@ -0,0 +1,24 @@
+package org.project.item.consumables;
+
+import org.project.entity.Entity;
+import org.project.entity.players.Player;
+import org.project.item.Item;
+
+public class HealFlask extends Consumable {
+
+    private int healAmount;
+
+    public HealFlask(String name, int healAmount, int charges) {
+        super(name, healAmount, charges);
+    }
+
+
+
+    public void use(Player target) {
+
+        super.use(target);
+        System.out.println(target.getName() + " healed for " + healAmount);
+    }
+
+
+}

Java-Knight/src/main/java/org/project/item/consumables/ManaFlask.java

@@ -0,0 +1,23 @@
+package org.project.item.consumables;
+
+import org.project.entity.Entity;
+import org.project.entity.players.Player;
+import org.project.item.Item;
+
+public class ManaFlask extends Consumable {
+
+    private int manaAmount;
+
+    public ManaFlask(String name, int manaAmount, int charges) {
+
+        super(name, manaAmount, charges);
+    }
+
+
+    public void use(Player target) {
+        super.use(target);
+
+        System.out.println(target.getName() + " got " + manaAmount + " mana");
+    }
+
+}

Java-Knight/src/main/java/org/project/item/weapons/Dagger.java

@@ -0,0 +1,26 @@
+package org.project.item.weapons;
+
+import org.project.weaponEffects.StatusEffect;
+
+public class Dagger extends Weapon {
+
+    private static final String NAME = "Sword";
+    private static final int LIGHT_DAMAGE = 10;
+    private static final int HEAVY_DAMAGE = 5;
+    private static final int DURABILITY = 4;
+
+    public Dagger() {
+        this(null);
+    }
+
+    public Dagger(StatusEffect weaponEffect) {
+
+        super(
+                NAME,
+                LIGHT_DAMAGE,
+                HEAVY_DAMAGE,
+                weaponEffect,
+                DURABILITY
+        );
+    }
+}

Java-Knight/src/main/java/org/project/item/weapons/Sword.java

@@ -1,26 +1,26 @@
 package org.project.item.weapons;
 
-import org.project.entity.Entity;
+import org.project.weaponEffects.StatusEffect;
 
-import java.util.ArrayList;
+public class Sword extends Weapon {
 
-// TODO: UPDATE IMPLEMENTATION
+    private static final String NAME = "Sword";
-public class Sword {
+    private static final int LIGHT_DAMAGE = 10;
-    /*
+    private static final int HEAVY_DAMAGE = 5;
-    THIS IS AN EXAMPLE OF A WEAPON DESIGN.
+    private static final int DURABILITY = 4;
-    */
-
-    int abilityCharge;
 
     public Sword() {
-        // TODO: DESIGN SWORD'S ATTRIBUTES IMPLEMENT THE CONSTRUCTOR
+        this(null);
     }
 
-    // TODO: (BONUS) UPDATE THE UNIQUE ABILITY
+    public Sword(StatusEffect weaponEffect) {
-    public void uniqueAbility(ArrayList<Entity> targets) {
+
-        abilityCharge += 2;
+        super(
-        for (Entity target : targets) {
+                NAME,
-            target.takeDamage(getDamage());
+                LIGHT_DAMAGE,
-        }
+                HEAVY_DAMAGE,
+                weaponEffect,
+                DURABILITY
+        );
     }
 }

Java-Knight/src/main/java/org/project/item/weapons/Weapon.java

@@ -1,35 +1,48 @@
 package org.project.item.weapons;
 
-import org.project.entity.Entity;
+import org.project.weaponEffects.StatusEffect;
+
+import org.project.item.Item;
+
 
 // TODO: UPDATE IMPLEMENTATION
-public abstract class Weapon {
+public abstract class Weapon implements Item {
-    private int damage;
-    private int manaCost;
 
-    /*
+    private String name;
-    TODO: ADD OTHER REQUIRED AND BONUS ATTRIBUTES
+    private StatusEffect effect;
-    */
+    private int lightAttackDamage;
+    private int heavyAttackDamage;
+    private int equipManaCost;
 
-    public Weapon(int damage, int manaCost) {
+
-        this.damage = damage;
+    public Weapon(String name,int heavyAttackDamage,int lightAttackDamage, StatusEffect statusEffect, int equipManaCost) {
-        this.manaCost = manaCost;
+        this.name = name;
+        this.lightAttackDamage = lightAttackDamage;
+        this.heavyAttackDamage = heavyAttackDamage;
+        this.effect = statusEffect;
+        this.equipManaCost = equipManaCost;
     }
 
+    public int getHeavyAttackDamage() {
+        return heavyAttackDamage;
+    }
+
+    public int getLightAttackDamage() {
+        return lightAttackDamage;
+    }
+
+    public StatusEffect getEffect() {
+        return effect;
+    }
+
+    public void setEffect(StatusEffect effect) {
+        this.effect = effect;
+    }
+
+
     @Override
-    public void use(Entity target) {
+    public String getName() {
-        target.takeDamage(damage);
+        return name;
     }
 
-    public int getDamage() {
-        return damage;
-    }
-
-    public int getManaCost() {
-        return manaCost;
-    }
-
-    /*
-    TODO: ADD OTHER REQUIRED AND BONUS METHODS
-    */
 }

Java-Knight/src/main/java/org/project/location/Location.java

@@ -3,26 +3,75 @@ package org.project.location;
 import org.project.entity.enemies.Enemy;
 
 import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
 
 public class Location {
-    private String name;
 
-    private ArrayList<Enemy> enemies;
+    private final String name;
 
-    public Location(ArrayList<Location> locations, ArrayList<Enemy> enemies) {
+    private final List<Location> connectedLocations;
-        this.locations = locations;
+    private final List<Enemy> enemies;
-        this.enemies = enemies;
+
+    public Location(String name) {
+        this.name = name;
+        this.connectedLocations = new ArrayList<>();
+        this.enemies = new ArrayList<>();
+    }
+
+    public Location(String name, List<Location> connectedLocations, List<Enemy> enemies) {
+        this.name = name;
+
+        this.connectedLocations =
+                connectedLocations != null ? new ArrayList<>(connectedLocations) : new ArrayList<>();
+
+        this.enemies =
+                enemies != null ? new ArrayList<>(enemies) : new ArrayList<>();
     }
 
     public String getName() {
         return name;
     }
 
-    public ArrayList<Location> getLocations() {
+    public List<Location> getConnectedLocations() {
-        return locations;
+        return Collections.unmodifiableList(connectedLocations);
     }
 
-    public ArrayList<Enemy> getEnemies() {
+    public List<Enemy> getEnemies() {
-        return enemies;
+        return Collections.unmodifiableList(enemies);
+    }
+
+    // ------------------------------------
+    // ADD / REMOVE LOCATIONS
+    // ------------------------------------location
+
+    public void connect(Location other) {
+        if (other == null || other == this) return;
+
+        if (!connectedLocations.contains(other)) {
+            connectedLocations.add(other);
+        }
+
+        if (!other.connectedLocations.contains(this)) {
+            other.connectedLocations.add(this);
+        }
+    }
+
+
+    public void removeLocation(Location location) {
+        connectedLocations.remove(location);
+    }
+
+    // ------------------------------------
+    // ADD / REMOVE ENEMIES
+    // ------------------------------------
+    public void addEnemy(Enemy enemy) {
+        if (enemy != null) {
+            enemies.add(enemy);
+        }
+    }
+
+    public void removeEnemy(Enemy enemy) {
+        enemies.remove(enemy);
     }
 }

Java-Knight/src/main/java/org/project/managers/ActionDecisionManager.java

@@ -0,0 +1,74 @@
+package org.project.managers;
+
+
+
+import java.util.Random;
+import java.util.Scanner;
+
+
+public class ActionDecisionManager {
+
+    public enum actionsType {
+        lightAttack,
+        heavyAttack,
+        defend,
+        heal,
+        ability,
+        shiedbash,
+        inventory
+    }
+
+
+    private Random random = new Random();
+
+
+    public actionsType userChooseAction() {
+        actionsType res = null;
+        while (true) {
+            System.out.println("Choose attack type:\n");
+            System.out.println("1.lightAttack");
+            System.out.println("2.heavyAttack");
+            System.out.println("3.heal");
+            System.out.println("4.defend");
+            System.out.println("5.ability");
+            System.out.println("6.shielBash");
+            System.out.println("7.inventory");
+
+            int choice = new Scanner(System.in).nextInt();
+            switch (choice) {
+                case 1:
+                    return actionsType.lightAttack;
+                case 2:
+                    return actionsType.heavyAttack;
+                case 3:
+                    return actionsType.heal;
+                case 4:
+                    return actionsType.defend;
+                case 5:
+                    return actionsType.ability;
+                case 6:
+                    return actionsType.shiedbash;
+                case 7:
+                    return actionsType.inventory;
+                default:
+                    return actionsType.lightAttack;
+            }
+
+        }
+
+    }
+
+    public actionsType botChooseAction() {
+
+        actionsType[] possibleActions = {
+                actionsType.lightAttack,
+                actionsType.heavyAttack,
+                actionsType.defend,
+                actionsType.heal
+        };
+
+        return possibleActions[random.nextInt(possibleActions.length)];
+    }
+
+
+}

Java-Knight/src/main/java/org/project/managers/InventoryManager.java

@@ -0,0 +1,234 @@
+package org.project.managers;
+
+import org.project.Colors;
+import org.project.entity.players.Player;
+import org.project.item.consumables.HealFlask;
+import org.project.item.consumables.ManaFlask;
+import org.project.item.weapons.Dagger;
+import org.project.item.weapons.Sword;
+import org.project.weaponEffects.BurnEffect;
+import org.project.weaponEffects.FreezeEffect;
+import org.project.weaponEffects.PoisonEffect;
+
+import java.awt.*;
+import java.util.Scanner;
+
+public class InventoryManager {
+
+    private final HealFlask healFlask = new HealFlask("Heal Flask", 30, 3);
+    private final ManaFlask manaFlask = new ManaFlask("Mana Flask", 20, 2);
+
+
+    private final Scanner scanner = new Scanner(System.in);
+    private final ManaCostManager manager = new ManaCostManager();
+
+    public void displayInventory(Player player) {
+
+        while (true) {
+
+            System.out.println("\n========" + Colors.YELLOW + " INVENTORY " + Colors.RESET + "========");
+            System.out.println("""
+                        1. Equip Armor
+                        2. Equip / Change Weapon
+                        3. Equip / Change Weapon Effect
+                        4. Use Flask
+                        0. Exit
+                        """);
+
+
+            int input = scanner.nextInt();
+
+            if (input < 0 || input > 4) {
+                System.out.println("Enter a number between [0 - 3]");
+                continue;
+            }
+
+            switch (input) {
+
+                // =========================
+                // Exit
+                // =========================
+
+                case 0:
+                    System.out.println("Closing inventory...");
+                    return;
+
+                // =========================
+                // Armor
+                // =========================
+
+                case 1:
+
+                    if (player.getArmor() != null) {
+
+                        System.out.println(
+                                player.getName() +
+                                        Color.GREEN+
+                                        " already has armor: " +
+                                        Colors.RESET +
+                                        player.getArmor().getName()
+                        );
+
+                    } else {
+
+                        manager.equipArmor(player, player.getPersonalArmor());
+
+                    }
+
+                    break;
+
+                // =========================
+                // Weapon
+                // =========================
+
+                case 2:
+
+                    System.out.println("\n---" + Colors.YELLOW + " Weapons " + Colors.RESET + "---");
+                    System.out.println("""
+                            1. Sword
+                            2. Dagger
+                            0. Back
+                            """);
+
+                    int choice = scanner.nextInt();
+
+                    if (choice < 0 || choice > 2) {
+                        System.out.println("Enter a number between [0 - 2]");
+                        continue;
+                    }
+
+                    switch (choice) {
+
+                        case 0:
+                            System.out.println("Coming back...");
+                            break;
+
+                        case 1:
+                            manager.equipWeapon(
+                                    player,
+                                    new Sword(null)
+                            );
+                            break;
+
+                        case 2:
+                            manager.equipWeapon(player, new Dagger(null));
+                            break;
+                    }
+
+                    break;
+
+                // =========================
+                // Weapon Effects
+                // =========================
+
+                case 3:
+
+                    if (player.getWeapon() == null) {
+                        System.out.println(Colors.RED + "Equip a weapon first!" + Colors.RESET);
+                        break;
+                    }
+
+                    System.out.println("\n---" + Colors.YELLOW + " Weapon Effects " + Colors.RESET + "---");
+                    System.out.println("""
+                            1. Poison Effect
+                            2. Freeze Effect
+                            3. Burn Effect
+                            0. Back
+                            """);
+
+                    int choice2 = scanner.nextInt();
+
+                    if (choice2 < 0 || choice2 > 3) {
+                        System.out.println("Enter a number between [0 - 4]");
+                        continue;
+                    }
+
+                    switch (choice2) {
+
+                        case 0:
+                            System.out.println("Coming back...");
+                            break;
+
+                        case 1:
+
+                            manager.equipStatusEffect(player, new PoisonEffect());
+
+                            break;
+
+                        case 2:
+
+                            manager.equipStatusEffect(player, new FreezeEffect());
+
+                            break;
+
+                        case 3:
+
+                            manager.equipStatusEffect(player, new BurnEffect());
+
+                            break;
+                    }
+
+                    break;
+                case 4:
+
+                    System.out.println("\n---" + Colors.YELLOW + " Flasks " + Colors.RESET + "---");
+
+                    System.out.println("1. Heal Flask (" + healFlask.getCharges() + ")");
+                    System.out.println("2. Mana Flask (" + manaFlask.getCharges() + ")");
+                    System.out.println("0. Back");
+
+                    int flaskChoice = scanner.nextInt();
+
+                    if (flaskChoice < 0 || flaskChoice > 2) {
+                        System.out.println("Enter a number between [0 - 2]");
+                        continue;
+                    }
+
+                    switch (flaskChoice) {
+
+                        case 0:
+                            System.out.println("Coming back...");
+                            break;
+
+                        case 1:
+
+                            if (healFlask.getCharges() <= 0) {
+                                System.out.println(Colors.RED + "No Heal Flask charges left!" + Colors.RESET);
+                                break;
+                            }
+
+                            healFlask.use(player);
+
+                            System.out.println(
+                                    Colors.GREEN +
+                                            "Heal Flask used! Charges left: " +
+                                            healFlask.getCharges() +
+                                            Colors.RESET
+                            );
+
+                            break;
+
+                        case 2:
+
+                            if (manaFlask.getCharges() <= 0) {
+                                System.out.println(Colors.RED + "No Mana Flask charges left!" + Colors.RESET);
+                                break;
+                            }
+
+                            manaFlask.use(player);
+
+                            System.out.println(
+                                    Colors.CYAN +
+                                            "Mana Flask used! Charges left: " +
+                                            manaFlask.getCharges() +
+                                            Colors.RESET
+                            );
+
+                            break;
+                    }
+
+                break;
+            }
+        }
+    }
+}

Java-Knight/src/main/java/org/project/managers/ManaCostManager.java

@@ -0,0 +1,248 @@
+package org.project.managers;
+
+import org.project.Colors;
+import org.project.abilities.SpecialAbility;
+import org.project.entity.Entity;
+import org.project.entity.players.Player;
+import org.project.item.armors.Armor;
+import org.project.item.weapons.Weapon;
+import org.project.weaponEffects.StatusEffect;
+
+public class ManaCostManager {
+
+    private final int heavyAttackManaCost = 8;
+    private final int defendManaCost = 9;
+    private final int healManaCost = 12;
+    private final int shieldBashManaCost = 15;
+
+    // =========================
+    // Weapon
+    // =========================
+
+    public void equipWeapon(Player player, Weapon weapon) {
+
+        int manaCost = getWeaponEquipCost(weapon);
+
+        if (player.getMp() < manaCost) {
+
+            System.out.println("Not enough mana to equip weapon!");
+            return;
+        }
+
+        player.useMana(manaCost);
+
+        player.setWeapon(weapon);
+
+        System.out.println(
+                player.getName() +
+                        " equipped weapon: " +
+                        weapon.getName()
+        );
+
+    }
+
+    // =========================
+    // Armor
+    // =========================
+
+    public void equipArmor(Player player, Armor armor) {
+
+        int manaCost = getArmorEquipCost(armor);
+
+        if (player.getMp() < manaCost) {
+
+            System.out.println(Colors.RED +  "Not enough mana to equip armor!" + Colors.RESET);
+            return;
+        }
+
+        player.useMana(manaCost);
+
+        player.setArmor(armor);
+
+        System.out.println(
+                player.getName() +
+                        Colors.GREEN +
+                        " equipped armor: " +
+                        Colors.RESET +
+                        armor.getName()
+        );
+
+    }
+
+    // =========================
+    // Status Effect
+    // =========================
+
+    public void equipStatusEffect(Player player,
+                                  StatusEffect equippedEffect) {
+
+        Weapon weapon = player.getWeapon();
+
+        if (weapon == null) {
+
+            System.out.println(Colors.RED + "Equip a weapon first!" + Colors.RESET);
+            return;
+        }
+
+        int manaCost = equippedEffect.getEquipManaCost();
+
+        if (player.getMp() < manaCost) {
+
+            System.out.println(Colors.RED + "Not enough mana to equip this effect!" + Colors.RESET);
+            return;
+        }
+
+        player.useMana(manaCost);
+
+        weapon.setEffect(equippedEffect);
+
+        System.out.println(
+                player.getName() +
+                        Colors.GREEN +
+                        " equipped effect: " +
+                        Colors.RESET +
+                        equippedEffect.getName()
+        );
+
+    }
+
+    // =========================
+    // Special Ability
+    // =========================
+
+    public boolean useSpecialAbility(Entity entity) {
+
+        SpecialAbility ability = entity.getSpacialAbility();
+
+        if (ability == null) {
+
+            System.out.println(Colors.RED + "No special ability equipped!" +  Colors.RESET);
+            return false;
+        }
+
+        int manaCost = ability.getManaCost();
+
+        if (entity.getMp() < manaCost) {
+
+            System.out.println(Colors.RED + "Not enough mana to use special ability!" + Colors.RESET);
+            return false;
+        }
+
+        entity.useMana(manaCost);
+
+        return true;
+    }
+
+    // =========================
+    // Heavy Attack
+    // =========================
+
+    public boolean useHeavyAttack(Entity entity) {
+
+        if (entity.getMp() < heavyAttackManaCost) {
+
+            System.out.println(Colors.RED + "Not enough mana!" + Colors.RESET);
+            return false;
+        }
+
+        entity.useMana(heavyAttackManaCost);
+
+        return true;
+    }
+
+    // =========================
+    // Defend
+    // =========================
+
+    public boolean useDefend(Entity entity) {
+
+        if (entity.getMp() < defendManaCost) {
+
+            System.out.println(Colors.RED + "Not enough mana!" + Colors.RESET);
+            return false;
+        }
+
+        entity.useMana(defendManaCost);
+
+        return true;
+    }
+
+    // =========================
+    // Heal
+    // =========================
+
+    public boolean useHeal(Entity entity) {
+
+        if (entity.getMp() < healManaCost) {
+
+            System.out.println(Colors.RED + "Not enough mana!" + Colors.RESET);
+            return false;
+        }
+
+        entity.useMana(healManaCost);
+
+        return true;
+    }
+
+    // =========================
+    // Shield Bash
+    // =========================
+
+    public boolean useShieldBash(Player player) {
+
+        Armor armor = player.getArmor();
+
+        if (armor == null) {
+
+            System.out.println(Colors.RED + "You need armor to use Shield Bash!" + Colors.RESET);
+            return false;
+        }
+
+        if (armor.getType() != Armor.ArmorType.HEAVY) {
+
+            System.out.println(Colors.RED + "Shield Bash requires HEAVY armor!" + Colors.RESET);
+            return false;
+        }
+
+        if (player.getMp() < shieldBashManaCost) {
+
+            System.out.println(Colors.RED + "Not enough mana!" + Colors.RESET);
+            return false;
+        }
+
+        player.useMana(shieldBashManaCost);
+
+        return true;
+    }
+
+    // =========================
+    // Mana Costs
+    // =========================
+
+    private int getArmorEquipCost(Armor armor) {
+
+        return switch (armor.getType()) {
+
+            case LIGHT -> 3;
+
+            case MEDIUM -> 6;
+
+            case HEAVY -> 10;
+        };
+    }
+
+    private int getWeaponEquipCost(Weapon weapon) {
+
+        int damage = weapon.getLightAttackDamage();
+
+        if (damage <= 10) {
+            return 3;
+        }
+
+        if (damage <= 20) {
+            return 6;
+        }
+
+        return 10;
+    }
+}

Java-Knight/src/main/java/org/project/managers/SpecialAbilityManager.java

@@ -0,0 +1,77 @@
+package org.project.managers;
+
+import org.project.abilities.*;
+import org.project.entity.Entity;
+import org.project.item.armors.GoblinArmor;
+
+import javax.swing.text.Position;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+public class SpecialAbilityManager {
+
+    private final Map<Entity, List<SpecialAbility>> activeAbilities =
+            new HashMap<>();
+
+    // =========================
+    // Add Ability
+    // =========================
+
+    public void addAbility(SpecialAbility ability, Entity target) {
+
+        if (ability == null || target == null) {
+            return;
+        }
+
+        activeAbilities.putIfAbsent(target, new ArrayList<>());
+
+        ability.onApply(target);
+
+        activeAbilities.get(target).add(ability);
+    }
+
+    // =========================
+    // Update Ability Effects
+    // =========================
+
+    public void tick(Entity abilityUser, Entity target) {
+
+        List<SpecialAbility> abilities = activeAbilities.get(abilityUser);
+
+        if (abilities == null || abilities.isEmpty()) {
+            return;
+        }
+
+        Iterator<SpecialAbility> iterator = abilities.iterator();
+
+        while (iterator.hasNext()) {
+
+            SpecialAbility ability = iterator.next();
+
+            if (ability instanceof GuardianOath || ability instanceof PoisonDagger || ability instanceof LifeSteal)
+                ability.onTick(abilityUser);
+
+            if (ability instanceof InfernoBreath || ability instanceof BoneStrike || ability instanceof ArcaneStorm)
+                ability.onTick(target);
+
+
+            ability.reduceDuration();
+
+            if (ability.getDuration() <= 0) {
+
+                ability.onExpire(abilityUser);
+
+                iterator.remove();
+            }
+        }
+
+        // Cleanup empty list
+        if (abilities.isEmpty()) {
+            activeAbilities.remove(target);
+        }
+    }
+
+}

Java-Knight/src/main/java/org/project/managers/StatusEffectManager.java

@@ -0,0 +1,81 @@
+package org.project.managers;
+
+import org.project.entity.Entity;
+import org.project.weaponEffects.StatusEffect;
+
+import java.util.*;
+
+public class StatusEffectManager {
+
+    private Map<Entity, List<StatusEffect>> activeEffects = new HashMap<>();
+
+    public void addEffect(StatusEffect newEffect, Entity target) {
+        if (newEffect == null) return;
+
+        activeEffects.putIfAbsent(target, new ArrayList<>());
+        List<StatusEffect> effects = activeEffects.get(target);
+
+        for (StatusEffect existing : effects) {
+
+            if (existing.getName().equals(newEffect.getName())) {
+
+
+                if (existing.getStackType() == null) {
+                    return;
+                } else if (existing.getStackType() == StatusEffect.StackType.duration) {
+
+                    existing.setDuration(existing.getDuration() + newEffect.getDuration());
+
+                } else if (existing.getStackType() == StatusEffect.StackType.damage) {
+
+                    existing.setDamage(existing.getDamage()+ newEffect.getDamage());
+
+                } else if (existing.getStackType() == StatusEffect.StackType.both) {
+
+                    existing.setDamage(existing.getDamage()+ newEffect.getDamage());
+                    existing.setDuration(existing.getDuration() + newEffect.getDuration());
+                }
+
+                return;
+            }
+        }
+
+        effects.add(newEffect);
+        newEffect.onApply(target);
+    }
+
+
+    public void tick(Entity target) {
+
+        List<StatusEffect> effects = activeEffects.get(target);
+        if (effects == null) return;
+
+        Iterator<StatusEffect> iterator = effects.iterator();
+
+        while (iterator.hasNext()) {
+
+            StatusEffect effect = iterator.next();
+
+            effect.onTick(target);
+            effect.reduceDuration();
+
+            if (effect.getDuration() <= 0) {
+                effect.onExpire(target);
+                iterator.remove();
+            }
+        }
+    }
+
+    public boolean hasEffect(Entity target, String name) {
+
+        List<StatusEffect> effects = activeEffects.get(target);
+        if (effects == null) return false;
+
+        for (StatusEffect effect : effects) {
+            if (effect.getName().equals(name))
+                return true;
+        }
+
+        return false;
+    }
+}

Java-Knight/src/main/java/org/project/weaponEffects/BurnEffect.java

@@ -0,0 +1,16 @@
+package org.project.weaponEffects;
+
+import org.project.entity.Entity;
+
+public class BurnEffect extends StatusEffect{
+
+
+    public BurnEffect() {
+        super("Burn", 10,5 , 3, StackType.damage);
+    }
+
+    @Override
+    public void onApply(Entity target) {
+        System.out.println(target.getName() + " is burned!");
+    }
+}

Java-Knight/src/main/java/org/project/weaponEffects/FreezeEffect.java

@@ -0,0 +1,22 @@
+package org.project.weaponEffects;
+
+import org.project.entity.Entity;
+
+public class FreezeEffect extends StatusEffect{
+
+    public FreezeEffect() {
+        super("Freeze",1,5 , 1, StatusEffect.StackType.damage);
+    }
+
+
+    @Override
+    public void onTick(Entity target) {
+        target.freeze();
+        super.onTick(target);
+    }
+
+    @Override
+    public void onExpire(Entity target) {
+        System.out.println(target.getName() + " is Frozen!");
+    }
+}

Java-Knight/src/main/java/org/project/weaponEffects/PoisonEffect.java

@@ -0,0 +1,17 @@
+package org.project.weaponEffects;
+
+import org.project.entity.Entity;
+
+public class PoisonEffect extends StatusEffect{
+
+
+    public PoisonEffect() {
+        super("Poison",10,5 , 3, StackType.damage);
+    }
+
+    @Override
+    public void onApply(Entity target) {
+        System.out.println(target.getName() + " is poisoned!");
+    }
+
+}

Java-Knight/src/main/java/org/project/weaponEffects/StatusEffect.java

@@ -0,0 +1,65 @@
+package org.project.weaponEffects;
+
+import org.project.entity.Entity;
+
+public abstract class StatusEffect {
+
+    public enum StackType {
+
+        none, // this effect is not stackable
+        duration, // in duplication, just duration increases
+        damage,// in duplication, just damage increases
+        both // increases duration and damage
+    }
+
+    protected String name;
+    private int duration;
+    private int equipManaCost;
+    protected int damage;
+    protected StackType stackType;
+
+
+    public StatusEffect(String name, int damage, int equipManaCost, int duration, StackType stackType) {
+        this.name = name;
+        this.damage = damage;
+        this.equipManaCost = equipManaCost;
+        this.duration = duration;
+        this.stackType = stackType;
+    }
+
+    public String getName() { return name; }
+
+    public int getDamage() {
+        return damage;
+    }
+
+    public void setDamage(int damage) {
+        this.damage = damage;
+    }
+
+    public int getDuration() { return duration; }
+
+    public void setDuration(int duration) {
+        this.duration = duration;
+    }
+
+    public StackType getStackType() { return stackType; }
+
+    public int getEquipManaCost() {
+        return equipManaCost;
+    }
+
+    public void reduceDuration() {
+        duration--;
+    }
+
+    public void onApply(Entity target) {}
+
+    public  void onTick(Entity target) {
+        target.takeDamage(damage);
+        System.out.println(target.getName() + " suffers " + damage + " damage form " + name);
+        reduceDuration();
+    }
+
+    public void onExpire(Entity target) {System.out.println(target.getName() + " is no longer suffering form " + name);}
+}

README.md

@@ -1,175 +1,348 @@
-# Fourth Assignment - Java Knight ⚔️
+# 🛡️ Java‑Knight RPG
-A turn-based RPG with Roguelike elements which can be run in the terminal.
 
-### **Prologue: The Legend of Javanest**
+<p align="center">
-*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!*
+<img src="image.png" width="100%">
+</p>
 
-### **Introduction**
+<p align="center">
-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**.
+<img src="Logo.png" width="160">
+</p>
 
-⚠️ **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.
+A console‑based fantasy RPG written entirely in pure Java.
 
-🎯 **Your goal is not just to complete the assignment but to learn and apply OOP effectively!**
+Fight monsters, explore mythical locations, manage your inventory, unlock abilities and defeat the Dragon of Valhalla.
-
-### **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 📝
+# 📚 Table of Contents
 
-### 1️⃣ Step 1: Fork & Setup 🍴
+- Overview
-1. **Fork** this repository and clone it to your local machine.
+- Core Features
-```bash
+- Player Classes
-git clone https://git.meshcomp.ir/AdvancedProgramming1404/HW-04-JAVA-KNIGHT.git
+- Systems & Managers
-```
+- Items & Equipment
-2. Create a new branch named `develop` and switch to it.
+- Combat System
-```bash
+- Locations
-git checkout -b develop
+- Boss Fight
-```
+- Project Structure
-### 2️⃣ Step 2: Implement the Class Hierarchy 🌲
+- How to Run
-
+- Future Improvements
-A well-structured OOP hierarchy is crucial. Avoid duplicating code by placing shared logic in abstract classes.
+- Example Output
-
+- Author
-- **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
-
-![structure](Readme_Pictures/structure.png)
-
-### 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:
+# ⚔️ Overview
-1. Light Attack | 2. Heavy Attack (-8 Mana) | 3. Defend (-6 Mana) | 4. Heal (-12 Mana) | 5. Shield Bash (-15 Mana)
+
+Java‑Knight is a modular **turn‑based RPG engine** built with Java and object‑oriented design.
+
+The project focuses on:
+
+- Clean OOP architecture
+- Modular manager systems
+- Expandable combat mechanics
+- Class‑based gameplay
+- Status effect system
+- Inventory & equipment system
+
+The **GameLoop** controls the main gameplay cycle including player actions, combat resolution and movement between locations.
+
+---
+
+# 🧩 Core Features
+
+## 🎮 Gameplay Loop
+
+The **GameLoop** manages:
+
+- Player creation
+- Class selection
+- Location movement
+- Enemy spawning
+- Combat handling
+- Inventory usage
+
+Locations are interconnected and enemies spawn dynamically.
+
+---
+
+# 🧙 Player Classes
+
+Each class has its own stats, armor and special ability.
+
+| Class | Ability | Description |
+|------|------|------|
+| Knight | Guardian Oath | Heals and increases damage |
+| Wizard | Arcane Storm | Powerful magic attack |
+| Assassin | Poison Dagger | Poison damage and burst attack |
+
+---
+
+# 🛠 Systems & Managers
+
+The architecture separates game logic into managers.
+
+| Manager | Responsibility |
+|------|------|
+| ActionDecisionManager | Handles combat decisions |
+| InventoryManager | Equipment & item usage |
+| ManaCostManager | Mana cost calculations |
+| SpecialAbilityManager | Executes abilities |
+| StatusEffectManager | Applies burn, poison, freeze |
+| TotalAttackCalculator | Calculates final damage |
+
+This modular design keeps the **GameLoop clean and maintainable**.
+
+---
+
+# ⚗️ Items & Equipment
+
+## ⚔ Weapons
+
+- Sword
+- Dagger
+
+Weapons can receive special effects.
+
+---
+
+## 🌫 Weapon Effects
+
+| Effect | Description |
+|------|------|
+| BurnEffect | Damage over time |
+| FreezeEffect | Slows or freezes target |
+| PoisonEffect | Gradual HP drain |
+
+---
+
+## 🛡 Armor
+
+Each class uses its own armor type.
+
+Examples:
+
+- KnightArmor
+- WizardArmor
+- AssassinArmor
+
+Armor increases defense and survivability.
+
+---
+
+## 🧴 Consumables
+
+Consumables are located in:
+
+```
+org.project.item.consumables
 ```
 
-```bash
+Available items:
-→ Chose: Light Attack
+
-⚔️ Ser Duncan (Knight) used Light Attack! (0 Mana)
+- **HealFlask** → restores HP  
-Goblin took 10 damage!
+- **ManaFlask** → restores MP  
-Goblin has 20/30 HP remaining.
+
-Ser Duncan Mana: 40/40
+These can be used during gameplay from the **Inventory menu**.
+
+---
+
+# 🧠 Combat System
+
+Combat is **turn‑based**.
+
+Each round:
+
+1. Status effects update  
+2. Player action  
+3. Enemy AI action  
+
+Features:
+
+- Damage calculation system
+- Defense mechanics
+- Status effects
+- Ability cooldowns
+- Mana system
+- XP rewards
+- Key drop system
+
+---
+
+# 🗺 Locations
+
+| Location | Description |
+|------|------|
+| Valhalla | Starting realm |
+| Elysium | Sacred plains |
+| Niflheim | Frozen undead land |
+| Castle | Dragon battlefield |
+
+Moving between locations spawns enemies:
+
+- Goblin
+- Skeleton
+- Vampire
+
+---
+
+# 🐉 Boss Fight
+
+To unlock the final boss you must collect:
+
+- GoblinKey
+- SkeletonKey
+- VampireKey
+
+After collecting all keys you can trigger:
+
 ```
+Fight Dragon
 ```
-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).
 
+Defeat the **Dragon of Valhalla** to win the game.
 
-### 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.
+# 🎨 Console Colors
-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:
+ANSI colors are used for better terminal visuals.
 
 ```java
-while (player.isAlive() && enemy.isAlive())
+Colors.RED    = "\u001B[31m";
-    player.attack(enemy);
+Colors.GREEN  = "\u001B[32m";
-    if (enemy.isAlive()) {
+Colors.YELLOW = "\u001B[33m";
-        enemy.attack(player);
+Colors.CYAN   = "\u001B[36m";
-    }
+Colors.RESET  = "\u001B[0m";
-}
 ```
 
+Example:
 
-### 5️⃣ Step 5: Extra Features & Bonus Tasks ⭐
+```
-*(Optional for extra credit)*
+Guardian Oath: Sir Duncan heals +5 HP and gains 50% increased damage.
-
+```
-✅ **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).
 
 ---
 
-## Evaluation Criteria ⚖
+# 🧩 Project Structure
 
-| **Criteria**                                                | **Points** |
+```
-|-------------------------------------------------------------|------------|
+org.project
-| Proper use of OOP principles                                | **50**     |
+ ┣ abilities
-| Working combat mechanics, Leveling System & Enemy abilities | **20**     |
+ ┃ ┣ ArcaneStorm.java
-| Clear and Comprehensive `README.md`                         | **20**     |
+ ┃ ┣ BoneStrike.java
-| Code readability, documentation, and comments               | **10**     |
+ ┃ ┣ GuardianOath.java
-| Meaningful, interactive, & colored console outputs          | **10**     |
+ ┃ ┣ InfernoBreath.java
-| Inventory (item) and Merchant System (bonus)                | **20**     |
+ ┃ ┣ LifeSteal.java
-| Other Extra features (bonus tasks)                          | **20**     |
+ ┃ ┣ PoisonDagger.java
-| **Total Score**                                             | **150**    |
+ ┃ ┗ SpecialAbility.java
+ ┣ combat
+ ┃ ┣ AttackResult.java
+ ┃ ┗ TotalAttackCalculator.java
+ ┣ entity
+ ┃ ┣ players
+ ┃ ┗ enemies
+ ┣ item
+ ┃ ┣ armors
+ ┃ ┣ weapons
+ ┃ ┗ consumables
+ ┣ managers
+ ┃ ┣ InventoryManager.java
+ ┃ ┣ ActionDecisionManager.java
+ ┃ ┣ ManaCostManager.java
+ ┃ ┣ SpecialAbilityManager.java
+ ┃ ┗ StatusEffectManager.java
+ ┣ weaponEffects
+ ┃ ┣ BurnEffect.java
+ ┃ ┣ FreezeEffect.java
+ ┃ ┗ PoisonEffect.java
+ ┣ location
+ ┃ ┗ Location.java
+ ┣ Colors.java
+ ┣ GameLoop.java
+ ┗ Main.java
+```
 
-## 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 ⌛
+# 🚀 How to Run
-- **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.
 
-![cover](Readme_Pictures/image.png)
+Compile the project:
-###### - Born of God and Void. You shall seal the blinding light that plagues their dreams. You are the Vessel. You are the Java Knight.
+
+```
+javac -d out src/main/java/org/project/Main.java
+```
+
+Run the game:
+
+```
+java -cp out org.project.Main
+```
+
+---
+
+# 💬 Example Console Output
+
+```
+====== JAVA KNIGHT ======
+Choose class:
+1. Knight   (HP:150 MP:80 DMG:12)
+2. Wizard   (HP:80 MP:200 DMG:10)
+3. Assassin (HP:90 MP:120 DMG:15)
+
+1
+==== GAME MENU ====
+Location: Valhalla
+Enemy: vampire{MAX_HP : 90 | MAX_MP : 80 | XP_REWARD : 80 | BASE_DAMAGE : 12 | personalArmor = vampire armor | Type: MEDIUM | Defense: 16 | Durability: 30/30}
+
+1. Fight
+2. Inventory
+3. Move
+0. Exit
+
+1
+⚔ COMBAT STARTED! ⚔
+==== YOUR TURN ====
+Sir Duncan-> HP: 150 | MP: 80 | level: 1 | XP: 0
+Vampire-> HP: 90 | MP: 80
+
+
+Choose attack type:
+
+1.lightAttack
+2.heavyAttack
+3.heal
+4.defend
+5.ability
+6.shielBash
+7.inventory
+2
+Vampire got 34 damage
+
+
+==== ENEMY TURN ====
+
+enemy random choose action: lightAttack
+Sir Duncan got 17 damage
+```
+
+---
+
+# 🧠 Future Improvements
+
+- Multiple enemies per location
+- Save / Load system
+- More consumables
+- More classes
+- Advanced enemy AI
+- Graphical version (JavaFX / LWJGL)
+
+---
+
+# 🧑‍💻 Author
+
+Created by **Mohammadreza Ashrafian**
+
+2026
+
+⚔️ *May your code be strong and your armor unbreakable.*