Skip to content

Latest commit

 

History

History
202 lines (115 loc) · 5.5 KB

README.md

File metadata and controls

202 lines (115 loc) · 5.5 KB
Raw

DungeonDash

DungeonDash is a command-line RPG game where players embark on an epic adventure through various dungeons, battling enemies, collecting items, and leveling up to become the ultimate hero. Each dungeon presents unique challenges, enemies, and rewards. Will you be able to defeat the mini-bosses, gather the legendary artifact, and complete your quest?

Table of Contents

Installation

1. Clone the repository:

git clone https://github.com/Faizan711/dungeon-dash.git

2. Navigate to the project directory:

cd dungeon-dash

3. Install the necessary dependencies:

npm install

4. Run the game:

node .

or you can link to the game using the command:

npm link

and then run the game using the command:

dungeon-dash

How to Play

1. Start the Game:

  • Run the game using the command above.

  • You'll be welcomed and prompted to enter your character's name.

2. Explore the World:

  • After creating your character, you can choose a location (dungeon) to explore.

3. Combat:

  • As you explore dungeons, you'll encounter enemies. Engage in turn-based combat by choosing actions such as "Attack," "Defend," "Use Magic," "Use Item," or "Run Away."

4. Collect Loot:

  • Defeat enemies and mini-bosses to collect items, weapons, and armor. These items can be used during your adventure to increase your stats.

5. Level Up:

  • Gain experience points (XP) from combat and exploration. Level up to increase your stats and take on more challenging dungeons.

6. Complete the Quest:

  • Your goal is to retrieve the pieces of a legendary artifact scattered across the dungeons. Defeat the mini-bosses, collect the pieces, and complete your quest!

Game Mechanics

World Map

DungeonDash features a variety of dungeons, each with unique challenges, enemies, and rewards. Explore the world and conquer these dungeons:

  • Enchanted Forest:

    • Description: A mystical forest filled with magical creatures.
    • Enemies: Fairy, Troll
    • Mini-Boss: Forest Guardian
    • Difficulty: 1
    • Loot: Magic Bow (Attack +10)

  • Haunted Castle:

    • Description: A dark castle haunted by restless spirits.
    • Enemies: Ghost, Vampire
    • Mini-Boss: Phantom Knight
    • Difficulty: 2
    • Loot: Silver Sword (Attack +15)

  • Sunken Ruins:

    • Description: Ancient underwater ruins teeming with sea creatures.
    • Enemies: Mermaid, Giant Octopus
    • Mini-Boss: Kraken
    • Difficulty: 3
    • Loot: Trident of Poseidon (Attack +20, Deals double damage to sea creatures)

  • Dwarven Mines:

    • Description: Deep underground mines filled with rare minerals and gems.
    • Enemies: Goblin, Rockbiter
    • Mini-Boss: Mole King
    • Difficulty: 2
    • Loot: Adamantium Pickaxe (Attack +12, Doubles mining yield)

  • Volcanic Lair:

    • Description: A fiery lair nestled within an active volcano.
    • Enemies: Lava Elemental, Fire Drake
    • Mini-Boss: Magma Lord
    • Difficulty: 4
    • Loot: Inferno Greaves (Attack +18, Immune to fire damage)

Combat

Combat is turn-based, with the following actions available to the player:

  • Attack: Deal damage to the enemy using your equipped weapon.

  • Defend: Reduce the damage taken from the next enemy attack.

  • Use Magic: Cast a spell to deal damage or apply effects (only if you have enough magic points).

  • Use Item: Use an item from your inventory, such as a health potion.

  • Run Away: Attempt to escape the battle (success depends on luck).

Items and Inventory

  • Items: Players can collect items such as potions, weapons, and armor during their adventure. These items can be used in combat or to restore health.

  • Inventory: Manage your items in the inventory. Equip weapons and armor to enhance your stats.

Leveling Up

  • Gain XP from defeating enemies and completing dungeons. When your XP reaches a certain threshold, you'll level up.

  • Leveling up increases your stats, such as health, attack, and defense, making you stronger for future battles.

Main Quest

The main quest of DungeonDash is to retrieve the pieces of a legendary artifact that has been broken and scattered across the dungeons. Each dungeon is guarded by a mini-boss who holds a piece of the artifact. Collect all the pieces to complete the artifact and finish the quest.

Features

  • Multiple Dungeons: Explore a variety of dungeons with unique themes, enemies, and challenges.

  • Turn-Based Combat: Engage in strategic battles with a variety of combat options.

  • Items and Inventory System: Collect and manage items to aid you on your quest.

  • Leveling System: Gain experience, level up, and increase your stats.

  • Main Quest: Follow the storyline and complete the quest to retrieve the legendary artifact.

Credits

DungeonDash was developed by Md Faizan Alam using Node.JS and various npm libraries, including:

  • chalk for colorful terminal output
  • inquirer for interactive prompts
  • nanospinner for loading animations
  • gradient-string for colorful text
  • ora for additional spinner animations

Feel free to contribute to the project or suggest new features. Enjoy your adventure in DungeonDash!