Dunger

A 3D Unity Package for Procedrual Dungeon Generation
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Dunger is an open-source project developed in Unity that specializes in generating random dungeons for games and applications. It offers a straightforward and efficient way to create dynamic and ever-changing dungeon layouts for your Unity-based projects.

Key Features of Dunger:

• Procedural Dungeon Generation: Dunger streamlines the process of generating dungeons with just a few clicks. It uses procedural algorithms to create unique layouts, ensuring that players never experience the same dungeon twice.

• Unity Integration: Built exclusively for Unity, Dunger seamlessly integrates into your Unity projects. You can easily incorporate it into your game development workflow and start generating dungeons in no time.

• Configurable Parameters: Customize the dungeons to fit your specific needs. Adjust parameters like dungeon size, complexity, and room distribution to achieve the desired level of challenge and variety.

• User-Friendly Interface: Dunger provides an intuitive interface that makes it accessible to both seasoned developers and newcomers. You don't need to be a coding expert to create captivating dungeons.

• Documentation and Support: Dunger comes with comprehensive documentation and support resources to help you get started and troubleshoot any issues you might encounter.

Why Choose Dunger:

Dunger simplifies the process of adding randomized dungeons to your Unity games or applications. Whether you're developing a roguelike adventure, a dungeon crawler, or any game that benefits from procedural level design, Dunger can save you time and effort while enhancing the player experience.

With Dunger, you can harness the power of procedural generation in Unity to keep your players engaged with fresh and unpredictable dungeons, making your project stand out in the world of game development.

Get started with Dunger in Unity today and bring dynamic dungeon exploration to your game world!

↑ Back to top

Built With

Dunger is powered by the Unity game engine, harnessing its versatile capabilities for seamless integration and exceptional performance. The project leverages Unity's robust tools and resources to provide a user-friendly environment for generating random dungeons. With Dunger, you can take advantage of Unity's powerful features to create dynamic and engaging game worlds filled with procedurally generated dungeons.

↑ Back to top

Getting Started

Prerequisites

Before installing Dunger, ensure that you have the following prerequisites in place:

• Unity: Dunger is specifically designed for the Unity game engine. Make sure you have Unity installed on your development machine. You can download Unity from the official Unity website.

• GitHub Access: If you plan to clone Dunger from GitHub, you'll need a GitHub account and a Git client installed on your machine for version control.

• Existing Unity Project: If you're integrating Dunger into an existing Unity project, ensure that your project is set up and compatible with the Unity version specified in Dunger's documentation.

Having these prerequisites in order will help you smoothly install and work with Dunger in your Unity environment.

Installation

Dunger offers a hassle-free installation process, providing two convenient options:

Cloning from GitHub:

To start a new project with Dunger, simply clone the Dunger repository from GitHub to your local machine. You can then open the project directly in Unity, making it easy to get started with dungeon generation right away.

1. Clone the repo

   git clone https://github.com/coderloff/dunger

2. Open the cloned project using Unity Hub

Importing as a Unity Package:

If you already have an existing Unity project and want to integrate Dunger, you can import it as a Unity package. This allows you to seamlessly add Dunger's dungeon generation capabilities to your ongoing project, enhancing its gameplay with dynamic dungeons.

1. Download unitypackage by clicking here

2. Open your Unity project

3. Double-click on the downloaded package

4. Click install in Unity

↑ Back to top

Usage

Using Dunger to generate random dungeons in your Unity project is a straightforward process. Here's a quick guide:

1. New Project Setup: If you're starting a new project, clone Dunger from GitHub and open it in Unity. Dunger will be ready to use, and you can begin customizing and generating dungeons right away.

2. Existing Project Integration: If you have an existing Unity project, import Dunger as a Unity package. Once integrated, you can access Dunger's functionality through Unity's user-friendly interface.

3. Customization: Customize your dungeons by adjusting parameters such as size, complexity, and room distribution to achieve the desired level of challenge and variety.

4. Script Integration: For advanced users, Dunger offers script-based integration, allowing you to control dungeon generation programmatically. Use this option to create unique and dynamic gameplay experiences.

↑ Back to top

Contributing

We welcome contributions from the community to help Dunger thrive. Here's how you can get involved:

1. Filing Issues: If you encounter bugs or have suggestions for improvements, please open an issue on our GitHub repository. Be sure to provide details and context to help us understand the issue.

2. Pull Requests: We appreciate pull requests for bug fixes, feature enhancements, or new additions. Make sure your contributions align with our project's goals and coding standards.

3. Documentation: Improving our documentation is a valuable way to contribute. If you find areas that need clarification or want to add examples, your help is greatly appreciated.

4. Community Support: Join discussions, answer questions, and share your knowledge on our community forums. Your expertise can be a valuable resource for fellow Dunger users.

5. Spread the Word: Help us grow the Dunger community by sharing your experiences with others. Tweet about your projects, write blog posts, or create tutorials featuring Dunger.

↑ Back to top

License

Distributed under the MIT License. See LICENSE.txt for more information.

↑ Back to top

Contact

Huseyn Ismayilov - @coderloff - [email protected]

Project Link: https://github.com/coderloff/dunger

↑ Back to top

Acknowledgments

Dunger wouldn't be possible without the support, contributions, and inspiration from the following individuals and projects:

• Sunny Valley Studio: Thanks a lot to Peter for his great support for the project.

• Our Community: We extend our gratitude to the Dunger community for their feedback, enthusiasm, and collaboration in shaping the project.

• Open Source Contributors: Many individuals have dedicated their time and expertise to improve Dunger. Your contributions are invaluable.

• Unity: We thank the Unity team for providing the platform that makes Dunger possible and for supporting the developer community.

• Our Users: Last but not least, a big thank you to all Dunger users. Your creativity and innovation using our tool drive us to keep improving.

↑ Back to top