DungeonEscape

Escape Room Prototype built in Unreal Engine 5 using C++, featuring interactive doors, key items, and pressure plate mechanics.

Table of Contents

• About
• Features
• Getting Started
• Gameplay
• Installation
• Contributing
• License

---

About

DungeonEscape is an Escape Room prototype focused on gameplay mechanics and interactivity, developed as a study project in Unreal Engine and C++ programming. This project explores the creation of simple puzzles, doors that can be unlocked with specific items, and platforms triggered by pressure plates.

---

Features

• 🔑 Doors with lock/unlock mechanics using key items.
• 🟩 Pressure plate interactions for puzzles.
• 🏗️ Modular C++ architecture for scalable gameplay.
• 🎮 Prototype of playable levels with basic puzzle logic.

---

Gameplay

The player must explore the dungeon, collect items, activate pressure plates, and unlock doors to progress. Each puzzle requires logical thinking and environmental exploration.

Current Mechanics:

• Doors that only open with specific key items.
• Pressure plates that trigger actions in the environment.
• Collectible keys for unlocking locked areas.

---

Getting Started

Prerequisites

• Unreal Engine 5
• Visual Studio 2022 (or superior) with support to C++
• Git LFS (Large File Storage)

Clone Repository

git clone https://github.com/RonaldFrota-Dev/DungeonEscape.git
cd DungeonEscape

Open Project

• Open the DungeonEscape.uproject file in Unreal Engine 5.
• Compile the project in Visual Studio to ensure all C++ files are up to date.

---

Installation

1. Make sure you have Unreal Engine 5 installed.
2. Clone this repository.
3. Open DungeonEscape.uproject with Unreal Engine.
4. Compile the project using Visual Studio.
5. Run the prototype's main level (MainLevel) to test.

---

Contributing

Contributions are welcome! To improve the project:

1. Fork this repository.
2. Create a branch for your feature (git checkout -b feature/FeatureName).
3. Commit your changes (git commit -m 'feat: describe the feature').
4. Push to your branch (git push origin feature/FeatureName).
5. Open a Pull Request.

---

License

This project is licensed under the BSD 3-Clause License. See the LICENSE file for more details.

---