Dungeon Crawl

Fight, Level Up, Upgrade, Complete Quests, and Discover New Worlds!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Main Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Example
4. Contributing
5. Contact
6. Acknowledgments

About The Project

Welcome to Dungeon Crawl game!

Embark on an epic dungeon-crawling adventure where danger lurks in every shadow! In Dungeon Crawl, you’ll explore various maps, battle evil monsters, and uncover hidden treasures. Upgrade your character with powerful weapons and armor, complete thrilling quests, and interact with NPCs like shopkeepers to gear up for the challenges ahead.

Face off against formidable bosses with special abilities, and level up to become the ultimate dungeon warrior! Do you have what it takes to survive the depths and claim victory?

Main Features:

🔹 Explore Diverse Dungeons: Each map is filled with secrets, enemies, and rewards.

⚔️ Battle Dangerous Monsters: Gain experience and level up by defeating a variety of powerful creatures.

🛡️ Upgrade Your Character: Equip different weapons and armor to upgrade your character.

🎒 Loot & Collect: Open chests, find items that boost your hero.

🛒 Interact with NPCs: Visit shopkeepers, take on quests, and uncover the world’s lore.

(back to top)

Built With

This game is built with Java and Maven, featuring immersive dungeon exploration, strategic battle mechanics, and a dynamic world powered by JavaFX. Ready to dive into the depths and conquer the dungeons?

• 
• 
• 

(back to top)

Getting Started

This is an example of how to set up the Dungeon Crawl Game locally.

Prerequisites

Before running the game, ensure you have the following:

• Java 17 or later: Required to run the game. You can download it from here.

• Apache Maven (if using the command line): If you're running the game from a terminal, install Maven from maven.apache.org.

• Using IntelliJ IDEA? No need to install Maven separately—it comes bundled with IntelliJ. Just open the pom.xml file as a project.

Installation

Follow these simple steps to get the project up and running on your machine.

For Command Line Users:

1. Clone the repo

   git clone https://github.com/CodecoolGlobal/dungeon-crawl-java-Akoss08.git

2. Navigate to the project folder

   cd dungeon-crawl-java-Akoss08

3. Compile the Project (this installs dependencies and compiles the code)

   mvn compile

4. Run the application to play the game!

   mvn javafx:run

For IntelliJ IDEA Users:

1. Clone the repo

   git clone https://github.com/CodecoolGlobal/dungeon-crawl-java-Akoss08.git

2. Open the pom.xml File in IntelliJ as a project

3. Run the Application

• Once the project is open, find the App class (src.main.java.com.codecool.dungeoncrawl). Right-click the class and select Run 'App.main()'.

(back to top)

Usage

Once you have the game running, you can explore different dungeons, battle monsters, collect loot, and level up your character! Here’s how you play:

1. Instructions:

• A — attack enemy
• O — open chest
• H — use healing potion (restore max health)
• P — use power potion (add +3 strength for the next 3 attack)
• I — talk to NPCs

2. Explore Dungeons: Move your character through the maps by using the keyboard. Explore dungeons and uncover treasures as you progress.

3. Fight Monsters: As you approach a monster, you’ll have the option to attack it. The outcome of the battle depends on your character's and the monster's stats (like health, attack, and defense).

4. Monster Abilities: Monsters you encounter may have special abilities such as poisoning you, attacking immediately, teleporting, or splitting into multiple enemies. Be strategic and make sure to manage your resources wisely to handle these surprises.

5. Loot and Upgrade: After defeating monsters, you may find loot such as gold, weapons, armor or healing potions. Use these items to improve your character’s stats and prepare for tougher battles ahead.

6. Level Up: As you defeat monsters and complete quests, you’ll gain experience points (XP). Leveling up increases your character’s stats, making them stronger and more capable of handling difficult enemies and dungeons.

7. Complete Quests: Along your journey, you’ll meet NPCs who might give you quests and sell you items. Take on quests to earn rewards and progress through the game!

8. Defeat Bosses: Within the game, you’ll encounter powerful bosses with unique abilities. These are some of the toughest challenges in the game, so use your upgraded equipment, stats, and careful strategy to take them down!

Example: Monsters movement

Here’s a simplified snippet of how the monsters are moving on the map:

public void move(int dx, int dy) {
   Cell nextCell = cell.getNeighbor(dx, dy);

   if (nextCell.isWalkable() && !isDead) {
      cell.setActor(null);
      nextCell.setActor(this);
      cell = nextCell;
   }
}

(back to top)

Contributing

This project is currently read-only and not open to external contributions. However, feel free to fork the repository for personal use or exploration.

Don't forget to give the project a star if you like it! 🌟

Top contributors:

(back to top)

Contact

Akos Horvath - LinkedIn - akos97@gmail.com

(back to top)

Acknowledgments

We’d like to take a moment to thank the resources and tools that helped us bring this Dungeon Crawl game to life:

• JavaFX – For providing a rich set of tools for building the game's graphical user interface.
• Maven – For simplifying project management, dependencies, and build processes.
• IntelliJ IDEA – For being the powerful IDE that made coding and debugging more efficient.
• Shields.io – For generating beautiful badges used in the README
• GitHub Pages – For hosting and sharing the game with the world

(back to top)